Writing application documentation
Write docs that help someone run, change, or troubleshoot this application. Start at the
Project conventions
These engineering rules and preferences guide changes to the application in this repository. Follow the
Application profile
This page records the application's purpose, ownership, origin, and current capabilities.
Configuration
The configuration model defines environment variable names, types, defaults, and
Development workflow
Use this guide to take a change from a fresh checkout to a verified pull request. Start at the
Testing and verification
Related: development, conventions
Architecture
This guide describes the implementation in this checkout. The application profile records its purpose
Using the API
This guide describes the implemented authentication and user interfaces. Use it to verify a local instance or diagnose
Release
Use this guide to publish a tested commit as a versioned container image and GitHub release. The
Deployment
Use this guide to configure the runtime container and Helm chart, prepare application upgrades, and verify a rollout.
Operations
Use this guide to check a running application, inspect its signals, diagnose failures, and recover service.
Monitoring
Use this guide to collect and interpret the current application's signals. See operations for process
GitHub configuration
Use this reference for workflow variables and secrets.