Mirror minimal/bare/bare-minimal templates to docs/decisions

.github/workflows/lint.yaml

@@ -19,6 +19,8 @@ jobs:
           globs: |
             *.md,
             docs/**/*.md
+            !docs/decisions/adr-template-bare.md
+            !docs/decisions/adr-template-bare-minimal.md
             template/0000-use-markdown-architectural-decision-records.md
             template/adr-template-minimal.md
             template/adr-template.md

CHANGELOG.md

@@ -7,6 +7,10 @@ and this project adheres to [Semantic Versioning](https://semver.org/).
 
 ## [unreleased]
 
+### Added
+
+- Mirrored the `minimal`, `bare`, and `bare-minimal` templates to `docs/decisions/` so all four templates render on the documentation site.
+
 ### Changed
 
 - Changed wording in "Confirmation" section. [#162](https://github.com/adr/madr/pull/162)

README.md

@@ -21,15 +21,18 @@ Longer explanation: Head to <https://adr.github.io/madr/#applying-madr-to-your-p
 * Issues can be reported at <https://github.com/adr/madr/issues>.
 * Suggestions can be contributed via pull requests. MADR offers pre-configured VS Code web environment at [Gitpod](https://gitpod.io/#https://github.com/adr/madr).
 * MADR uses [markdownlint](https://github.com/DavidAnson/markdownlint) as Linter for Markdown files. Use [markdownlint](https://marketplace.visualstudio.com/items?itemName=DavidAnson.vscode-markdownlint) for checking for linting issues in VS Code.
-* `template/adr-template.md` is mirrored to `docs/decisions/adr-template`.
-  However, following YAML front matter is added to make it handled properly by the [Just the Docs Jekyll Template](https://just-the-docs.github.io/just-the-docs/). <!-- markdownlint-disable-next-line MD031 -->
+* The four templates in `template/` are mirrored to `docs/decisions/`:
+  `adr-template.md`, `adr-template-minimal.md`, `adr-template-bare.md`, and `adr-template-bare-minimal.md`.
+  The content must be kept identical to the originals in `template/`.
+  However, YAML front matter is added to each mirror to make it handled properly by the [Just the Docs Jekyll Template](https://just-the-docs.github.io/just-the-docs/), and the first heading gets a `<!-- markdownlint-disable-next-line MD025 -->` comment because the front-matter `title` differs from it. <!-- markdownlint-disable-next-line MD031 -->
   ```markdown
   ---
   parent: Decisions
   nav_order: 100
   title: ADR Template
   ---
   ```
+  The `nav_order` values are 100 (`adr-template.md`), 101 (minimal), 102 (bare), and 103 (bare minimal).
 
 ### Branches
 
@@ -95,8 +98,9 @@ In case you get errors regarding `Gemfile.lock`, just delete `Gemfile.lock` and
 4. Adapt the version reference in `template/0000-use-markdown-architectural-decision-records.md`.
 5. Update "template" files in `docs/decisions`:
    * Copy `template/0000-use-markdown-architectural-decision-records.md` to `docs/decisions/0000-use-markdown-architectural-decision-records.md`.
-   * Adapt content of `docs/decisions/adr-template.md` based on `template/adr-template.md`.
-     Thereby, ensure that the YAML front matter in `docs/decisions/adr-template.md` is kept.
+   * Adapt content of the mirrored templates in `docs/decisions/` based on their originals in `template/`:
+     `adr-template.md`, `adr-template-minimal.md`, `adr-template-bare.md`, and `adr-template-bare-minimal.md`.
+     Thereby, ensure that the YAML front matter (and the `MD025` disable comment) in each mirror is kept.
 6. Add link to `docs/index.md` at "Older versions" (for the homepage).
 7. Copy `.markdownlint.yml` to `template/.markdownlint.yml` (and possibly to `docs/.markdownlint.yml`).
 8. Update `CHANGELOG.md`.

docs/decisions/adr-template-bare-minimal.md

@@ -0,0 +1,22 @@
+---
+# Configuration for the Jekyll template "Just the Docs"
+parent: Decisions
+nav_order: 103
+title: ADR Template (Bare Minimal)
+---
+<!-- markdownlint-disable-next-line MD025 -->
+# <!-- short title, representative of solved problem and found solution -->
+
+## Context and Problem Statement
+
+
+
+## Considered Options
+
+
+
+## Decision Outcome
+
+
+
+### Consequences

docs/decisions/adr-template-bare.md

@@ -0,0 +1,43 @@
+---
+# Configuration for the Jekyll template "Just the Docs"
+parent: Decisions
+nav_order: 102
+title: ADR Template (Bare)
+---
+<!-- markdownlint-disable-next-line MD025 -->
+# <!-- short title, representative of solved problem and found solution -->
+
+## Context and Problem Statement
+
+
+
+## Decision Drivers
+
+* <!-- decision driver -->
+
+## Considered Options
+
+* <!-- option -->
+
+## Decision Outcome
+
+Chosen option: "", because
+
+### Consequences
+
+* Good, because
+* Bad, because
+
+### Confirmation
+
+
+
+## Pros and Cons of the Options
+
+### <!-- title of option -->
+
+* Good, because
+* Neutral, because
+* Bad, because
+
+## More Information

docs/decisions/adr-template-minimal.md

@@ -0,0 +1,30 @@
+---
+# Configuration for the Jekyll template "Just the Docs"
+parent: Decisions
+nav_order: 101
+title: ADR Template (Minimal)
+---
+<!-- we need to disable MD025, because we use the different heading "ADR Template (Minimal)" in the homepage (see above) than it is foreseen in the template -->
+<!-- markdownlint-disable-next-line MD025 -->
+# {short title, representative of solved problem and found solution}
+
+## Context and Problem Statement
+
+{Describe the context and problem statement, e.g., in free form using two to three sentences or in the form of an illustrative story. You may want to articulate the problem in form of a question. Consider adding links to collaboration boards or issue management systems. Make the scope of the decision explicit, for instance, by calling out or pointing at structural architecture elements (components, connectors, ...).}
+
+## Considered Options
+
+* {title of option 1}
+* {title of option 2}
+* {title of option 3}
+* … <!-- numbers of options can vary -->
+
+## Decision Outcome
+
+Chosen option: "{title of option 1}", because {justification. e.g., only option, which meets k.o. criterion decision driver | which resolves force {force} | … | comes out best (see below)}.
+
+### 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 -->