docs: split integrator guide (Diplodoc) vs internal docs + add build-docs CI
Чёткое разделение audiences:
- docs/ — consumer-facing only, Diplodoc-built. Public contract для
интеграторов (Альтум, BI, third-party).
- docs-internal/ — operator runbooks, status snapshots, legacy tech pages.
НЕ в Diplodoc build, НЕ публикуются.
Изменения:
- Move docs/{ops,status,tech} → docs-internal/{ops,status,tech}
- docs/toc.yaml: убраны секции Operations, Архитектура (legacy), Status
- docs/index.md: убран tab "оператор / on-call", focus на integrators
- docs/README.md: rewritten — scope только integrator guide, editorial
guidelines (no leak internal architecture, stable API contract)
- .yfm: убран явный ignore status/* (теперь не нужно — папка переехала)
- docs-internal/README.md: index для внутренней документации с rationale
разделения
Scrubbing implementation details из Diplodoc страниц:
- events.md: убраны Strimzi/cluster.142 references, OutboxPoller детали,
internal alert names (OrdinisOutboxLagHigh, OrdinisOutboxDLQNonEmpty),
metric names (nsi_outbox_*). Заменены на consumer-observable contract.
- webhooks.md: убраны metric names (nsi_webhook_ssrf_rejected_total),
alert table (OrdinisWebhookHighFailureRate и т.д.). Retry policy
переписана на user-side perspective.
- errors.md: убран alert name OrdinisReadApiErrorBudgetBurnFast, Tempo
endpoint URL, internal connection details.
- x-references.md: OrphanReferenceScanner → general "Ordinis периодически
детектирует". Убраны metric/alert names. Cascade roadmap без link на
internal design doc.
- auth.md: убран file path ScopeContext.java.
- bundle-cuod.md: убран Maven module path.
- caching.md: cascade design link заменён на text reference.
CI:
- .gitlab-ci.yml: новый job build-docs (stage: build) — Node 20 alpine,
pnpm install --frozen-lockfile + pnpm build, artifact docs/_dist на
неделю. Triggers: auto на docs/**, либо manual web. Готов к follow-up
pages-deploy job когда host решён.
- Новый pattern .docs-changes для rules.
Build verified clean: 13 HTML pages, 6.9M, no broken links/refs.
This commit is contained in:
+11
-14
@@ -1,6 +1,8 @@
|
||||
# Ordinis НСИ ЦУОД ОДХ
|
||||
# Ordinis НСИ ЦУОД ОДХ — Integrator Guide
|
||||
|
||||
Документация для разработчиков, интеграторов и операторов.
|
||||
Документация для команд, интегрирующих свои сервисы с Ordinis НСИ ЦУОД.
|
||||
Сюда не входят operator runbooks и архитектурные deep-dives — те материалы
|
||||
во внутренней документации проекта.
|
||||
|
||||
**Anchor v1 — production LIVE на cluster.142** (с 2026-05-07).
|
||||
Альтум consumers подключены, blue/green cutover завершён.
|
||||
@@ -26,14 +28,10 @@
|
||||
- [Bundle cuod](integration/api/bundle-cuod.md) — список 40 справочников ЦУОД
|
||||
- [Best practices](integration/api/best-practices.md) — частые ошибки
|
||||
|
||||
- Я — оператор / on-call
|
||||
- Я обрабатываю ошибки
|
||||
|
||||
- [Runbook indexed by symptom](ops/README.md)
|
||||
- [SLO + alert thresholds](ops/slo.md)
|
||||
- [Outbox DLQ](ops/outbox-dlq.md)
|
||||
- [Database migrations](ops/db-migrations.md)
|
||||
- [Vault unseal](ops/vault-unseal.md)
|
||||
- [Kafka restart](ops/kafka-restart.md)
|
||||
- [Ошибки и rate limits](integration/api/errors.md) — error codes, retry strategy
|
||||
- [Лучшие практики](integration/api/best-practices.md) — robust integration
|
||||
|
||||
{% endlist %}
|
||||
|
||||
@@ -41,15 +39,14 @@
|
||||
|
||||
| Среда | URL | Auth | Назначение |
|
||||
|---|---|---|---|
|
||||
| **prod** | `https://ordinis.k8s.264.nstart.cloud/` | JWT обязателен | Альтум real users |
|
||||
| **prod** | `https://ordinis.k8s.264.nstart.cloud/` | JWT обязателен | Real users |
|
||||
| staging | `https://ordinis.k8s.265.nstart.cloud/` | optional (legacy mode) | Dev environment |
|
||||
| local | `http://localhost:8080` | off | docker-compose dev |
|
||||
|
||||
## Поддержка
|
||||
|
||||
- Issues / bug reports: `git.nstart.cloud:2-6/2-6-4/terravault/ordinis`
|
||||
- Эскалация: `zimin.an@nstart.space`
|
||||
- Запросы новых ролей / scope в Keycloak: тот же email.
|
||||
- Запросы новых ролей / scope в Keycloak: `zimin.an@nstart.space`
|
||||
- Bug reports / feature requests: через issue tracker (запросить URL у Ordinis team)
|
||||
|
||||
## Версионирование
|
||||
|
||||
@@ -59,4 +56,4 @@ API стабилизирован под v1 — breaking changes только ч
|
||||
|
||||
Bundle справочников ЦУОД versioned отдельно (`cuod-bundle:1.2.1`). Изменение
|
||||
schemas — minor bump, добавление словарей — minor bump, удаление — major bump
|
||||
(никогда без уведомления consumers через `nsi.dictionary.changed` event).
|
||||
(никогда без уведомления consumers через `record.closed` events).
|
||||
|
||||
Reference in New Issue
Block a user