Converted ADRs to Markdown #397
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
fuhrmeistery
approved these changes
May 3, 2021
Weltraumschaf
added
architecture
The supersedes had an errornous | which resulted in bad rendered table. I used parens for the supersed marker. Signed-off-by: Sven Strittmatter <sven.strittmatter@iteratec.com>
Signed-off-by: Sven Strittmatter <sven.strittmatter@iteratec.com>
We want to use the ADRs in our documentation project, but this
does not support Asciidoc. So we decided to convert them.
Initial convertion is done w/ Pandoc:
```
for i in {0..7}; do \
asciidoc -b docbook "adr_000${i}.adoc" \
pandoc -f docbook -t markdown_strict "adr_000${i}.xml" -o "adr_000${i}.md" \
rm "adr_000${i}.xml" \
done
```
There were some syntax errors afterwards which were fixed manually.
The linebreaks of paragraphs were removed consequntly because we use
linewrap in the editors.
Signed-off-by: Sven Strittmatter <sven.strittmatter@iteratec.com>
rseedorff
approved these changes
May 4, 2021
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
We convert the ADRs to Markdown so we can include them into our doc project.