• In the guide repository to be published, create antora files:

doc
├── antora.yml
└── modules
    └── ROOT
        └── pages
            └── index.adoc

This files can be in a separate branch or located in a different root directory. In this case, they need to be specified in antora-playbook.yml. But doc directory and master branch are the standards for the guides.

• In home/modules/ROOT/pages/index.adoc, include the new guide:

[.guide]
=== xref:<new-guide>:ROOT:index.adoc[New Guide Header]

This is a brand new guide explanation.

<new-guide> tag here is the one that you specify in the antora.yml at the first step.

• In antora-playbook.yml, include the new guide's repository:

- url: https://github.com/hazelcast-guides/new-guide-repository
  branches: antora-doc-branch
  start_path: antora-root-dir

• Create new docs:

$ sh create.sh

If no error is encountered, you will see the following log at the end:

New site root is created at docs/index.html

• Check if your guide is added successfully:

$ open docs/index.html

Push if everything looks good and it will be published on the website in a while.