Riduidel / aadarchi

A maven archetype to generate easily projects allowing architecture description using a mix of C4, agile architecture, Asciidoc and PlantUML
https://riduidel.github.io/aadarchi/
Apache License 2.0
40 stars 12 forks source link

out-of-the-box diagrams are not in docs #328

Closed lhauspie closed 1 year ago

lhauspie commented 1 year ago
mvn archetype:generate -DarchetypeVersion=0.1.10 -DarchetypeGroupId=io.github.Riduidel.aadarchi -DarchetypeArtifactId=archetype

then

mvn clean package

But PDF or HTML do not contain diagrams:

image image

The content of context.adoc is the default one:

// This is an example diagram to show how to include a structurizr-generated diagram
[plantuml, {plantumldir}SystemContext, svg, opts="inline"]
----
include::{structurizrdir}/SystemContext.plantuml[]
----

Maybe a problem with plantumldir or structurizrdir ?


For information:

mvn -v
Apache Maven 3.9.0 (9b58d2bad23a66be161c4664ef21ce219c2c8584)
Maven home: /Users/lhauspie/.asdf/installs/maven/3.9.0
Java version: 11, vendor: Oracle Corporation, runtime: /Users/lhauspie/.asdf/installs/java/openjdk-11
Default locale: fr_FR, platform encoding: UTF-8
OS name: "mac os x", version: "10.16", arch: "x86_64", family: "mac"
lhauspie commented 1 year ago

I noticed that the image is not rendered but included as a kind of very long url to kroki that take one line on several pages:

image image
Riduidel commented 1 year ago

What happens if you open this url in your browser ?

lhauspie-adeo commented 1 year ago
image
lhauspie-adeo commented 1 year ago

I just retry and this time, the first SystemContext diagram is displaying well but not the System Containers.

image

To validate an hypothesis, I disabled my WiFi and as Kroki is unreachable no diagrams was displayed. It could be nice to fail the build in case of problem during the images generation via Kroki to avoid to release my documentation without any diagrams.

Riduidel commented 1 year ago

See #333 for error handling