Работа с отчетом сборки/валидации документации#

Отчет может иметь один из следующих статусов:

  • error Красный — Есть ошибки
    В документации обнаружены критические ошибки, которые необходимо исправить. При наличии ошибок (error) сборка завершается при обнаружении первой ошибки. Ее необходимо исправить, а затем запустить сборку заново.

  • warning Желтый — Есть замечания
    В документации обнаружены ошибки, которые следует исправить для публикации в release, но они некритичны для отображения документации в draft. При наличии только замечаний (warning) сборка проходит до конца.

  • ok Зеленый — ОК
    Ошибок и замечаний нет, сборка валидна.

Отчет содержит активные ссылки на место обнаружения ошибки в репозитории с номером строки в файле.

Правила валидации хранятся в репозитории content-validation.

Примечание

Если валидация комплекта документации выполняется больше 10 минут, рекомендуется в большие файлы комплекта документов, которые не предназначены для публикации, добавить <!-- vale off -->. Также это можно делать в накопительных длинных документах в то место документа, с которого нужно остановить валидацию (не проверять контент, относящийся к старым версиям).

Просмотр всех отчетов сборки#

Дополнительно можно посмотреть все созданные отчеты сборки (все комбинации <stage>-<package>-<audience>):

  1. Нажмите на корневой узел графа.

  2. Откройте вкладку INPUTS/OUTPUTS.

  3. Нажмите на иконку артефакта reports внизу страницы:

    Просмотр всех созданных отчетов сборки

  4. Нажмите на страницу отчета. Ссылка на собранный сайт будет внутри отчета.