uyuni community project docs

Building Uyuni Community Documentation

Table of Contents

• Building UYUNI Community Documentation
  • Requirements for building
  • Verify WebUI playbook file attributes
  • Build the Static HTML from source
  • Preparing the release PR for the gh-pages branch

Building UYUNI Community Documentation

WORK IN PROGRESS

Requirements for building

• Our documentation tool chain should be installed. See: Toolchain Installation

Verify WebUI playbook file attributes

1. From your local git checkout of uyuni-docs in parameters.yml verify that the default value for site.url is enabled for uyuni-project.org.

   site:
         - attribute: title
           value: "Uyuni Documentation"
         - attribute: start_page
           value: "uyuni::index"
         - attribute: url
           value: https://www.uyuni-project.org/uyuni-docs/

2. Check the Uyuni version number in the parameters.yml. This should be adjusted to the release version.

       asciidoc:
         - attribute: productname
           value: "Uyuni"
         - attribute: productnumber
           value: "2023.12"
         - attribute: docversion
           value: "2023.12"
         - attribute: minorversion
           value: "2023.12"

3. Check the following attributes in the parameters.yml ensuring the file version numbers are correct. These numbers can be found in the OBS package spec files. For example: salt.spec. Feel free to ping release engineers for further clarification.

   asciidoc:
     - attribute: opensuse-version
       value: 15.5
     - attribute: saltversion
       value: 3006.0
     - attribute: postgresql
       value: PostgreSQL
     - attribute: postgresql-version
       value: 14
     - attribute: sles-version
       value: 15
     - attribute:  sp-version
       value: SP5 #use for normal text
     - attribute: sp-vert
       value: sp5 #use for terminal block
     - attribute: sp-version-l
       value: sp5

Build the Static HTML from source

1. Build the Static HTML. From the local checkout directory on the command line run:

   example

   make clean
   make configure-uyuni
   make antora-uyuni

Preparing the release PR for the gh-pages branch

1. Backup your new build:

   example

   cp -r build/ ../uyuni-2023.12