From ad01f46be8bac555499688bcc7ae7eb28e0cd373 Mon Sep 17 00:00:00 2001 From: "A.J. Stein" Date: Wed, 14 May 2025 18:50:32 -0400 Subject: [PATCH 1/3] feat(website): Add ADR1 and dir structure for #10 --- docs/adr/1.md | 21 +++++++++++++++++++++ docs/adr/index.md | 6 ++++++ 2 files changed, 27 insertions(+) create mode 100644 docs/adr/1.md create mode 100644 docs/adr/index.md diff --git a/docs/adr/1.md b/docs/adr/1.md new file mode 100644 index 0000000..57d1463 --- /dev/null +++ b/docs/adr/1.md @@ -0,0 +1,21 @@ +--- +slug: 1-record-architecture-decisions +title: "ADR1: Record Architecture Decisions" +--- + +# Metadata + +Date: 2025-05-14 +Status: Accepted + +# Context + +We need to record the architectural decisions for Super Cool Example Cloud. + +# Decision + +We will use Architecture Decision Records, as described by Michael Nygard in his article ["Documenting Architecture Decisions"](http://thinkrelevance.com/blog/2011/11/15/documenting-architecture-decisions). + +# Consequences + +See Michael Nygard's article, linked above. diff --git a/docs/adr/index.md b/docs/adr/index.md new file mode 100644 index 0000000..a10ab7f --- /dev/null +++ b/docs/adr/index.md @@ -0,0 +1,6 @@ +--- +title: Architecture Decision Record Index +sidebar_label: Architecture Decisions +--- + +This section of the site contains architectural decisions records for Super Cool Example Cloud services and supporting infrastructure. From a20240d13488b0773f98e95ac43e7fcd77e3753e Mon Sep 17 00:00:00 2001 From: "A.J. Stein" Date: Wed, 14 May 2025 18:53:37 -0400 Subject: [PATCH 2/3] feat(website): Some more formatting for ADR layout --- docs/adr/1.md | 11 +++++++---- 1 file changed, 7 insertions(+), 4 deletions(-) diff --git a/docs/adr/1.md b/docs/adr/1.md index 57d1463..f72d6e4 100644 --- a/docs/adr/1.md +++ b/docs/adr/1.md @@ -3,19 +3,22 @@ slug: 1-record-architecture-decisions title: "ADR1: Record Architecture Decisions" --- -# Metadata +# Record Architecture Decisions + +## Metadata Date: 2025-05-14 + Status: Accepted -# Context +## Context We need to record the architectural decisions for Super Cool Example Cloud. -# Decision +## Decision We will use Architecture Decision Records, as described by Michael Nygard in his article ["Documenting Architecture Decisions"](http://thinkrelevance.com/blog/2011/11/15/documenting-architecture-decisions). -# Consequences +## Consequences See Michael Nygard's article, linked above. From f9cbe4e78402d06141963875c514e736306b20eb Mon Sep 17 00:00:00 2001 From: "A.J. Stein" Date: Wed, 14 May 2025 18:56:26 -0400 Subject: [PATCH 3/3] feat(website): Change slug to ID only for ADRs --- docs/adr/1.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/adr/1.md b/docs/adr/1.md index f72d6e4..a335062 100644 --- a/docs/adr/1.md +++ b/docs/adr/1.md @@ -1,5 +1,5 @@ --- -slug: 1-record-architecture-decisions +slug: 1 title: "ADR1: Record Architecture Decisions" ---