Zimin A.N.
d5268b9395
Новая документация-as-code на платформе Diplodoc (Yandex open-source) с YFM (Yandex Flavored Markdown). Build → static HTML, deployable куда угодно. Что добавлено: - package.json + .yfm + toc.yaml — Diplodoc setup, навигация для sidebar - index.md — главная страница с tabs для разных audiences - README.md — инструкция для contributors Раздел integration/api/ — 11 страниц про интеграцию consumers: - index — обзор + глоссарий - auth — Keycloak service accounts, scope mapping - read-endpoints — GET /dictionaries, list/by-key, spatial filters - events — Kafka outbox топики, partition keys, idempotency, DLQ - webhooks — HMAC, SSRF guard, retry policy, test ping endpoint - bitemporal — validFrom/validTo + history, future-dated entries, bulk close/export - x-references — FK syntax, validation errors, scope hiding, orphan scanner, v2 cascade preview - caching — TTL / push / snapshot strategies, hybrid pattern - errors — full error code reference (validation/auth/conflict/server), retry strategy - best-practices — 33 numbered rules для consumers - bundle-cuod — все 40 справочников с FK графом и сценариями Обновлены: - ops/README.md — link на новую integration/api/, убран inline <br> - ops/slo.md — broken cross-repo links заменены на text references Build: cd docs && pnpm install && pnpm build → ./_dist (20 HTML files, 7.1M) pnpm serve # → http://localhost:8088 CI deploy job для GitLab Pages — в roadmap (см. docs/README.md). Существующий tech/api-integration.md оставлен в toc как legacy (содержимое мигрировано + расширено в integration/api/).
19 lines
575 B
JSON
19 lines
575 B
JSON
{
|
|
"name": "ordinis-docs",
|
|
"version": "1.0.0",
|
|
"private": true,
|
|
"description": "Ordinis НСИ ЦУОД ОДХ — техническая документация (Diplodoc / YFM)",
|
|
"scripts": {
|
|
"prebuild": "rm -rf ./_dist",
|
|
"build": "yfm build -i . -o ./_dist --output-format html",
|
|
"build:md": "yfm build -i . -o ./_dist --output-format md",
|
|
"serve": "npx serve ./_dist -p 8088",
|
|
"dev": "pnpm build && pnpm serve",
|
|
"clean": "rm -rf ./_dist"
|
|
},
|
|
"devDependencies": {
|
|
"@diplodoc/cli": "^4.50.0"
|
|
},
|
|
"packageManager": "pnpm@9.0.0"
|
|
}
|