search

structurizr / structurizr.github.io

Structurizr documentation
https://structurizr.github.io/
MIT License
17 stars 12 forks source link

Can ADRs be written in AsciiDoc format? #7

Closed synclpz closed 10 months ago

synclpz commented 10 months ago

Description

At the moment of issue creation the file https://github.com/structurizr/structurizr.github.io/blob/b59cba34418cb2298ed0e9b8b5e52b3c9de4b0fb/ui/decisions/index.md contains line

In Structurizr, each ADR has an ID, title, date and status (e.g. "Proposed", "Accepted", "Superseded", etc), along with unstructured content written using Markdown or AsciiDoc. ADRs can either be created manually, or imported from tools like [adr-tools](https://github.com/npryce/adr-tools).

This line should be changed to

In Structurizr, each ADR has an ID, title, date and status (e.g. "Proposed", "Accepted", "Superseded", etc), along with unstructured content written using Markdown. ADRs can either be created manually, or imported from tools like [adr-tools](https://github.com/npryce/adr-tools).

According to https://github.com/structurizr/structurizr.github.io/blob/main/dsl/adrs.md and source for parser https://github.com/structurizr/import/blob/595fa3dfe26dc38803b1adcb0caf4052762e0fc6/src/main/java/com/structurizr/importer/documentation/AdrToolsDecisionImporter.java the only way is to use .md

Steps to reproduce

Open doc at https://github.com/structurizr/structurizr.github.io/blob/b59cba34418cb2298ed0e9b8b5e52b3c9de4b0fb/ui/decisions/index.md or https://docs.structurizr.com/ui/decisions/.

Screenshot

No response

Code sample

No response

Configuration

No response

Severity

Minor

Priority

I have no budget and there's no rush, please fix this for free

More information

No response

synclpz commented 10 months ago

BTW adrs doc also has a reference to AsciiDoc support at https://github.com/structurizr/structurizr.github.io/blob/b59cba34418cb2298ed0e9b8b5e52b3c9de4b0fb/dsl/adrs.md#L11C44-L11C44

simonbrowndotje commented 10 months ago

AsciiDoc decisions can be rendered by the Structurizr UI:

Screenshot 2023-12-22 at 23 16 54 Screenshot 2023-12-22 at 23 17 07

As it says at https://docs.structurizr.com/dsl/adrs:

The above behaviour can be customised by specifying the fully qualified class name of your own implementation of DocumentationImporter, which needs to be on the DSL classpath or installed as a JAR file in the plugins directory next to your DSL file.

As far as I'm aware though, nobody has yet written (or released publicly) an importer for AsciiDoc ADRs.