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:
@@ -54,6 +54,12 @@ default:
|
||||
.frontend-changes: &frontend-changes
|
||||
- "ordinis-admin-ui/**/*"
|
||||
|
||||
# Documentation changes — Diplodoc-built integrator guide.
|
||||
# docs-internal/ исключено явно: оно НЕ build'ится Diplodoc'ом и не должно
|
||||
# триггерить docs job.
|
||||
.docs-changes: &docs-changes
|
||||
- "docs/**/*"
|
||||
|
||||
# ─── TEST ──────────────────────────────────────
|
||||
maven-test:
|
||||
stage: test
|
||||
@@ -112,6 +118,38 @@ maven-package:
|
||||
- ordinis-migrations/src/main/resources/db/changelog/**
|
||||
expire_in: 1 day
|
||||
|
||||
# ─── BUILD: Integrator Guide (Diplodoc) ────────
|
||||
# Build static HTML documentation для consumers через @diplodoc/cli (yfm).
|
||||
# Source — docs/ (Markdown + toc.yaml). Output — docs/_dist/ HTML.
|
||||
#
|
||||
# Triggers:
|
||||
# - auto при изменении docs/**
|
||||
# - manual через web UI (для force-rebuild без code changes)
|
||||
#
|
||||
# Artifact `docs/_dist/` сохраняется неделю — pages-deploy job (TBD,
|
||||
# когда host решён — GitLab Pages либо k8s ingress) подхватит из него.
|
||||
build-docs:
|
||||
stage: build
|
||||
image: repo.nstart.cloud/library/node:20-alpine
|
||||
before_script:
|
||||
- corepack enable
|
||||
- corepack prepare pnpm@9.0.0 --activate
|
||||
script:
|
||||
- cd docs
|
||||
- pnpm install --frozen-lockfile
|
||||
- pnpm build
|
||||
- echo "Built $(find _dist -name '*.html' | wc -l) HTML pages, total size:"
|
||||
- du -sh _dist
|
||||
artifacts:
|
||||
name: "ordinis-docs-$CI_COMMIT_REF_SLUG-$CI_COMMIT_SHORT_SHA"
|
||||
paths:
|
||||
- docs/_dist
|
||||
expire_in: 1 week
|
||||
rules:
|
||||
- changes: *docs-changes
|
||||
- if: '$CI_PIPELINE_SOURCE == "web"'
|
||||
when: manual
|
||||
|
||||
# ─── PUBLISH (Docker images) ───────────────────
|
||||
.docker_base:
|
||||
stage: publish
|
||||
|
||||
Reference in New Issue
Block a user