Документация
Что задокументировано, а что ещё нет
Публичного портала документации сегодня нет. Сама документация существует — около 200 страниц — но лежит в приватном репозитории, поставляется вместе с установкой и пока не имеет отрендеренного версионированного публичного сайта. Вместо ссылки на несуществующий портал — честное состояние каждой её части.
| Пункт | Статус | Что это значит сегодня |
|---|---|---|
| Руководства по развёртыванию и эксплуатации | есть | Написаны и полны. Поставляются с установкой; на публичном сайте их нет. |
| Справочник по архитектуре | есть | Написан. Часть внутреннего устройства рантайма пока не описана. |
| Ограничения продукта и известные пробелы | есть | Написаны прямо. Лучший единый источник о том, что ещё не работает. |
| Справочник HTTP API | есть | Справочник генерируется из OpenAPI-документа хаба при каждом релизе и несёт его версию. |
| Руководства по air-gap-установке и обновлению | опционально | Написаны и нужны, только если вы выбираете air-gap-развёртывание. Сегодня они рассчитаны на релиз-инженеров, а не на ваших операторов. |
| Руководство по self-host для клиентов | запланировано | Не написано. Инструменты установки работают и протестированы; руководства, по которому мог бы пройти инженер вне Caldyr, пока нет. |
| Отрендеренный версионированный публичный портал документации | запланировано | Не построен. Нет генератора, нет сборки, нет домена. Эта страница — заглушка, пока портала нет. |
| Документация на русском, испанском, эстонском и финском | в работе | Переведённые страницы есть, но отстают от английских и не перепроверялись после консолидации английской версии. |
| Записи архитектурных решений | запланировано | Их нет. Решения восстанавливаются из истории коммитов, а это не одно и то же. |
| Версионированный документ по безопасности | запланировано | Не написан. Страница безопасности — это обзор, а не whitepaper, и так и подписана намеренно: датированного версионированного документа для скачивания нет. |
| Справочник API, генерируемый из машиночитаемой схемы | есть | Готово. Хаб отдаёт свой OpenAPI-документ по адресу /api/openapi.json вместе с версией хаба, а страница справочника строится из него при каждом релизе. |
| Руководство по развёртыванию в Kubernetes и Helm | исследуем | Изучаем. Ни чарта, ни манифестов сегодня нет; поддерживаемый вариант — Docker Compose на хосте. |
- Справочник API на хабе (нужен вход)
- OpenAPI-документ (открытый, JSON)
- Документация пользователя внутри приложения, на хабе (нужен вход)
Если для оценки Caldyr вам нужен любой из ненаписанных пунктов, попросите — мы пришлём то, что есть, вместо того чтобы говорить, что это опубликовано.