54 lines
1.7 KiB
Markdown
Executable File
54 lines
1.7 KiB
Markdown
Executable File
# Documentation Index
|
|
|
|
This documentation set follows the Diataxis model and is organized by reader
|
|
intent.
|
|
|
|
## Getting started
|
|
|
|
Tutorials for the first successful setup:
|
|
|
|
- [Installation](./getting-started/01-installation.md)
|
|
- [Configuration](./getting-started/02-configuration.md)
|
|
- [Local Development Environment](./getting-started/03-local-development.md)
|
|
|
|
## Guides
|
|
|
|
Goal-oriented operational and engineering tasks:
|
|
|
|
- [Deploying to Production](./guides/deploying-to-production.md)
|
|
- [Setting Up Monitoring](./guides/setting-up-monitoring.md)
|
|
- [Run Tests](./guides/run-tests.md)
|
|
- [Development Planning Guidelines](./guides/development-planning.md)
|
|
|
|
## Concepts
|
|
|
|
High-level explanations of how the system works and why it is structured this
|
|
way:
|
|
|
|
- [Architectural Overview](./concepts/architectural-overview.md)
|
|
- [Security Model](./concepts/security-model.md)
|
|
- [Identified Functionality, Capabilities & Purpose](./concepts/functionality-and-capabilities.md)
|
|
|
|
## Design
|
|
|
|
Implemented UI truth for the same-origin control plane:
|
|
|
|
- [UI Design Reference](./design/ui-design.md)
|
|
|
|
## Reference
|
|
|
|
Lookup-oriented technical details:
|
|
|
|
- [API Endpoints Reference](./reference/api-endpoints.md)
|
|
- [Data Model Reference](./reference/data-model.md)
|
|
- [Environment Variables Reference](./reference/environment-variables.md)
|
|
- [Commands, Scripts & Tests Reference](./reference/commands-scripts.md)
|
|
- [Package Dependencies Reference](./reference/dependencies.md)
|
|
- [Docker Configuration Reference](./reference/docker-reference.md)
|
|
- [Software Bill of Materials](./reference/sbom.md)
|
|
|
|
## Additional repository material
|
|
|
|
- [Benchmark Report](./benchmark-report.md)
|
|
- [SVG architecture diagrams](./assets/diagrams/)
|