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

Implemented enhancement files empty + invalid path #99

Open
Bullfrog666 opened this issue Mar 9, 2022 · 2 comments
Open

Implemented enhancement files empty + invalid path #99

Bullfrog666 opened this issue Mar 9, 2022 · 2 comments
Labels
effort: 1 priority: now state: approved Approved to proceed. type: docs Related to documentation and information. work: obvious The situation is obvious, best practices used.

Comments

@Bullfrog666
Copy link
Collaborator

Bullfrog666 commented Mar 9, 2022

The enhancement .adoc files in Target/structurizr/enhancement seems to be empty, is it normal and what is these files purpous.
+
.adoc files in src/docs/asciidoc/ include enhancers content with the line :
include::{enhancements-dir}/_10-deployment.adoc[leveloffset=+1]

But "{enhancements-dir}" seems not found (even if defined in the pom.xml) witch leads us to this error when rendering the .adoc file :
Unresolved directive in 10-deployment.adoc - include::{enhancements-dir}/_10-deployment.adoc[leveloffset=+1]

@Riduidel
Copy link
Owner

It is not found in IDE because we don't set an enhancements-dir default value in fil header.
This can be fixed by adding the following line as file header

:enhancements-dir: ${A_PATH_TO_DETERMINE}

@Riduidel Riduidel added the bug label Jun 20, 2022
@Riduidel Riduidel removed the bug label Jun 28, 2024
@Riduidel Riduidel changed the title Implemented enhancement files emmpty + invalid path Implemented enhancement files empty + invalid path Jun 28, 2024
@Riduidel Riduidel added effort: 1 priority: now work: obvious The situation is obvious, best practices used. state: approved Approved to proceed. type: docs Related to documentation and information. labels Jun 28, 2024
@Riduidel
Copy link
Owner

This one is a misunderstanding that should be solved by adding the correct comments in the various .adoc files, maybe even a link to this issue.

To make things clear, most of the technical job of aadarchi is to create some asciidoc files in target/structurizr/enhancements directory. But to have those files included in documentation, we must have some "hook code". And those includes are the mentionned hook code.

So the work to do is: in each .adoc file of the archetype maven module (see in ̀src\docs\asciidoc`), add the following comment

There is no reaseon for the file included below to exist, since it is created by aadarchi execution.
If you see an error in your IDE, don't worry, the maven build will have the correct paths set.
See #99 for more details

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
effort: 1 priority: now state: approved Approved to proceed. type: docs Related to documentation and information. work: obvious The situation is obvious, best practices used.
Projects
None yet
Development

No branches or pull requests

2 participants