building documentation

Building Documentation

Table of Contents

• Introduction
• Building a Foundation

Introduction

ℹ️	This page is in progress. It will be divided up into documents soon. Keep an eye on it!

Assumptions

• You have setup our toolchain

• You have cloned the doc-susemanager repository

From this page you will find resources for building all of our outputs. You will also find our antora quickstart guide for understanding the build process. You will also find a troubleshooting guide for common gotchas when working with antora or our toolchain.

Building a Foundation

1. Intro to our Antora Playbooks - (suma-site.yml, uyuni-site.yml)

2. Intro to our Component Descriptor - (antora.yml)

3. Building and Publishing SUMA Documentation - (Antora, PDF, OBS, Publishing)

4. Building and Publishing UYUNI Documentation - (Antora, PDF, OBS, Publishing)