antora playbook

Antora Playbook

Table of Contents

• Our Playbook Files
• What is an Antora Playbook?

Our Playbook Files

We use two files to configure our products (SUMA or Uyuni):

• suma-site.yml

• uyuni-site.yml

These are called antora playbook files. For more information see Antora playbook files.

To produce an output for either SUMA or Uyuni you will call one of these two files using our Makefile for example:

make antora-suma

make antora-uyuni

What is an Antora Playbook?

Content modified from antora.org

The Antora playbooks make it easy for us as writers to control what content is included in our site, what user interface (UI) is applied to it, and where the site is published.

Our playbooks (suma-site.yml, uyuni-site.yml) tell antora:

• What information should be applied to the site globally, such as which title and base URL’s to use

• Which page acts as the ROOT of our site, specifically our index-suma.adoc or index-uyuni.adoc page

• Which content repositories, branches, or tags to feed to Antora. master branch

• Which AsciiDoc document attributes (our SUSE entities) should be applied site wide (globally to the content catalog).

• Which UI bundle to use to control the visual layout, style, and behavior of the pages. susecom, gh-pages, webui, and uyuni site themes

• Where the site should be published and in what format.

• How and when Antora should handle source repository updates, artifact updates, and its cache.