Platform Handbook¶
The single place for platform documentation: how the platform is planned, built, and operated, and how to add an application to it.
Application-specific documentation lives with the application (for example, the TodoList app keeps its local-development and chart docs in its own repository).
Status
This handbook is delivered like any other application: built in CI, pushed by digest, and
reconciled by Argo CD. The platform itself is a work in progress — the design and its open
questions are in Decisions, and the roadmap is tracked in the
GITOPS-HUB, PLATFORM-RENAME, and OBSERVABILITY tasks.
Start here¶
| I want to... | Go to |
|---|---|
| See what is committed, in discovery, or later | Roadmap |
| Understand what the platform is | Getting started: overview |
| Know what I need before I start | Getting started: prerequisites |
| See how the repositories are laid out | Getting started: repository structure |
| Understand dev vs prod | Concepts: environments |
| Know who owns what | Concepts: ownership |
| Consume platform values in my app | Concepts: the contract |
| See a full example end to end | Onboarding: worked example (TodoList) |
| Deploy my application | Onboarding: add an application |
| Operate or troubleshoot the platform | Operations: runbook |
| See why things are the way they are | Decisions |
What belongs where¶
- Here: platform concepts, architecture, decisions, runbooks, costs, and the application onboarding guide.
- In the platform repository: code-adjacent notes (module READMEs).
- In the application repository: everything specific to that application.