Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Closed
lhauspie opened this issue Mar 8, 2023 · 5 comments
Closed

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

lhauspie opened this issue Mar 8, 2023 · 5 comments

Comments

@lhauspie
Copy link

lhauspie commented Mar 8, 2023

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
Copy link
Author

lhauspie commented Mar 8, 2023

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
Copy link
Owner

Riduidel commented Mar 9, 2023

What happens if you open this url in your browser ?

@lhauspie-adeo
Copy link
Contributor

image

@lhauspie-adeo
Copy link
Contributor

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
Copy link
Owner

See #333 for error handling

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants