Fleshed out documentation
This commit is contained in:
Vendored
+25
@@ -0,0 +1,25 @@
|
||||
# ADR <NNNN>: <Title>
|
||||
|
||||
## Status
|
||||
|
||||
Proposed | Accepted | Deprecated | Superseded
|
||||
|
||||
## Context
|
||||
|
||||
Explain the problem and the forces at play. Include constraints, risks, or user needs.
|
||||
|
||||
## Decision
|
||||
|
||||
State the decision clearly and explicitly.
|
||||
|
||||
## Consequences
|
||||
|
||||
List the expected positive and negative outcomes, including operational impact.
|
||||
|
||||
## Alternatives Considered
|
||||
|
||||
Briefly document viable alternatives and why they were rejected.
|
||||
|
||||
## Related
|
||||
|
||||
Link to relevant PRs, runbooks, or architecture sections.
|
||||
Vendored
+29
@@ -0,0 +1,29 @@
|
||||
# Runbook: <Short Title>
|
||||
|
||||
## Summary
|
||||
|
||||
One or two sentences describing the situation this runbook covers.
|
||||
|
||||
## Symptoms
|
||||
|
||||
Describe what an operator or user will observe.
|
||||
|
||||
## Impact
|
||||
|
||||
Who or what is affected.
|
||||
|
||||
## Quick Checks
|
||||
|
||||
Exact commands or checks that confirm the issue.
|
||||
|
||||
## Mitigation Steps
|
||||
|
||||
Step-by-step actions to resolve or reduce impact.
|
||||
|
||||
## Rollback / Escalation
|
||||
|
||||
How to revert or who to contact if the issue persists.
|
||||
|
||||
## Notes
|
||||
|
||||
Any caveats, dependencies, or follow-up actions.
|
||||
Reference in New Issue
Block a user