Merge branch 'master' of github.com:spotify/backstage into blam/msw-adr
* 'master' of github.com:spotify/backstage: Documentation skeleton (#1617) [TechDocs] Use Backstage docs as example (#1625)
This commit is contained in:
@@ -1,6 +1,8 @@
|
||||
## Date: 2020-04-26
|
||||
# ADR001: Architecture Decision Record (ADR) log
|
||||
|
||||
## Title: Architecture Decision Record (ADR) log
|
||||
| Created | Status |
|
||||
| ---------- | ------ |
|
||||
| 2020-04-26 | Open |
|
||||
|
||||
## Decision: A decision was made to store ADRs in a log in the project repository
|
||||
|
||||
|
||||
@@ -0,0 +1,28 @@
|
||||
# Architecture Decision Records (ADR)
|
||||
|
||||
The substantial architecture decisions made in the Backstage project lives here.
|
||||
For more information about ADRs, when to write them, and why, please see
|
||||
[this blog post](https://engineering.atspotify.com/2020/04/14/when-should-i-write-an-architecture-decision-record/).
|
||||
|
||||
Records are never deleted but can be marked as superseded by new decisions or
|
||||
deprecated.
|
||||
|
||||
Records should be stored under the `architecture-decisions` directory.
|
||||
|
||||
## Contributing
|
||||
|
||||
### Creating an ADR
|
||||
|
||||
- Copy `0000-template.md` to `docs/architecture-decisions/0000-my-decision.md`
|
||||
(my-decision should be descriptive. Do not assign an ADR number.)
|
||||
- Fill in the ADR following the guidelines in the template
|
||||
- Submit a pull request
|
||||
- Address and integrate feedback from the community
|
||||
- Eventually, assign a number
|
||||
- Add the full path of the ADR to the [`mkdocs.yml`](/mkdocs.yml)
|
||||
- Merge the pull request
|
||||
|
||||
## Superseding an ADR
|
||||
|
||||
If an ADR supersedes an older ADR then the older ADR's status is changed to
|
||||
superseded by ADR-XXXX and links to the new ADR.
|
||||
Reference in New Issue
Block a user