diff --git a/.github/workflows/lint.yaml b/.github/workflows/lint.yaml index 0d4d862..c1896a1 100644 --- a/.github/workflows/lint.yaml +++ b/.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 diff --git a/CHANGELOG.md b/CHANGELOG.md index 3889d52..6c34e96 100644 --- a/CHANGELOG.md +++ b/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) diff --git a/README.md b/README.md index 3355871..49e8ef4 100644 --- a/README.md +++ b/README.md @@ -21,8 +21,10 @@ Longer explanation: Head to . * 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/). +* 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 `` comment because the front-matter `title` differs from it. ```markdown --- parent: Decisions @@ -30,6 +32,7 @@ Longer explanation: Head to +# + +## Context and Problem Statement + + + +## Considered Options + + + +## Decision Outcome + + + +### Consequences diff --git a/docs/decisions/adr-template-bare.md b/docs/decisions/adr-template-bare.md new file mode 100644 index 0000000..161ea8f --- /dev/null +++ b/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) +--- + +# + +## Context and Problem Statement + + + +## Decision Drivers + +* + +## Considered Options + +* + +## Decision Outcome + +Chosen option: "", because + +### Consequences + +* Good, because +* Bad, because + +### Confirmation + + + +## Pros and Cons of the Options + +### + +* Good, because +* Neutral, because +* Bad, because + +## More Information diff --git a/docs/decisions/adr-template-minimal.md b/docs/decisions/adr-template-minimal.md new file mode 100644 index 0000000..c2b780a --- /dev/null +++ b/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) +--- + + +# {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} +* … + +## 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, …} +* …