Skip to content

Commit

Permalink
adr-template adjustments described
Browse files Browse the repository at this point in the history
  • Loading branch information
bitsmuggler committed Jan 13, 2025
1 parent 27fb4b4 commit de6dbe8
Show file tree
Hide file tree
Showing 2 changed files with 25 additions and 35 deletions.
41 changes: 6 additions & 35 deletions README.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -40,46 +40,17 @@ For more tech inspiration take a look at the https://www.workingsoftware.dev/doc
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.
====

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

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.

==== Install and configure adr-tools
The ADR template is based on Markdown and the ADR chapters must be adapted to the chapter levels of the arc42 template.

. Install https://github.com/npryce/adr-tools[adr-tools]
. Configure the adr template with the following header config

[source, bash]
----
adr config
----

Replace the content of the `template.md` file with the following content:

[source, markdown]
----
### TITLE
Date: DATE
. Get the path of the adr template of the adr-tools via `adr config`
. Replace the content of the `template.md` file with the content of the link:./adr-template.adoc[adr-teplate.adoc] file of this repository.

#### Status
STATUS
#### Context
The issue motivating this decision, and any context that influences or constrains the decision.
#### Decision
The change that we're proposing or have agreed to implement.
#### Consequences
What becomes easier or more difficult to do and any risks introduced by the change that will need to be mitigated.
----
==== Migrate the generated markdown based decisions with docToolchain

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

[source, bash]
----
Expand Down
19 changes: 19 additions & 0 deletions adr-template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
### TITLE

Date: DATE

#### Status

STATUS

#### Context

The issue motivating this decision, and any context that influences or constrains the decision.

#### Decision

The change that we're proposing or have agreed to implement.

#### Consequences

What becomes easier or more difficult to do and any risks introduced by the change that will need to be mitigated.

0 comments on commit de6dbe8

Please sign in to comment.