From 0f4fe3b8dc1dd1b6386339feafbd546dc38e2f0a Mon Sep 17 00:00:00 2001
From: Oliver Davies <oliver@oliverdavies.uk>
Date: Wed, 12 Jan 2022 18:40:04 +0000
Subject: [PATCH] build(docker): add and configure ADR Tools

---
 .adr-dir                                      |  1 +
 docker-compose.override.yaml.example          |  5 +++++
 .../0001-record-architecture-decisions.md     | 19 +++++++++++++++++++
 .../0002-use-sculpin.md                       | 19 +++++++++++++++++++
 4 files changed, 44 insertions(+)
 create mode 100644 .adr-dir
 create mode 100644 docs/architectural-decisions/0001-record-architecture-decisions.md
 create mode 100644 docs/architectural-decisions/0002-use-sculpin.md

diff --git a/.adr-dir b/.adr-dir
new file mode 100644
index 00000000..548637ba
--- /dev/null
+++ b/.adr-dir
@@ -0,0 +1 @@
+docs/architectural-decisions
diff --git a/docker-compose.override.yaml.example b/docker-compose.override.yaml.example
index d2a05700..58c56311 100644
--- a/docker-compose.override.yaml.example
+++ b/docker-compose.override.yaml.example
@@ -11,6 +11,11 @@ x-assets: &default-assets
     - ".:/app"
 
 services:
+  adr-tools:
+    image: "opdavies/adr-tools"
+    volumes:
+      - "./:/adr"
+
   css:
     <<: *default-assets
     command: "./run yarn:build:css"
diff --git a/docs/architectural-decisions/0001-record-architecture-decisions.md b/docs/architectural-decisions/0001-record-architecture-decisions.md
new file mode 100644
index 00000000..d795a6a4
--- /dev/null
+++ b/docs/architectural-decisions/0001-record-architecture-decisions.md
@@ -0,0 +1,19 @@
+# 1. Record architecture decisions
+
+Date: 2022-01-12
+
+## Status
+
+Accepted
+
+## 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. For a lightweight ADR toolset, see Nat Pryce's [adr-tools](https://github.com/npryce/adr-tools).
diff --git a/docs/architectural-decisions/0002-use-sculpin.md b/docs/architectural-decisions/0002-use-sculpin.md
new file mode 100644
index 00000000..d27e4970
--- /dev/null
+++ b/docs/architectural-decisions/0002-use-sculpin.md
@@ -0,0 +1,19 @@
+# 2. Use Sculpin
+
+Date: 2022-01-12
+
+## Status
+
+Accepted
+
+## Context
+
+The issue motivating this decision, and any context that influences or constrains the decision.
+
+## Decision
+
+The change that we're proposing or have agreed to implement.
+
+## Consequences
+
+What becomes easier or more difficult to do and any risks introduced by the change that will need to be mitigated.