Stefan Ålund
8ec6ed5170
* Documentation skeleton * Added ADR list and more * rm material theme * Update mkdocs.yml * Add docs TOC * Work for plain MD and mkdocs * Update mkdocs.yml * Restructuring * Added roadmap * Add reference APIs * move publishing
1.0 KiB
1.0 KiB
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.
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.mdtodocs/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 - 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.