Как организована эта документация
Эта документация организована по фреймворку Diátaxis. Diátaxis замечает, что техническая документация служит четырём различным потребностям и что их смешивание делает документацию хуже для всех. Поэтому верх боковой панели — это четыре режима, а не список функций продукта:
| Режим | Ориентация | Отвечает на | Когда вы… |
|---|---|---|---|
| Учебники | обучение | «Проведи меня от нуля до рабочего результата.» | новичок и хотите учиться на практике |
| Практические руководства | задача | «Как мне выполнить эту конкретную вещь?» | работаете и нуждаетесь в рецепте |
| Справочник | информация | «Что именно представляют собой API, события, модули, флаги?» | строите на основе и нуждаетесь в точности |
| Объяснение | понимание | «Почему это построено именно так?» | оцениваете и хотите рассуждений |
Быстрая карта того, где что находится:
- Учебники — пути обучения: от нуля до read/write-графа доступа и начало работы по реальному сценарию — один узел, Docker Compose, Kubernetes, air-gapped.
- Практические руководства — установка и эксплуатация (self-host, резервное копирование и восстановление, мониторинг, устранение неполадок), руководства по коннекторам (pgAudit, CloudTrail, eBPF, Claude Code, MCP, идентичность) и кулинарная книга рецептов управления (deny-closed-политики, бюджеты, согласования, разбор дрейфа, аварийный выключатель, push в SIEM).
- Справочник — REST API (отрисованный из собственного контракта продукта OpenAPI 3.1), политика стабильности API, шина событий (контракт AsyncAPI 3.0), каталог модулей, CLI и конфигурация.
- Объяснение — архитектура, модель безопасности и модель угроз, open-core-лицензирование.
Соглашения
Заголовок раздела «Соглашения»- Поиск локальный и на стороне клиента (Pagefind). Он работает полностью в вашем браузере; ничего не отправляется во внешний поисковый сервис — что согласуется с self-hosted-дизайном продукта, в котором вы решаете, что выходит за ваш периметр.
- Версионирование. Документация версионируется: когда выходит новая версия продукта, документация для предыдущей сохраняется. Переключатель версий находится в верхней панели.
- Честность об ограничениях. Там, где возможность находится на стадии проектирования, ожидается после v1 или просто ещё не построена, документация прямо так и говорит. См. Честность и ограничения. Команды учебников и практических руководств предназначены для запуска как написано.
- Языки. Каноническая документация на английском; доступны переводы на испанский, упрощённый китайский, русский, японский, немецкий и французский (машинный перевод, английский — авторитетная версия, с откатом к английскому для ещё не переведённых страниц).