Merge branch 'main' into docs/jenkins-tutorial

.github/workflows/validate-adrs.yml

@@ -0,0 +1,27 @@
+
+name: Validate ADRs
+
+on:
+  pull_request:
+    branches:
+      - main
+    paths:
+      - 'docs/architecture/decisions'
+
+jobs:
+    validate:
+        runs-on: ubuntu-latest
+        steps:
+          - name: Checkout Code
+            uses: actions/checkout@692973e3d937129bcbf40652eb9f2f61becf3332 # pin@v4
+
+          - name: Set up poetry and install
+            uses: ./.github/actions/setup-poetry
+            with:
+              python-version: '3.11'
+
+          - name: Run validate adrs
+            run:  trestle author docs validate -tn decisions -hv -tr docs/architecture
+
+
+

CONTRIBUTING.md

@@ -83,7 +83,11 @@ For workflow diagrams, see the [diagrams](./docs/workflows/) under the `docs` fo
 
 #### Architecture Decisions
 
-We document decisions using [Architectural Decision Records](https://cognitect.com/blog/2011/11/15/documenting-architecture-decisions). The team will decide when an ADR will be put in place, but this is generally done to document impactful architectural decisions. [`adr-tools`](https://github.com/npryce/adr-tools) can be used to manage ADRs in the repository located under `docs/architecture/decisions`.
+We document decisions using [Architectural Decision Records](http://thinkrelevance.com/blog/2011/11/15/documenting-architecture-decisions). The team will decide when an ADR will be put in place, but this is generally done to document impactful architectural decisions.
+
+* Create an instance of the ADR template using `trestle author docs create-sample -tn decisions -tr docs/architecture`.
+* This can be tested locally via `trestle author docs validate --task-name decisions -hv -tr docs/architecture`
+
 
 #### Update the `actions` files
 

docs/architecture/.trestle/author/decisions/0.0.1/template.md

@@ -0,0 +1,17 @@
+---
+x-trestle-template-version: 0.0.1
+title:
+status: proposed # Valid statuses are proposed, deferred, rejected, withdrawn or replaced
+---
+
+## Context
+
+<!--Add information here that clearly outlines the problem or opportunity that necessitated the decision.-->
+
+## Decision
+
+<!--State the decision here clear and unambiguous. Describe the rationale and the tradeoffs. --->
+
+## Consequences
+
+<!--Add information here on risks and potential impacts or outcomes.--->

docs/architecture/decisions/record-architecture-decisions_000.md

@@ -0,0 +1,17 @@
+---
+x-trestle-template-version: 0.0.1
+title: Record architecture decisions
+status: accepted # Valid statuses are proposed, accepted, deferred, rejected, withdrawn, or replaced
+---
+
+## Context
+
+We need to record the architectural decisions made on this project.
+
+## Decision
+
+We will use Architecture Decision Records, as [described by Michael Nygard](http://thinkrelevance.com/blog/2011/11/15/documenting-architecture-decisions).
+
+## Consequences
+
+See Michael Nygard's article, linked above. `trestle` will be used to create and validate these decisions.