chore: condense all docs and markdown files
This commit is contained in:
Vendored
+5
-11
@@ -1,25 +1,19 @@
|
||||
# ADR <NNNN>: <Title>
|
||||
|
||||
## Status
|
||||
|
||||
Proposed | Accepted | Deprecated | Superseded
|
||||
|
||||
## Context
|
||||
|
||||
Explain the problem and the forces at play. Include constraints, risks, or user needs.
|
||||
Problem, constraints, and forces.
|
||||
|
||||
## Decision
|
||||
|
||||
State the decision clearly and explicitly.
|
||||
Chosen option.
|
||||
|
||||
## Consequences
|
||||
|
||||
List the expected positive and negative outcomes, including operational impact.
|
||||
Positive/negative impact, including ops impact.
|
||||
|
||||
## Alternatives Considered
|
||||
|
||||
Briefly document viable alternatives and why they were rejected.
|
||||
Viable options and rejection reason.
|
||||
|
||||
## Related
|
||||
|
||||
Link to relevant PRs, runbooks, or architecture sections.
|
||||
Relevant docs/code/runbooks/PRs.
|
||||
|
||||
Vendored
+2
-23
@@ -1,29 +1,8 @@
|
||||
# Runbook: <Short Title>
|
||||
|
||||
## Summary
|
||||
|
||||
One or two sentences describing the situation this runbook covers.
|
||||
# Runbook: <Title>
|
||||
|
||||
## 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.
|
||||
## References
|
||||
|
||||
Reference in New Issue
Block a user