Starting an Antora project compatible with modular documentation

Starting an Antora project compatible with Modular Documentation.

Prerequisites

Docker or Podman.

Procedure

Create a repository by using the Antora for Modular Docs repository template and clone the repository to your local environment, or download the Antora for Modular Docs zip archive, and use the content of this archive to start a repository. The repository has user documentation and configuration files to:
- Build the documentation with Antora
- Validate internal and external links with htmltest
- Validate language changes with Vale and the Red Hat style
- Publish a preview
- Edit and build the documentation on Eclipse Che hosted by Red Hat
- Automate workflows and publish on GitHub
Edit at least the title field in antora.yml. See What’s antora.yml? - Antora documentation.
Edit at least the title, url, edit_url, output.destination.path fields in antora-playbook.yml. output.destination.path must match the <location> in the url (https://<FQDN>/<location>). See Set up a playbook - Antora documentation.
Edit the repository URL in the supplemental-ui/partials/header-content.hbs file and in the IgnoreURLs list in the .htmltest.yml file.
Run the preview on a local environment and verify the output on the preview server: http://0.0.0.0:4000.
```
./tools/runnerpreview.sh
```
Create an initial commit containing the result and publish to your remote Git repository.
To publish the docs by using GitHub pages, enable GitHub Pages in the remote repository configuration: choose gh-pages as source branch, and root as source directory.
To publish the build result for the pull requests, create a Surge token and set the SURGE_TOKEN environment variable in the remote Git repository secrets (Settings > Secrets > Actions).
```
$ npx -y surge token
```

Verification

Run preview on a local environment
```
./tools/runnerpreview.sh
```
Navigate to the remote Git repository and watch for the changes in the Actions and Pages.

Additional resources