initial commit
Some checks failed
Build and Publish TechDocs / build-and-publish (push) Failing after 1m4s
Some checks failed
Build and Publish TechDocs / build-and-publish (push) Failing after 1m4s
Change-Id: I732e7af790c42cbd6fc2c2e754882fef44f90c00
This commit is contained in:
61
docs/adr/index.md
Normal file
61
docs/adr/index.md
Normal file
@@ -0,0 +1,61 @@
|
||||
# Architecture Decision Records
|
||||
|
||||
This directory tracks Architecture Decision Records (ADRs) for **test-argocd-gitops-c6**.
|
||||
|
||||
ADRs capture the context, trade-offs, and consequences of significant technical choices. They are lightweight documents — typically one to two pages — following the [MADR format](https://adr.github.io/madr/).
|
||||
|
||||
## Why ADRs?
|
||||
|
||||
- **Preserve context**: Future engineers understand *why* a decision was made, not just what was decided.
|
||||
- **Reduce re-litigation**: A documented decision stops teams re-debating the same trade-offs every quarter.
|
||||
- **Accelerate onboarding**: New team members read ADRs to understand the service's evolution without archaeology.
|
||||
|
||||
## Index
|
||||
|
||||
| # | Title | Status | Date |
|
||||
|---|-------|--------|------|
|
||||
| *(add entries here as ADRs are created)* | | | |
|
||||
|
||||
## Creating a new ADR
|
||||
|
||||
1. Copy the template below into `docs/adr/NNNN-<short-title>.md` where `NNNN` is the next sequential number.
|
||||
2. Fill in every section — even if the answer is "not applicable, because...".
|
||||
3. Open a pull request so the team can review the decision **before** it is finalized.
|
||||
4. Update the index table above once the ADR is accepted.
|
||||
|
||||
---
|
||||
|
||||
## ADR Template
|
||||
|
||||
```
|
||||
# NNNN. <Short imperative title of the decision>
|
||||
|
||||
Date: YYYY-MM-DD
|
||||
Status: Proposed | Accepted | Deprecated | Superseded by [NNNN](NNNN-<title>.md)
|
||||
|
||||
## Context and problem statement
|
||||
|
||||
Describe the problem or question that drove this decision.
|
||||
|
||||
## Decision drivers
|
||||
|
||||
- Driver 1
|
||||
- Driver 2
|
||||
|
||||
## Considered options
|
||||
|
||||
- **Option A** — brief description
|
||||
- **Option B** — brief description
|
||||
|
||||
## Decision outcome
|
||||
|
||||
Chosen option: **Option X**, because ...
|
||||
|
||||
### Positive consequences
|
||||
|
||||
- ...
|
||||
|
||||
### Negative consequences
|
||||
|
||||
- ...
|
||||
```
|
||||
Reference in New Issue
Block a user