3.8 KiB
Administrator Guide
Status: Partially migrated. Current SSO and local upgrade/recovery procedures are available; held procedures are labeled non-operative.
This book is the canonical home for installation, configuration, deployment, routine operations, security controls, incident response, and recovery. User workflows belong in USER-GUIDE/; implementation and contributor material belongs in DEVELOPER-GUIDE/.
Start here
- Documentation atlas — placement rules and source-of-truth boundaries.
- Documentation sitemap — resolvable current navigation and authority-gated migration summary.
- Product requirements — normative requirements, currently marked draft.
- Operations index — current local procedures and explicitly held operational outlines.
- Security index — current SSO provider configuration.
Chapter map
| Chapter | Scope | Status |
|---|---|---|
installation/ |
Prerequisites, installation, and first deployment. | Scaffold only. |
configuration/ |
Environment, provider, tier, and runtime configuration. | Scaffold only. |
deployment/ |
Topologies, rollout, migration, and upgrade procedures. | Scaffold only. |
operations/ |
Health, observability, routine operation, and maintenance. | Local upgrade/recovery is current; connector lease operations are held. |
security/ |
Authentication, authorization, SSO, secrets, and security controls. | SSO provider guide is current; other pages are planned. |
recovery/ |
Incident response, backup, rollback, and recovery. | Scaffold only. |
Every promoted page must be added to this index and to SITEMAP.md in the same migration slice.
Evidence — not current operator guidance
P8-003 performance report— historical performance evidence; implementation alignment is partial, and production metrics remain unverified. It is not an operational SLO or runbook.
Migration backlog — not current operator guidance
These are source candidates, not verified runbooks:
_old_structure/guides/admin-guide.md— quarantined historical source; verify claims before promotion._old_structure/guides/deployment.md— quarantined historical source; deployment commands and assumptions remain held.- See the documentation catalog for file-level dispositions.
Do not treat a migration candidate as current until its commands, paths, permissions, and safety status are checked against source and tests.
Authoring boundary
New administrator documentation belongs under one of the chapter directories above. Operationally sensitive pages must identify prerequisites, ownership, source-of-truth dependencies, and whether any procedure is current, illustrative, held, or non-operative.