Automatically include documentation from an existing repository
This can actually be achieved if the files are in the asciidoc format (*.adoc). These files are recognized by gitlab, so they are properly rendered, apart from antora/asciidoc internal references. One way would be following structure
README.adoc
docs/antora.yaml
docs/modules/ROOT/nav.adoc
docs/modules/ROOT/pages/index.adoc -> ../../../README.adoc
The README.adoc
would be there for users to have a quick look at the top level. Here the symlinks goes one way, but it could also the other way around. Under pages/
there could be multiple documents that are referenced by the nav.adoc
file (the navigation menu).
The playbook would have to be updated to include a new content source:
content:
sources:
- url: ./
start-path: docs
branches: HEAD
- url: https://gitlab.cern.ch/atlas-tdaq-software/swrod.git
start-path: docs
branches: HEAD
This is how antora merges content from many different sources.