You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+11-11Lines changed: 11 additions & 11 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -140,11 +140,11 @@ Here is a detailed list of the available `adr` commands:
140
140
141
141
`adr templates` - Manipulate ADR Templates & ADR Template Packages. Root command for template operations. Will list available sub-commands.
142
142
143
-
`adr templates default show` - Displays the detailed metadata of the current default ADR Template.
143
+
`adr templates show` - Displays the detailed metadata of the current default ADR Template.
144
144
145
-
`adr templates default show --id-only` - Displays the id of the current default ADR Template.
145
+
`adr templates show --id-only` - Displays the id of the current default ADR Template.
146
146
147
-
`adr templates default set <TEMPLATE ID>` - Sets the default ADR Template. The `<TEMPLATE ID>` can be obtained from `adr templates default show`
147
+
`adr templates set <TEMPLATE ID>` - Sets the default ADR Template. The `<TEMPLATE ID>` can be obtained from `adr templates show`
148
148
149
149
`adr templates list` - Displays a table containing the detailed metadata of all ADR Templates contained in the current default ADR Template Package.
150
150
@@ -208,7 +208,7 @@ ADR using the Alexandrian [Pattern Language Approach](https://en.wikipedia.org/w
208
208
209
209
Source [Joel Parker Henderson](https://github.com/joelparkerhenderson/architecture-decision-record/), see this [issue about licensing](https://github.com/joelparkerhenderson/architecture-decision-record/issues/30).
210
210
211
-
Set as the default template using `adr templates default set alexandrian`
211
+
Set as the default template using `adr templates set alexandrian`
212
212
213
213
#### Business Case Pattern
214
214
Emphasizes creating a business case for a decision, including criteria, candidates, and costs, [created by Joel Parker Henderson](https://github.com/joelparkerhenderson/architecture-decision-record/blob/main/templates/decision-record-template-for-business-case/index.md), which distils the decision record into the following headings:
@@ -226,7 +226,7 @@ Emphasizes creating a business case for a decision, including criteria, candidat
226
226
227
227
Source [Joel Parker Henderson](https://github.com/joelparkerhenderson/architecture-decision-record/), see this [issue about licensing](https://github.com/joelparkerhenderson/architecture-decision-record/issues/30).
228
228
229
-
Set as the default template using `adr templates default set business-case`
229
+
Set as the default template using `adr templates set business-case`
230
230
231
231
#### Markdown Architectural Decision Records (MADR)
232
232
Architectural Decisions using Markdown and Architectural Decision Records, by [Oliver Kopp](https://adr.github.io/madr/), which distils the decision record into the following headings:
@@ -246,7 +246,7 @@ Architectural Decisions using Markdown and Architectural Decision Records, by [O
246
246
247
247
[Available](https://adr.github.io/madr/) as dual-license under [MIT](https://opensource.org/licenses/MIT) and [CC0](https://creativecommons.org/share-your-work/public-domain/cc0/). You can choose between one of them if you use this work.
248
248
249
-
Set as the default template using `adr templates default set madr`
249
+
Set as the default template using `adr templates set madr`
250
250
251
251
#### Merson Pattern
252
252
An adaptation of the [Nygard pattern](#nygard-pattern), by [Paulo Merson](https://github.com/pmerson/ADR-template) which adds the rationale behind the decision. It distils the decision record into the following headings:
@@ -259,7 +259,7 @@ An adaptation of the [Nygard pattern](#nygard-pattern), by [Paulo Merson](https:
259
259
260
260
[Available](https://github.com/pmerson/ADR-template) under the [MIT License](https://github.com/pmerson/ADR-template/blob/master/LICENSE).
261
261
262
-
Set as the default template using `adr templates default set merson`
262
+
Set as the default template using `adr templates set merson`
263
263
264
264
#### Nygard Pattern
265
265
A simple, low-friction "Agile" ADR approach by [Michael Nygard](http://thinkrelevance.com/blog/2011/11/15/documenting-architecture-decisions), which distils the decision record into the following headings:
@@ -272,7 +272,7 @@ A simple, low-friction "Agile" ADR approach by [Michael Nygard](http://thinkrele
272
272
273
273
[Available](https://cognitect.com/blog/2011/11/15/documenting-architecture-decisions) under [CC0 1.0 Universal (CC0 1.0) Public Domain Dedication](https://creativecommons.org/publicdomain/zero/1.0/).
274
274
275
-
Set as the default template using `adr templates default set nygard`
275
+
Set as the default template using `adr templates set nygard`
276
276
277
277
#### Planguage Pattern
278
278
A Quality Assurance oriented approach by [John Terzakis](http://www.iaria.org/conferences2012/filesICCGI12/Tutorial%20Specifying%20Effective%20Non-func.pdf), which distils the decision record into the following headings:
@@ -295,7 +295,7 @@ A Quality Assurance oriented approach by [John Terzakis](http://www.iaria.org/co
295
295
296
296
Source [Joel Parker Henderson](https://github.com/joelparkerhenderson/architecture-decision-record/), see this [issue about licensing](https://github.com/joelparkerhenderson/architecture-decision-record/issues/30).
297
297
298
-
Set as the default template using `adr templates default set planguage`
298
+
Set as the default template using `adr templates set planguage`
299
299
300
300
#### Tyree and Akerman Pattern
301
301
ADR approach by [Jeff Tyree and Art Akerman](https://personal.utdallas.edu/~chung/SA/zz-Impreso-architecture_decisions-tyree-05.pdf), Capital One Financial, which distils the decision record into the following headings:
@@ -318,7 +318,7 @@ ADR approach by [Jeff Tyree and Art Akerman](https://personal.utdallas.edu/~chun
318
318
319
319
Source [Joel Parker Henderson](https://github.com/joelparkerhenderson/architecture-decision-record/), see this [issue about licensing](https://github.com/joelparkerhenderson/architecture-decision-record/issues/30).
320
320
321
-
Set as the default template using `adr templates default set tyree-ackerman`
321
+
Set as the default template using `adr templates set tyree-ackerman`
322
322
323
323
### ADR Templates and ADR Template Packages
324
324
@@ -400,7 +400,7 @@ To see the currently set default package, use:
400
400
401
401
To see the id of the currently set default template, use:
402
402
403
-
`adr templates default show`
403
+
`adr templates show`
404
404
405
405
To revert to the "official" ADT Template Package you can either, reset the environment:
Copy file name to clipboardExpand all lines: Solutions/Endjin.Adr.Templates/NuGet.Readme.md
+7-7Lines changed: 7 additions & 7 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -24,7 +24,7 @@ ADR using the Alexandrian [Pattern Language Approach](https://en.wikipedia.org/w
24
24
25
25
Source [Joel Parker Henderson](https://github.com/joelparkerhenderson/architecture-decision-record/), see this [issue about licensing](https://github.com/joelparkerhenderson/architecture-decision-record/issues/30).
26
26
27
-
Set as the default template using `adr templates default set alexandrian`
27
+
Set as the default template using `adr templates set alexandrian`
28
28
29
29
#### Business Case Pattern
30
30
Emphasizes creating a business case for a decision, including criteria, candidates, and costs, [created by Joel Parker Henderson](https://github.com/joelparkerhenderson/architecture-decision-record/blob/main/templates/decision-record-template-for-business-case/index.md), which distils the decision record into the following headings:
@@ -42,7 +42,7 @@ Emphasizes creating a business case for a decision, including criteria, candidat
42
42
43
43
Source [Joel Parker Henderson](https://github.com/joelparkerhenderson/architecture-decision-record/), see this [issue about licensing](https://github.com/joelparkerhenderson/architecture-decision-record/issues/30).
44
44
45
-
Set as the default template using `adr templates default set business-case`
45
+
Set as the default template using `adr templates set business-case`
46
46
47
47
#### Markdown Architectural Decision Records (MADR)
48
48
Architectural Decisions using Markdown and Architectural Decision Records, by [Oliver Kopp](https://adr.github.io/madr/), which distils the decision record into the following headings:
@@ -62,7 +62,7 @@ Architectural Decisions using Markdown and Architectural Decision Records, by [O
62
62
63
63
[Available](https://adr.github.io/madr/) as dual-license under [MIT](https://opensource.org/licenses/MIT) and [CC0](https://creativecommons.org/share-your-work/public-domain/cc0/). You can choose between one of them if you use this work.
64
64
65
-
Set as the default template using `adr templates default set madr`
65
+
Set as the default template using `adr templates set madr`
66
66
67
67
#### Merson Pattern
68
68
An adaptation of the [Nygard pattern](#nygard-pattern), by [Paulo Merson](https://github.com/pmerson/ADR-template) which adds the rationale behind the decision. It distils the decision record into the following headings:
@@ -75,7 +75,7 @@ An adaptation of the [Nygard pattern](#nygard-pattern), by [Paulo Merson](https:
75
75
76
76
[Available](https://github.com/pmerson/ADR-template) under the [MIT License](https://github.com/pmerson/ADR-template/blob/master/LICENSE).
77
77
78
-
Set as the default template using `adr templates default set merson`
78
+
Set as the default template using `adr templates set merson`
79
79
80
80
#### Nygard Pattern
81
81
A simple, low-friction "Agile" ADR approach by [Michael Nygard](http://thinkrelevance.com/blog/2011/11/15/documenting-architecture-decisions), which distils the decision record into the following headings:
@@ -88,7 +88,7 @@ A simple, low-friction "Agile" ADR approach by [Michael Nygard](http://thinkrele
88
88
89
89
[Available](https://cognitect.com/blog/2011/11/15/documenting-architecture-decisions) under [CC0 1.0 Universal (CC0 1.0) Public Domain Dedication](https://creativecommons.org/publicdomain/zero/1.0/).
90
90
91
-
Set as the default template using `adr templates default set nygard`
91
+
Set as the default template using `adr templates set nygard`
92
92
93
93
#### Planguage Pattern
94
94
A Quality Assurance oriented approach by [John Terzakis](http://www.iaria.org/conferences2012/filesICCGI12/Tutorial%20Specifying%20Effective%20Non-func.pdf), which distils the decision record into the following headings:
@@ -111,7 +111,7 @@ A Quality Assurance oriented approach by [John Terzakis](http://www.iaria.org/co
111
111
112
112
Source [Joel Parker Henderson](https://github.com/joelparkerhenderson/architecture-decision-record/), see this [issue about licensing](https://github.com/joelparkerhenderson/architecture-decision-record/issues/30).
113
113
114
-
Set as the default template using `adr templates default set planguage`
114
+
Set as the default template using `adr templates set planguage`
115
115
116
116
#### Tyree and Akerman Pattern
117
117
ADR approach by [Jeff Tyree and Art Akerman](https://personal.utdallas.edu/~chung/SA/zz-Impreso-architecture_decisions-tyree-05.pdf), Capital One Financial, which distils the decision record into the following headings:
@@ -134,7 +134,7 @@ ADR approach by [Jeff Tyree and Art Akerman](https://personal.utdallas.edu/~chun
134
134
135
135
Source [Joel Parker Henderson](https://github.com/joelparkerhenderson/architecture-decision-record/), see this [issue about licensing](https://github.com/joelparkerhenderson/architecture-decision-record/issues/30).
136
136
137
-
Set as the default template using `adr templates default set tyree-ackerman`
137
+
Set as the default template using `adr templates set tyree-ackerman`
0 commit comments