From 49bf8a3539425530b5cdb4f6d338248b2397f22c Mon Sep 17 00:00:00 2001 From: Tom Cobb Date: Mon, 12 Feb 2024 16:43:08 +0000 Subject: [PATCH] Change wording for ADRs and add template --- .../explanations/decisions.md | 12 +++--------- .../explanations/decisions/COPYME | 19 +++++++++++++++++++ 2 files changed, 22 insertions(+), 9 deletions(-) create mode 100644 template/{% if sphinx %}docs{% endif %}/explanations/decisions/COPYME diff --git a/template/{% if sphinx %}docs{% endif %}/explanations/decisions.md b/template/{% if sphinx %}docs{% endif %}/explanations/decisions.md index f97c2f9f3..0533b98d4 100644 --- a/template/{% if sphinx %}docs{% endif %}/explanations/decisions.md +++ b/template/{% if sphinx %}docs{% endif %}/explanations/decisions.md @@ -1,14 +1,6 @@ -% This Source Code Form is subject to the terms of the Mozilla Public - -% License, v. 2.0. If a copy of the MPL was not distributed with this - -% file, You can obtain one at http://mozilla.org/MPL/2.0/. - # Architectural Decision Records -We record major architectural decisions in Architecture Decision Records (ADRs), -as [described by Michael Nygard](http://thinkrelevance.com/blog/2011/11/15/documenting-architecture-decisions). -Below is the list of our current ADRs. +Architectural decisions are made throughout a project's lifetime. As a way of keeping track of these decisions, we record these decisions in Architecture Decision Records (ADRs) listed below. ```{toctree} :glob: true @@ -16,3 +8,5 @@ Below is the list of our current ADRs. decisions/* ``` + +For more information on ADRs see this [blog by Michael Nygard](http://thinkrelevance.com/blog/2011/11/15/documenting-architecture-decisions). diff --git a/template/{% if sphinx %}docs{% endif %}/explanations/decisions/COPYME b/template/{% if sphinx %}docs{% endif %}/explanations/decisions/COPYME new file mode 100644 index 000000000..b466c7929 --- /dev/null +++ b/template/{% if sphinx %}docs{% endif %}/explanations/decisions/COPYME @@ -0,0 +1,19 @@ +# 3. Short descriptive title + +Date: Today's date + +## Status + +Accepted + +## Context + +Background to allow us to make the decision, to show how we arrived at our conclusions. + +## Decision + +What decision we made. + +## Consequences + +What we will do as a result of this decision.