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.
37 lines
1.2 KiB
YAML
37 lines
1.2 KiB
YAML
title: Ordinis НСИ ЦУОД ОДХ — Integrator Guide
|
|
href: index.md
|
|
|
|
items:
|
|
- name: Введение
|
|
href: index.md
|
|
|
|
- name: Интеграция по API
|
|
items:
|
|
- name: Обзор
|
|
href: integration/api/index.md
|
|
- name: Авторизация
|
|
href: integration/api/auth.md
|
|
- name: Read-side endpoints
|
|
href: integration/api/read-endpoints.md
|
|
- name: События (Kafka outbox)
|
|
href: integration/api/events.md
|
|
- name: Webhooks
|
|
href: integration/api/webhooks.md
|
|
- name: Bitemporal модель
|
|
href: integration/api/bitemporal.md
|
|
- name: Cross-references (FK)
|
|
href: integration/api/x-references.md
|
|
- name: Кэширование
|
|
href: integration/api/caching.md
|
|
- name: Ошибки и rate limits
|
|
href: integration/api/errors.md
|
|
- name: Best practices
|
|
href: integration/api/best-practices.md
|
|
- name: Bundle справочников cuod
|
|
href: integration/api/bundle-cuod.md
|
|
|
|
- name: Прикладные сценарии
|
|
items:
|
|
- name: Альтум — заказ съёмки
|
|
href: integration/altum-imaging-order.md
|