From db3fad5ba4a35d5e5d4b622c545857b23fc2a4c8 Mon Sep 17 00:00:00 2001 From: WayneGoosen <13494899+WayneGoosen@users.noreply.github.com> Date: Sun, 21 Apr 2024 13:51:44 +0200 Subject: [PATCH] Update ADR status and fix formatting issues --- ...40410-use-log4brains-to-manage-the-adrs.md | 2 +- ...markdown-architectural-decision-records.md | 42 ------------------- .../adr/20240410-deploy-blog-using-astro.md | 2 +- 3 files changed, 2 insertions(+), 44 deletions(-) delete mode 100644 docs/adr/20240410-use-markdown-architectural-decision-records.md diff --git a/docs/adr/20240410-use-log4brains-to-manage-the-adrs.md b/docs/adr/20240410-use-log4brains-to-manage-the-adrs.md index f575d8f..d99998b 100644 --- a/docs/adr/20240410-use-log4brains-to-manage-the-adrs.md +++ b/docs/adr/20240410-use-log4brains-to-manage-the-adrs.md @@ -1,6 +1,6 @@ # Use Log4brains to manage the ADRs -- Status: draft +- Status: accepted - Date: 2024-04-09 - Tags: dev-tools, doc diff --git a/docs/adr/20240410-use-markdown-architectural-decision-records.md b/docs/adr/20240410-use-markdown-architectural-decision-records.md deleted file mode 100644 index a7af51a..0000000 --- a/docs/adr/20240410-use-markdown-architectural-decision-records.md +++ /dev/null @@ -1,42 +0,0 @@ -# Use Markdown Architectural Decision Records - -- Status: draft -- Date: 2024-04-09 -- Tags: doc - -## Context and Problem Statement - -We want to record architectural decisions made in this project. -Which format and structure should these records follow? - -## Considered Options - -- [MADR](https://adr.github.io/madr/) 2.1.2 with Log4brains patch -- [MADR](https://adr.github.io/madr/) 2.1.2 – The original Markdown Architectural Decision Records -- [Michael Nygard's template](http://thinkrelevance.com/blog/2011/11/15/documenting-architecture-decisions) – The first incarnation of the term "ADR" -- [Sustainable Architectural Decisions](https://www.infoq.com/articles/sustainable-architectural-design-decisions) – The Y-Statements -- Other templates listed at -- Formless – No conventions for file format and structure - -## Decision Outcome - -Chosen option: "MADR 2.1.2 with Log4brains patch", because - -- Implicit assumptions should be made explicit. - Design documentation is important to enable people understanding the decisions later on. - See also [A rational design process: How and why to fake it](https://doi.org/10.1109/TSE.1986.6312940). -- The MADR format is lean and fits our development style. -- The MADR structure is comprehensible and facilitates usage & maintenance. -- The MADR project is vivid. -- Version 2.1.2 is the latest one available when starting to document ADRs. -- The Log4brains patch adds more features, like tags. - -The "Log4brains patch" performs the following modifications to the original template: - -- Change the ADR filenames format (`NNN-adr-name` becomes `YYYYMMDD-adr-name`), to avoid conflicts during Git merges. -- Add a `draft` status, to enable collaborative writing. -- Add a `Tags` field. - -## Links - -- Relates to [Use Log4brains to manage the ADRs](20240410-use-log4brains-to-manage-the-adrs.md) diff --git a/packages/blog/docs/adr/20240410-deploy-blog-using-astro.md b/packages/blog/docs/adr/20240410-deploy-blog-using-astro.md index 301ed83..ede4211 100644 --- a/packages/blog/docs/adr/20240410-deploy-blog-using-astro.md +++ b/packages/blog/docs/adr/20240410-deploy-blog-using-astro.md @@ -1,4 +1,4 @@ -# deploy blog using astro +# Deploy blog using Astro - Status: accepted - Deciders: Wayne Goosen [list everyone involved in the decision]