Why
The zero-downtime deployment docs (docs/guides/zero-downtime/) — and the developer docs generally — should be discoverable in the Backstage portal where developers already work, via TechDocs, not only in the git repo.
Scope (deferred — a bigger effort, tracked separately)
This is infra wiring, not doc-writing, hence its own ticket:
- Add a TechDocs
mkdocs.yml (and docs/ nav) for the relevant doc sets.
- Enable the Backstage TechDocs plugin + a generator/build pipeline (local vs CI build; S3 vs in-cluster storage).
- Register catalog entities with
backstage.io/techdocs-ref annotations so the right docs attach to the right components.
- Decide which doc trees to publish (start with
docs/guides/, the developer-facing set).
Context
The zero-downtime docs (Phases 1–4) are complete in-repo: developer + platform overviews, tutorial, how-to guides, reference, troubleshooting, architecture, glossary, FAQ, demo walkthrough. TechDocs is the remaining distribution step.
Refs: the backstage-portal house skill; ADR-051 (Backstage portal).
Why
The zero-downtime deployment docs (
docs/guides/zero-downtime/) — and the developer docs generally — should be discoverable in the Backstage portal where developers already work, via TechDocs, not only in the git repo.Scope (deferred — a bigger effort, tracked separately)
This is infra wiring, not doc-writing, hence its own ticket:
mkdocs.yml(anddocs/nav) for the relevant doc sets.backstage.io/techdocs-refannotations so the right docs attach to the right components.docs/guides/, the developer-facing set).Context
The zero-downtime docs (Phases 1–4) are complete in-repo: developer + platform overviews, tutorial, how-to guides, reference, troubleshooting, architecture, glossary, FAQ, demo walkthrough. TechDocs is the remaining distribution step.
Refs: the
backstage-portalhouse skill; ADR-051 (Backstage portal).