Эти коды выдаёт docara qa report.
Код находки стоит в отчёте quality-report.json у каждой страницы и в
списке «Fix first». Находки не останавливают сборку: «warning» значит, что
читатель скорее всего споткнётся, «advice» — что на страницу стоит
взглянуть. Каждая невыполненная проверка снимает с группы страницы 25
баллов (warning) или 10 баллов (advice).
Полнота
Код
Уровень
Причина и что сделать
QUALITY_PROFILE_PART_MISSING
warning
Странице не хватает части, которой требует её профиль, например нумерованных шагов. Если профиль угадан, уровень — advice. Что сделать: Добавьте часть или задайте подходящий профиль. Подробности покажет docara validate page <адрес>.
QUALITY_DESCRIPTION_MISSING
warning
Нет description ни во front matter, ни в файле <page>.page.json. Описание, которое сборка берёт из первого абзаца, не считается. Что сделать: Напишите одно предложение о том, что читатель получит на странице.
QUALITY_DESCRIPTION_LENGTH
advice
Описание короче 40 или длиннее 200 символов. Что сделать: Уложите описание в одно предложение нужной длины.
QUALITY_PAGE_STUB
warning
На странице меньше 80 слов вне блоков кода. Что сделать: Допишите страницу, объедините её с соседней или пометьте draft: true.
QUALITY_PLACEHOLDER_LEFT
warning
На странице остался текст-подсказка из шаблона docara scaffold page. Текст внутри блоков кода не считается. Что сделать: Замените подсказку настоящим текстом.
QUALITY_DRAFT_LINKED
warning
Страница ссылается на черновик с draft: true, которого нет на сайте. Что сделать: Опубликуйте черновик или уберите ссылку.
Актуальность
Код
Уровень
Причина и что сделать
QUALITY_SOURCE_CHANGED
warning
Отслеживаемый источник страницы изменился после последней сверки. Работает только с отслеживанием документации. Что сделать: Обновите страницу и подтвердите сверку через docara documentation plan и apply.
Находимость
Код
Уровень
Причина и что сделать
QUALITY_NOT_IN_NAVIGATION
advice
Ни одно меню сайта не ведёт на страницу. Что сделать: Покажите страницу в меню или дайте ссылку со страницы раздела.
QUALITY_NOT_IN_SEARCH
advice
Поиск включён, но страницы нет в поисковом индексе. Что сделать: Уберите search.indexed: false или исключите служебную страницу из оценки через quality.exclude.
QUALITY_ORPHAN_PAGE
warning
Ни одна другая страница не ссылается на эту из своего текста. Ссылки из меню не считаются. Главная страница языка не проверяется. Что сделать: Дайте ссылку со страниц, которые читатель открывает раньше.
QUALITY_NO_RELATED_LINKS
advice
В тексте нет ссылок на другие страницы сайта и нет раздела «См. также». Что сделать: Добавьте ссылки в текст или раздел «См. также».
QUALITY_TOPIC_UNCLEAR
advice
У страницы нет меток, а описание (или первый абзац) не повторяет ни одного слова заголовка. Что сделать: Добавьте tags или назовите тему заголовка в описании.
Читаемость
Код
Уровень
Причина и что сделать
QUALITY_SENTENCES_LONG
advice
Предложения в среднем длиннее 20 слов. Код внутри текста считается за одно слово. Что сделать: Разделите длинные предложения: одна мысль — одно предложение.
QUALITY_SENTENCE_TOO_LONG
advice
Есть предложение длиннее 40 слов. Что сделать: Разбейте его на два или три.
QUALITY_PAGE_TOO_LONG
advice
На странице больше 2500 слов вне блоков кода. Что сделать: Разделите страницу по задачам или темам.
QUALITY_NO_SUBHEADINGS
advice
Больше 600 слов и ни одного раздела ##. Что сделать: Добавьте разделы, чтобы страницу можно было просмотреть глазами.
QUALITY_HEADING_TOO_DEEP
advice
Есть заголовки 5-го или 6-го уровня. Что сделать: Обходитесь четырьмя уровнями или разделите страницу.
QUALITY_LATIN_HEAVY
advice
На языке с нелатинской письменностью латиницей написано больше 25% слов вне кода. Что сделать: Переведите или объясните термины; имена файлов, полей и команд оформите как код.
QUALITY_TERM_NOT_IN_GLOSSARY
advice
Три и больше английских термина встречаются в тексте хотя бы дважды, но их нет в словаре сайта. Проверка работает, если на сайте есть словарь. Что сделать: Объясните термины в словаре или замените их понятными словами.
Доступность
Код
Уровень
Причина и что сделать
QUALITY_IMAGE_ALT_MISSING
warning
У картинки нет замещающего текста. Что сделать: Напишите, что изображено: .
QUALITY_LINK_TEXT_GENERIC
warning
Текст ссылки не говорит, куда она ведёт: «здесь», «тут», «подробнее», click here — или его нет совсем. Что сделать: Назовите цель ссылки: [Публикация сайта](/ru/build/publish/).
QUALITY_HEADING_ORDER
warning
Страница не начинается с одного заголовка # или в ней несколько таких заголовков. Что сделать: Оставьте один заголовок # в начале страницы.
QUALITY_HEADING_LEVEL_SKIPPED
warning
Заголовок пропускает уровень, например после ## идёт ####. Что сделать: Спускайтесь на один уровень за раз.
QUALITY_TABLE_HEADER_MISSING
warning
У таблицы нет строки заголовков. Что сделать: Добавьте первую строку с названиями столбцов.
QUALITY_LANG_MISSING
warning
У собранной страницы нет атрибута lang или он не совпадает с языком страницы. Что сделать: Проверьте язык страницы в docara.json: сборка пишет lang из него.
Ссылки
Код
Уровень
Причина и что сделать
QUALITY_LINK_BROKEN
warning
Ссылка в тексте ведёт на страницу или файл, которых нет в сборке, или за пределы сайта. Что сделать: Исправьте адрес или верните страницу.
QUALITY_ANCHOR_MISSING
warning
Ссылка ведёт на якорь #…, которого нет на странице назначения. Что сделать: Сошлитесь на существующий заголовок. Переименованный заголовок меняет свой якорь.
Ошибки самой команды
Код
Причина и что сделать
QUALITY_BUILD_MISSING
Нет полной сборки для проверки: в build_<env>/_docara/ нет page-metadata.json. Что сделать: Выполните docara build <env> без --page и повторите отчёт с тем же --env.
QUALITY_ENVIRONMENT_INVALID
Имя окружения в --env содержит недопустимые символы. Что сделать: Используйте буквы, цифры, _ и -, как в docara build.
QUALITY_MIN_SCORE_INVALID
--min-score — не целое число от 0 до 100. Что сделать: Укажите число, например --min-score=80.
QUALITY_TOP_INVALID
--top — не целое число. Что сделать: Укажите число, например --top=15.
QUALITY_OUTPUT_UNSAFE
Каталог build_<env>.docara или файл отчёта — символическая ссылка или не каталог, либо запись не удалась. Что сделать: Удалите ссылку и запустите сборку заново.
QUALITY_SCORE_BELOW_MINIMUM
Строгий режим: оценка ниже --min-score или quality.min_score. Команда завершается с кодом 1. Что сделать: Исправьте пункты «Fix first» или снизьте границу.
