Files

T

Zimin A.N. bcfb07f547 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.

2026-05-07 23:27:03 +03:00

3.2 KiB

Raw Permalink Blame History

Ordinis Integrator Guide (Diplodoc / YFM)

Consumer-facing документация Ordinis НСИ ЦУОД. Build через Diplodoc (open-source documentation platform от Yandex), source — YFM (Yandex Flavored Markdown).

Scope: только то, что нужно интеграторам (Альтум team, BI, third-party consumers). Operator runbooks, архитектурные deep-dives и project state — во внутренней документации в ../docs-internal/, не в Diplodoc build.

Структура

docs/
├── package.json           # @diplodoc/cli + build scripts
├── .yfm                   # Diplodoc config
├── toc.yaml               # Содержание / sidebar
├── index.md               # Главная (integrator-focused tabs)
└── integration/
    ├── api/               # 11 глав про API integration
    │   ├── index.md
    │   ├── auth.md
    │   ├── read-endpoints.md
    │   ├── events.md
    │   ├── webhooks.md
    │   ├── bitemporal.md
    │   ├── x-references.md
    │   ├── caching.md
    │   ├── errors.md
    │   ├── best-practices.md
    │   └── bundle-cuod.md
    └── altum-imaging-order.md

Внутренние материалы (НЕ в Diplodoc build):

docs-internal/
├── ops/      # Operator runbook (on-call)
├── status/   # Project state snapshots
└── tech/     # Legacy technical pages

Сборка

Требуется Node 18+.

cd docs
pnpm install
pnpm build           # → ./_dist (HTML)
pnpm serve           # → http://localhost:8088
pnpm dev             # build + serve одной командой

Build output (_dist/) — статический HTML, deployable в:

GitLab Pages
S3 / object storage
nginx/ingress на k8s cluster

Editorial guidelines

Этот set документации — public contract для интеграторов:

Не leak'аем internal architecture — никаких internal alert names, service paths, internal infrastructure URLs.
API contract стабилен — изменения требуют semver bump + announcement.
Consumer-side examples для каждой концепции (Python, Node, либо Spring).
Версионирование через bundle / API major.

Для operator-side / dev-side материалов — docs-internal/ либо design docs в ~/.gstack/projects/claude/.

YFM extensions используются

{% list tabs %} — табы для switching между audiences
{% note info|warning|tip %} — выделенные блоки
mermaid code blocks — диаграммы (graph LR, gantt)
toc.yaml cross-links — sidebar navigation

Roadmap

Базовая структура integration guide (11 страниц)
CI job build-docs в .gitlab-ci.yml
GitLab Pages / k8s ingress deployment
Search plugin
EN translation (через langs: в .yfm)
Includes для shared snippets (auth examples, error tables)
Versioning — separate doc trees per API major version

3.2 KiB Raw Permalink Blame History