From ff8b4ac42e3932031426f919d8fa10fcae06279c Mon Sep 17 00:00:00 2001 From: Mihail Koshkin Date: Wed, 10 Jun 2026 21:45:12 +0300 Subject: [PATCH 1/2] fix content-analytics.md --- .yfm | 4 --- ru/guides/content-analytics.md | 54 ++++++++++++++++++++-------------- ru/project/meta.md | 7 +++-- 3 files changed, 37 insertions(+), 28 deletions(-) diff --git a/.yfm b/.yfm index 12ec4b02..3c6f196c 100644 --- a/.yfm +++ b/.yfm @@ -3,7 +3,6 @@ langs: ['ru','en'] vcs: true mtimes: true -authors: true search: provider: local @@ -18,9 +17,6 @@ extensions: - '@diplodoc/transform/lib/plugins/checkbox' - github-vcs -preprocess: - mergeIncludes: true - resources: style: - _assets/style/custom.css diff --git a/ru/guides/content-analytics.md b/ru/guides/content-analytics.md index b3231a93..d7b5c370 100644 --- a/ru/guides/content-analytics.md +++ b/ru/guides/content-analytics.md @@ -38,7 +38,7 @@ 1. Создайте счетчик метрики в соответствии с [инструкцией](https://yandex.ru/support/metrica/general/). 1. В настройках счетчика [включите опцию](https://yandex.ru/support/metrica/publishers/about.html#about) «Контентная аналитика» и укажите тип разметки `OpenGraph`: - + ![](../_images/opengraph.png) 2. Добавьте счётчик в документационный проект, используя [конфигурационный файл `.yfm`](../settings.md#analytics-metrika). @@ -47,22 +47,24 @@ ```yaml analytics: - - id: 44444444 + metrika: + - id: 44444444 ``` ### Добавление метаинформации {#meta-information} В отчетах по контенту данные собираются только по размеченным материалам. Для разметки материала рекомендуется использовать словарь семантической разметки данных [OpenGraph](https://yandex.ru/support/metrica/publishers/open-graph/open-graph.html). -Разметка задаётся в файлах документации с расширением `md`, в блоке [front-matter](*front-matter). +Разметка задаётся в [метаданных](../project/meta.md) файлов документации с расширением `md`. {% note info %} OpenGraph позволяет контролировать представление страниц в поисковых системах и социальных медиа платформах. -Данные OpenGraph должны располагаться в теге `head` вашего документа. +Данные OpenGraph должны располагаться в теге `head` вашего документа. Вы можете задать название, описание, изображение и другие параметры, которые будут отображаться, при публикации вашей ссылки на сайтах в социальных сетях. Подробнее про OpenGraph: + - [The Open Graph protocol](https://ogp.me/) - [Вебмастер. Справка](https://yandex.ru/support/webmaster/open-graph/intro-open-graph.html) @@ -73,7 +75,8 @@ OpenGraph позволяет контролировать представлен #| || **Исходный код в файле** | **Результат в документации** || || -``` + +```yaml --- metadata: - property: 'og:type' @@ -98,8 +101,10 @@ metadata: content: 'Москва' --- ``` + | -``` + +```html @@ -111,6 +116,7 @@ metadata: ``` + || |# @@ -122,15 +128,17 @@ metadata: || **Элемент** | **Комментарий** || || Тип описываемого объекта[*](*parametr) | Метрика поддерживает только разметку объектов типа [article](https://ogp.me/#type_article). Другие объекты, размеченные по стандарту [Open Graph](https://ogp.me/#type_article), не попадут в отчеты Метрики. Тип объекта указывается в свойстве `og:type`. -``` +```html ``` + || || Заголовок[*](*parametr) | Заголовок отображается в отчетах Метрики. Он указывается в свойстве `og:title`. -``` +```html ``` + || || Текст[*](*parametr) | В качестве текста берется содержимое узла, в который вложен описываемый материал. Если разметка находится в теге `head`, текстом будет все содержимое тега `body`. Символы тегов не учитываются. В тексте определяется количество символов — это нужно для расчета объема материала и метрик доскроллов и дочтения. @@ -142,7 +150,7 @@ metadata: || || Автор | Автор указывается с помощью свойства `article:author`. Если авторов несколько, перечислите их в разных метатегах. -``` +```html ``` @@ -150,33 +158,36 @@ metadata: Благодаря этим данным можно посмотреть статистику по отдельным авторам. || || Тематика | В качестве тематик можно указать, например, ключевые слова или хэштеги. Укажите тематики в свойстве `article:tag`. Если тематик несколько, перечислите их в разных метатегах. -``` +```html ``` + || || Даты публикации и изменения | Даты публикации и изменения указываются в свойствах `article:published_time` и `article:modified_time`. Даты записываются в формате [ISO 8601](https://www.iso.org/standard/40874.html). -``` +```html ``` + || || Рубрика | Рубрика — это раздел сайта, посвященный определенной теме. Чтобы указать рубрику материала, используйте свойство `article:section`. -``` +```html ``` + || || URL материала | URL материала должен содержаться в свойстве `og:url`. -``` +```html ``` Иначе значение будет взято из канонической ссылки: -``` +```html ``` @@ -197,6 +208,7 @@ metadata: | Отчет дает краткую статистику по контенту за выбранный день или период. Статистика включает данные о просмотрах и взаимодействии пользователей с материалами документации. В сводке вы можете: + - понять, насколько активна аудитория; - узнать, какие материалы наиболее популярны, и получить краткую сводку по ним; - выяснить, откуда посетители переходят к вашим материалам. @@ -212,8 +224,8 @@ metadata: {% endcut %} | > || -|| Материалы -| +|| Материалы +| Отчет помогает сравнить материалы между собой, отследить динамику просмотров, выделить самые интересные посты (у них будет высокий показатель дочтений) и решить в каком направлении продолжать работу с контентом. Понять насколько читателям интересна информация, кто и какого возраста ищет данные, с каких устройств чаще читают и под какой вариант адаптировать материал. @@ -226,7 +238,7 @@ metadata: {% endcut %} | > || -|| Рубрики +|| Рубрики | Отчет по рубрикам позволяют получить общую статистику и сравнить рубрики между собой. Показатели просмотров и вовлеченности аудитории позволяют определить эффективность рубрики и понять, стоит уделять им внимание или следует отказаться от них. @@ -247,7 +259,7 @@ metadata: {% endcut %} | > || -|| Авторы +|| Авторы | Отчет позволяет получить общую статистику по авторам и сравнить результаты автора с остальной редакцией. Если документацию пишет несколько разных авторов, такие данные помогут определить, какой писатель больше всего привлекает пользователей и продолжить работу с ним. Или понять, чем именно автор привлекает аудиторию и помочь другим авторам привлечь пользователей, поднимая себе трафик. @@ -257,6 +269,7 @@ metadata: || Тематики | Отчет позволяет собрать общую статистику по тематикам, которые отражают содержание статьи. В том числе: + - Узнать, какие тематики интересны читателям, а какие нет. - Посмотреть, кто и как читает материалы по выбранной тематике. @@ -275,7 +288,6 @@ metadata: ### Стандартные отчеты {#standard-reports} - #| || **Отчет** | **Описание** || || Источники переходов на материалы @@ -339,11 +351,9 @@ metadata: Приведённые рекомендации помогут повысить ценность вашей документации и сделать её полезным инструментом для пользователей. -#### Смотрите также +**Смотрите также** - [Отчёты по контенту](https://yandex.ru/support/metrica/publishers/reports/main.html) (документация) - [Проверка передачи данных контентной аналитики](https://yandex.ru/support/metrica/publishers/check-data.html) -[*front-matter]: Секция метаданных, размещенная в начале Markdown-файла, заключенная между тремя дефисами `---` . Она используется для определения ключевой информации о документе, такой как заголовок, автор, дата и различные параметры настройки, которые могут влиять на обработку и отображение содержимого документа. - [*parametr]: Обязательный элемент. diff --git a/ru/project/meta.md b/ru/project/meta.md index 7d83f00e..55614edb 100644 --- a/ru/project/meta.md +++ b/ru/project/meta.md @@ -1,10 +1,11 @@ -# Метаданные +# Метаданные статьи -Метаданные — элементы разметки, которые не отображаются в собранном файле. Они используются, чтобы хранить в исходном тексте информацию для SEO или авторов документа. +Метаданные — элементы разметки, которые не отображаются в собранном файле. Они используются для хранения в исходном тексте настроек конкретной статьи, информации для SEO или авторов документа. Метаданные можно добавить в формате YAML в начало файла для настроек отображения страницы. Пример: + ```yaml --- title: Заголовок @@ -57,6 +58,7 @@ interface: toc: false --- ``` + {% endcut %} | `object` @@ -78,6 +80,7 @@ metadata: ``` на основе которых формируется набор тегов: + ```html From 271741898e35df7e913a6701c4b7feae5120987d Mon Sep 17 00:00:00 2001 From: Mihail Koshkin Date: Wed, 10 Jun 2026 21:46:41 +0300 Subject: [PATCH 2/2] hide personal-domain-ya-cloud.md --- ru/toc.yaml | 1 + 1 file changed, 1 insertion(+) diff --git a/ru/toc.yaml b/ru/toc.yaml index f60380d4..233c8f51 100644 --- a/ru/toc.yaml +++ b/ru/toc.yaml @@ -179,6 +179,7 @@ items: href: project/analytics/ym.md - name: Настройка личного домена href: personal-domain-ya-cloud.md + hidden: true - name: Единый источник href: guides/single-source/index.md items: