This repository has been archived by the owner on Apr 12, 2022. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 34
building documentation
Joseph Cayouette edited this page Aug 13, 2019
·
21 revisions
Table of Contents
ℹ️
|
These pages are in progress. Keep an eye on them! |
From this page you will find an overview of our build process and resources for building and publishing our outputs.
- Starting Assumptions
-
-
You have setup our toolchain
-
You have cloned the doc-susemanager repository (master branch)
-
-
Our Antora Playbooks - (suma-site.yml, uyuni-site.yml)
-
Our Component Descriptor - (antora.yml)
-
Building and Publishing SUMA Documentation - (Antora, PDF, OBS, API, Publishing)
-
Building and Publishing UYUNI Documentation - (Antora, PDF, OBS, API, Publishing)
Setup and Build
- Setup rbenv and Ruby
- Install nvm
- Install Antora
- Install Asciidoctor Gems
- Building the Docs
- Optional Tools
How to Publish
Publish to OBS
Publish Enterprise Docs
Publishing to Github Pages
Want to Help?
Get Started with Asciidoc
Quick Syntax Reference
Asciidoctor Writer's Guide
Asciidoctor User's Manual
Resources
YAML Documentation