Версионирование пользовательской документации¶
В шапке сайта отображается версия документации — период, на который актуальны инструкции. Это не номер сборки BMS, а метка релиза справки.
Где задаётся¶
Единый файл: doc-version.yml.
| Поле | Пример | Назначение |
|---|---|---|
id |
2026.09 |
Короткий идентификатор в UI и footer |
label |
Сентябрь 2026 |
Человекочитаемое название |
updated |
4 сентября 2026 |
Дата последнего обновления страниц |
history |
список | Пункты селектора в шапке → якоря на Истории релизов |
Когда обновлять¶
После публикации заметного блока в whats-new/, новых скриншотов или правок инструкций по ролям:
- Обновите
id/label/updatedвdoc-version.yml. - Добавьте новый пункт в
history(предыдущий снимитеcurrent: true). - Допишите раздел в
releases.mdс якорем{#…}— тот жеanchor, что вhistory. - Прогоните
mkdocs build --strict.
Селектор в UI¶
В шапке (desktop) — выпадающий список «Версия док.». Он ведёт на историю релизов, а не на архив старых копий всех страниц.
Полный архив версий сайта (как у библиотек через mike) пока не развёрнут: для этого нужен отдельный пайплайн публикации нескольких сборок.
Связь с приложением¶
В BMS в меню показывается версия приложения и среда DEV/PROD — это другой счётчик (см. Настройки). Версия документации может совпадать по месяцу, но обновляется независимо при правках справки.