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

Find out how to use/include an adoc document in different repositories #16

Open
zrgt opened this issue Apr 4, 2024 · 1 comment
Open
Assignees

Comments

@zrgt
Copy link
Contributor

zrgt commented Apr 4, 2024

There are some parts in documents which are the same (e.g. "Terms, Definitions and Abbreviations"). The question is: how we can create and maintain these parts in one single repo and use it across all documents. Please find out.

@monsieuremre
Copy link
Collaborator

Possible to link. So it should be possible to include as well. This may bring about other issues tho.

If the preamble section is included from another module, then when viewing the documentation repository on its own, on not the final complete website, this include would not resolve, since the module on its own cannot access other modules when not compiled as a part of a bigger site.

So including parts would mean: single parts cannot be converted to html and pdf files on their own.

I also do not see much benefit that would outweight these small problems. Also, implementation may actually be not that straightforward.

But if we were to insist on going this path, I would suggest we create a new module that would host the shared content.

Please Note: Referencing is trivial, but including might not be that trivial. It was just my initial guess that it should be similar.

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

2 participants