Skip to content

Commit de6dbe8

Browse files
committed
adr-template adjustments described
1 parent 27fb4b4 commit de6dbe8

File tree

2 files changed

+25
-35
lines changed

2 files changed

+25
-35
lines changed

README.adoc

Lines changed: 6 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -40,46 +40,17 @@ For more tech inspiration take a look at the https://www.workingsoftware.dev/doc
4040
If you don't plan to use the https://github.com/npryce/adr-tools[adr-tools], you can skip this step. Please make sure that Chapter 09 Architecture Decisions does not contain any references to the ADRs.
4141
====
4242

43-
=== Migrate markdown based ADRs from adr-tools to AsciiDoc
43+
=== Install adr-tools and adjust the ADR template
4444

45-
Unfortunately, the adr-tools do not support AsciiDoc as a format for the ADRs. Therefore, you have to migrate the existing markdown based ADRs to AsciiDoc.
46-
47-
==== Install and configure adr-tools
45+
The ADR template is based on Markdown and the ADR chapters must be adapted to the chapter levels of the arc42 template.
4846

4947
. Install https://github.com/npryce/adr-tools[adr-tools]
50-
. Configure the adr template with the following header config
51-
52-
[source, bash]
53-
----
54-
adr config
55-
----
56-
57-
Replace the content of the `template.md` file with the following content:
58-
59-
[source, markdown]
60-
----
61-
### TITLE
62-
63-
Date: DATE
48+
. Get the path of the adr template of the adr-tools via `adr config`
49+
. Replace the content of the `template.md` file with the content of the link:./adr-template.adoc[adr-teplate.adoc] file of this repository.
6450

65-
#### Status
66-
67-
STATUS
68-
69-
#### Context
70-
71-
The issue motivating this decision, and any context that influences or constrains the decision.
72-
73-
#### Decision
74-
75-
The change that we're proposing or have agreed to implement.
76-
77-
#### Consequences
78-
79-
What becomes easier or more difficult to do and any risks introduced by the change that will need to be mitigated.
80-
----
51+
==== Migrate the generated markdown based decisions with docToolchain
8152

82-
==== Migrate the generated markdown based decisions with the docker-asciidoctor image under Linux
53+
If you have already generated ADRs with the adr-tools, you can migrate them to the AsciiDoc format with the following steps.
8354

8455
[source, bash]
8556
----

adr-template.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
### TITLE
2+
3+
Date: DATE
4+
5+
#### Status
6+
7+
STATUS
8+
9+
#### Context
10+
11+
The issue motivating this decision, and any context that influences or constrains the decision.
12+
13+
#### Decision
14+
15+
The change that we're proposing or have agreed to implement.
16+
17+
#### Consequences
18+
19+
What becomes easier or more difficult to do and any risks introduced by the change that will need to be mitigated.

0 commit comments

Comments
 (0)