46 lines
3.4 KiB
Markdown
46 lines
3.4 KiB
Markdown
# Administrator Guide
|
|
|
|
> **Status:** Scaffold only. No legacy page has been promoted into this book yet.
|
|
|
|
This book is the canonical home for installation, configuration, deployment, routine operations, security controls, incident response, and recovery. User workflows belong in [`USER-GUIDE/`](../USER-GUIDE/); implementation and contributor material belongs in [`DEVELOPER-GUIDE/`](../DEVELOPER-GUIDE/).
|
|
|
|
## Start here
|
|
|
|
- [Documentation atlas](../README.md) — placement rules and source-of-truth boundaries.
|
|
- [Documentation sitemap](../SITEMAP.md) — existing navigation is transitional and still contains legacy paths.
|
|
- [Product requirements](../PRD.md) — normative requirements, currently marked draft.
|
|
|
|
## 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. | Scaffold only. |
|
|
| [`security/`](security/README.md) | Authentication, authorization, SSO, secrets, and security controls. | Scaffold only; `SSO-PROVIDERS.md` is a migration candidate. |
|
|
| `recovery/` | Incident response, backup, rollback, and recovery. | Scaffold only. |
|
|
|
|
Every promoted page must be added to this index and to [`SITEMAP.md`](../SITEMAP.md) in the same migration slice.
|
|
|
|
## Migration backlog — not current operator guidance
|
|
|
|
These are source candidates, not verified runbooks:
|
|
|
|
- [`SSO-PROVIDERS.md`](../SSO-PROVIDERS.md) — partially verified; its documented web feature flags conflict with current dynamic provider discovery.
|
|
- [`PERFORMANCE.md`](../PERFORMANCE.md) — historical performance evidence, not an operational SLO or runbook.
|
|
- [`_old_structure/guides/admin-guide.md`](../_old_structure/guides/admin-guide.md) — historical source; verify claims before promotion.
|
|
- [`_old_structure/guides/deployment.md`](../_old_structure/guides/deployment.md) — historical source; verify commands and deployment assumptions before promotion.
|
|
|
|
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.
|
|
|
|
## Related
|
|
|
|
- [[README|Documentation contract]]
|
|
- [[PRD|Product requirements]]
|
|
- [[DEVELOPER-GUIDE/architecture/README|Architecture index]]
|