Документация

Для пользователей платформы “Штурвал” разрабатывается документация, включающая описание:

• функциональных возможностей платформы “Штурвал”;
• возможностей работы в графическом интерфейсе платформы;
• пошаговых инструкций по работе в платформе и траблшутингу;
• релизных изменений.

Виды документации:

• публичная;
• закрытая;
• релизная.

Версионирование публичной и релизной документации устанавливается в соответствии с минорными версиями релизов. Закрытая не версионируется.

Публичная #

Открытая для просмотра документация в виде статичного сайта в сети “Интернет”. Доступна по адресу https://docs.shturval.tech. При переходе на сайт открывается документация версии, соответствующей последнему выпущенному релизу платформы. Вы можете переключаться на документацию и предыдущих релизов. Для этого щелкните в правом верхнем углу на “Версия x.x” и выберите необходимую версию. Публичная документация может обновляться ежедневно. Из публичного доступа исключаются версии документации неподдерживаемых релизов.

В публичной документации доступны разделы: • О платформе: общая информация об архитектуре, глоссарий; • Пошаговые инструкции: прикладные инструкции; • Платформа: системные требования, инсталляция, межсетевые экраны, инфраструктура и права доступа – то, что архитектурно касается платформы в целом; • Кластеры – все ресурсы, которые расположены в кластерах платформы, а также информация о создании кластеров на развернутой платформе • Неймспейсы – все ресурсы, которые расположены в скоупе неймспейса; • Безопасность – функции безопасности в платформе; • Описание API – как включить Swagger и примеры использования API; • Сервисы – описание работы с сервисами и репозиториями в платформе; • Релизы – release notes;

Строка поиска работает по всем страницам документации.

Релизная #

Поставляется в составе платформы. Со страниц графического интерфейса платформы может быть осуществлен переход к релизной документации, соответствующей версии платформы. Релизная документация обеспечивает минимизацию времени поиска релевантной информации путем перехода на требуемую страницу. Обновляется одновременно с выпуском минорных и патч версий платформы.

Закрытая #

Содержит необходимые инструкции и технические детали, адаптированные под задачи заказчиков. Разрабатывается и актуализируется с учетом потребностей заказчика. Распространяется посредством базы знаний на Service Desk и может обновляться ежедневно.