This repository contains the playbook project for the Antora documentation site published at docs.antora.org.
The documentation components are pulled from the Antora and Antora Default UI repositories. The site uses the Antora Default UI to generate its UI (i.e., the web pages).
To generate the Antora Docs site, you first need to install Antora.
Once Antora is installed, run the antora command on the playbook file hosted in this repository.
$ antora antora-playbook.yml
The site will be generated into public/. Navigate to public/index.html in your browser to view the site offline.
This site is hosted on Netlify. It is managed by the account info [at] this domain.
Deployment is triggered via a webhook on the master branch of the git repository (URL: api.netlify.com/hooks/gitlab, events: Push Events, Merge Requests Events).
The deploy job on Netlify is configured by the file netlify.toml.
This configuration files defines certain environment variables that control the behavior of Yarn and Antora.
When the job runs, it switches to the netlify/ directory, runs yarn, then invokes antora.
The Netlify deploy logs for antora.org can be viewed at app.netlify.com/sites/antora-docs/deploys.
The site is also built nightly on GitLab CI.
Not only does this allow the site to be updated on a schedule, it also allows us to test the Antora Docker image.
The nightly CI job, which is configured in the file .gitlab-ci.yml, generates the site using Antora then deploys it to Netlify using the Netlify CLI (command: netlify).
The secret variables required for deploying to Netlify (NETLIFY_SITE_ID and NETLIFY_ACCESS_TOKEN) are defined on the scheduled job configuration page.
The domain name for this site is configured using the following A record:
docs 3600 IN A 104.198.14.52
The certificate for this site was generated by Let’s Encrypt and is shared with the certificate for antora.org. See the antora.org README for details about how it was generated and configured.
The TLS certificate for docs.antora.org was issued by Netlify using Let’s Encrypt and is automatically renewed.
Verify the certificate is valid using:
$ curl -vI https://docs.antora.org
Look for CN=docs.antora.org under the “Server certificate” section.
Netlify redirects all traffic to HTTPS automatically (i.e., it forces HTTPS).
Copyright © 2017-2019 OpenDevise Inc. and individual contributors to docs.antora.org.
Except where otherwise noted, docs.antora.org, Antora, and the Antora UI, are licensed under the Mozilla Public License Version 2.0 (MPL-2.0). See LICENSE to view the full license text.