Zimin A.N.
bcfb07f547
Чёткое разделение 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.
58 lines
2.8 KiB
Markdown
58 lines
2.8 KiB
Markdown
# Ordinis — internal documentation
|
||
|
||
Технические детали реализации, архитектура, operator runbooks и project state
|
||
snapshots. **НЕ deployment'ится** через Diplodoc — это внутренние артефакты для
|
||
команды Ordinis (не для consumers).
|
||
|
||
Consumer-facing документация находится в [`docs/`](../docs/) и build'ится через
|
||
Diplodoc → static HTML.
|
||
|
||
## Что внутри
|
||
|
||
```
|
||
docs-internal/
|
||
├── ops/ # Operator runbook (on-call, incidents, recovery)
|
||
│ ├── README.md
|
||
│ ├── slo.md
|
||
│ ├── outbox-dlq.md
|
||
│ ├── db-migrations.md
|
||
│ ├── vault-unseal.md
|
||
│ └── kafka-restart.md
|
||
├── status/ # Project state snapshots (по дням сессий)
|
||
│ └── *-state.md
|
||
└── tech/ # Архитектурные deep-dives, legacy документы
|
||
└── api-integration.md # legacy (мигрирован в docs/integration/api/)
|
||
```
|
||
|
||
## Когда что использовать
|
||
|
||
| Situation | Read |
|
||
|---|---|
|
||
| Я — consumer интегрирующий свой backend | [docs/integration/api/](../docs/integration/api/index.md) (Diplodoc) |
|
||
| Я — on-call инженер с alert | [ops/README.md](ops/README.md) |
|
||
| Я — Ordinis dev планирующий feature | [status/](status/) latest snapshot + design docs в `~/.gstack/projects/claude/` |
|
||
| Я — новый разработчик в команде | Сначала consumer docs, потом ops/, потом status/ для context |
|
||
|
||
## Архитектурные artifacts (вне репозитория)
|
||
|
||
Design docs / план-плансы хранятся в `~/.gstack/projects/claude/`:
|
||
- `zimin-main-design-production-prep-20260507-123032.md` — prod stand-up plan
|
||
- `zimin-main-design-approval-workflow-v2-20260507-121632.md` — approval flow v2 (DEFERRED)
|
||
- `zimin-main-design-dict-relationships-v2-20260507-230237.md` — lineage + cascade rules
|
||
- `checkpoints/*.md` — session state checkpoints для context-restore
|
||
|
||
## Rationale разделения
|
||
|
||
Diplodoc документация — **public contract** для интеграторов:
|
||
- Может быть опубликована на public Pages
|
||
- Не должна leak'ать internal architecture (security)
|
||
- Должна быть стабильной (consumer'ы строят на ней свои интеграции)
|
||
|
||
`docs-internal/` — **operational state**:
|
||
- Runbooks меняются часто (incidents, lessons learned)
|
||
- Status snapshots — historical record для команды
|
||
- Tech deep-dives — для разработчиков, не consumers
|
||
|
||
Это разделение делает Diplodoc более фокусированным и менее шумным
|
||
для consumers.
|