Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix templates #157

Merged
merged 1 commit into from
Sep 5, 2024
Merged

Fix templates #157

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 5 additions & 5 deletions docs/decisions/0001-use-CC0-or-MIT-as-license.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,25 +23,25 @@ We want to have MADR used without any hassle and that users can just go ahead an

## Decision Outcome

Chosen option: "Dual license", because this lets users choose whether CC0 or MIT fits better on their work.
Chosen option: "Dual license with MIT and CC0", because this lets users choose whether CC0 or MIT fits better on their work.

## Pros and Cons of the Options

## CC0
### CC0

* Good, because this license donates the content to "public domain" and does so as legally as possible.
* Bad, because it does not contain attribution - and [attribution is important](https://opensource.stackexchange.com/a/9126/5671).

## BSD3
### BSD3

* Bad, because it [is unclear whether it can be used for documentation](https://opensource.stackexchange.com/a/9545/5671)

## MIT
### MIT

* Good, because it [explicitly may be used for documentation](https://opensource.stackexchange.com/a/9545/5671)
* Good, because it is lean.

## Dual license with MIT and CC0
### Dual license with MIT and CC0

With the SPDX identifier `MIT OR CC0-1.0`, the receiver of the documents can decide which license thay want to use.

Expand Down
2 changes: 1 addition & 1 deletion docs/decisions/0012-use-curly-braces-to-denote-placeholder.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ Idea taken from <https://github.com/schubmat/DecisionCapture/blob/master/templat

### Use HTML comments

Example: `<!-- option 1 -->
Example: `<!-- option 1 -->`.

* Good, because feels "natural" in direct Markdown editing
* Bad, because it does not render in HTML
6 changes: 3 additions & 3 deletions docs/decisions/0013-use-yaml-front-matter-for-meta-data.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ Chosen option: "Use YAML front matter", because comes out best (see below).

## Pros and Cons of the Options

## Use YAML front matter
### Use YAML front matter

Example:

Expand All @@ -37,7 +37,7 @@ decision-makers:
date:
---

## Context and problem statement
### Context and problem statement

We want to record architectural decisions made in this project.
Which format and structure should these records follow?
Expand All @@ -54,7 +54,7 @@ Rendered output:
* Bad, because rendering not standardized
* Bad, because not all Markdown parsers can parse it

## Use plain Markdown everywhere
### Use plain Markdown everywhere

* Good, because all parsers can handle it
* Bad, because special markdown parsing tooling is needed
Expand Down