docs(ADR): add architecture decision template (#1630)

Signed-off-by: Michael Beemer <[email protected]>

Author: beeme1mr

.markdownlint-cli2.yaml

@@ -13,6 +13,7 @@ config:
   max-one-sentence-per-line: true
   code-block-style: false         # not compatible with mkdocs "details" panes
   no-alt-text: false
+  descriptive-link-text: false
   MD007:
     indent: 4
 

docs/architecture-decisions/.template.md

@@ -0,0 +1,98 @@
+---
+# Valid statuses: draft | proposed | rejected | accepted | superseded
+status: draft
+author: Your Name
+created: YYYY-MM-DD
+updated: YYYY-MM-DD
+---
+
+# Title
+
+<!--
+This section should be one or two paragraphs that just explains what the goal of this decision is going to be, but without diving too deeply into the "why", "why now", "how", etc.
+Ensure anyone opening the document will form a clear understanding of the intent from reading this paragraph(s).
+-->
+
+## Background
+
+<!--
+The next section is the "Background" section. This section should be at least two paragraphs and can take up to a whole page in some cases.
+The guiding goal of the background section is: as a newcomer to this project (new employee, team transfer), can I read the background section and follow any links to get the full context of why this change is necessary?
+
+If you can't show a random engineer the background section and have them acquire nearly full context on the necessity for the RFC, then the background section is not full enough. To help achieve this, link to prior RFCs, discussions, and more here as necessary to provide context so you don't have to simply repeat yourself.
+-->
+
+## Requirements
+
+<!--
+This section outlines the requirements that the proposal must meet.
+These requirements should be derived from the background section and should be clear, concise, and actionable.
+This is where you can specify the goals and constraints that the proposal must satisfy.
+This could include performance metrics, security considerations, user experience goals, and any other relevant criteria.
+-->
+* {Requirement 1}
+* {Requirement 2}
+* {Requirement 3}
+* … <!-- numbers of requirements can vary -->
+
+## Considered Options
+
+<!--
+This section lists all the options that were considered for addressing the need outlined in the background section. 
+Each option should be clearly defined with a descriptive title.
+This provides a comprehensive overview of the solution space that was explored before making a decision.
+The options will be evaluated in the proposal section, where the chosen approach is justified.
+-->
+
+* {title of option 1}
+* {title of option 2}
+* {title of option 3}
+* … <!-- numbers of options can vary -->
+
+## Proposal
+
+<!--
+The next required section is "Proposal" or "Goal".
+Given the background above, this section proposes a solution.
+This should be an overview of the "how" for the solution.
+Include content like diagrams, prototypes, and high-level requirements.
+-->
+
+<!-- This is an optional element. Feel free to remove. -->
+### API changes
+
+<!--
+This section should describe any API changes that are part of the proposal.
+This includes any new endpoints, changes to existing endpoints, or modifications to the data model.
+It should provide enough detail for developers to understand how the API will evolve and what impact it will have on existing clients.
+-->
+
+<!-- This is an optional element. Feel free to remove. -->
+### Consequences
+
+* Good, because {positive consequence, e.g., improvement of one or more desired qualities, …}
+* Bad, because {negative consequence, e.g., compromising one or more desired qualities, …}
+* … <!-- numbers of consequences can vary -->
+
+### Timeline
+
+<!--
+This section outlines a high level timeline for implementing the proposal.
+It should include key milestones, deadlines, and any dependencies that need to be addressed.
+This helps to set expectations for the size of the change and the expected timeline for completion.
+-->
+
+<!-- This is an optional element. Feel free to remove. -->
+### Open questions
+
+* {Question 1}
+* … <!-- numbers of question can vary -->
+
+<!-- This is an optional element. Feel free to remove. -->
+## More Information
+
+<!--
+This section provides additional context, evidence, or documentation to support the decision.
+Use this space to provide any supplementary information that would be helpful for future readers
+to fully understand the decision and its implications.
+-->