building uyuni docs
-
From your local git checkout run the following command to see all available build options:
make help
-
To build the Uyuni static HTML pages and PDF documents run:
make antora-uyuni
To see which Uyuni build targets are available for PDF run the following command from your doc-susemanager checkout:
make help
The following guides are currently available.
|
💡
|
If you are having troubles building a guide, check the antora.yml file to ensure a book is not commented out. For example architecture. (This book is not actively published.) |
Run make with one of the following build targets to build a single book.
| Command | Output |
|---|---|
make pdf-install-uyuni |
Uyuni Installation Guide |
make pdf-client-config-uyuni |
Uyuni Client Configuration Guide |
make pdf-upgrade-uyuni |
Uyuni Upgrade Guide |
make pdf-reference-uyuni |
Uyuni Reference Manual |
make pdf-administration-uyuni |
Uyuni Administration Guide |
make pdf-salt-uyuni |
Uyuni Salt Guide |
make pdf-retail-uyuni |
Uyuni Retail Guide |
make pdf-architecture-uyuni |
Uyuni Architecture Guide |
Run make with the following build target to build the Uyuni PDF collection. Keep in mind that by default when building with make antora-uyuni the entire PDF collection is built automatically.
-
make pdf-all-uyuniBuild the Uyuni PDF Collection
- Starting Assumptions
-
You have the SUSE OBS tools setup on your local machine and you have an account at build.opensuse.org
For more information on setting up OBS see OBS Tutorial.
-
From your local git checkout of doc-susemanager check your uyuni-site.yml file. Ensure the following values are set.
# Doc site [title, and start page] site: title: Uyuni Documentation start_page: uyuni::index-uyuni url: https://www.uyuni-project.org/uyuni-docs
-
Under the content.sources key comment out the local key, you want to build from the remote:
content: sources: # Uncomment to build from your local git clone #- url: . # Uncomment to build from the remote github repository. - url: https://github.com/SUSE/doc-susemanager.git # To build locally ensure you have your current local branch listed. branches: - 'master'
-
Select the correct ui.bundle key and ui.supplemental_files key. For example when building for OBS you would set the following :
# Choose a default-ui to use # - uyuni-default.zip (product branding theme OBS) # - uyuni-primary.zip (do not use, will release with uyuni landing page) ui: bundle: url: ./branding/default-ui/uyuni/uyuni-primary.zip snapshot: true # - uyuni-depreciated (use for now) # - uyuni-webui (for gh-pages and WebUI will release with uyuni landing page) supplemental_files: ./branding/supplemental-ui/uyuni/uyuni-webui
-
Build the OBS packages:
make obs-packages-uyuni
-
Now that you have the packages built configure your environment variables for OBS on the CLI:
OBS_USER=keichwa OBS_USER=jcayouette OBS_USER=lbrindley
-
Add the target repo, in almost all cases this will be Master:
Add for Master: OBS_REPO=systemsmanagement:Uyuni:Master
-
Checkout the docs package from OBS (usually I check it out into my doc-susemanager/build folder as it is cleaned up anyway on a new build):
osc -A https://api.opensuse.org bco $OBS_REPO uyuni-docs_en
-
Copy the two new packages located in build/packages into build/home:$OBS_USER:branches:$OBS_REPO/uyuni-docs_en
-
Change into the OBS checkout dir:
cd home:$OBS_USER:branches:$OBS_REPO/uyuni-docs_en
-
Make a new version change before checkin. You need to have the exact same changes in two files:
uyuni-docs_en.changes uyuni-doc-indexes.changes
I usually make the changes to one then copy them to the other file. They must have the same timestamps see the examples below:
osc vc uyuni-docs_en.changes
uyuni-docs_en.changes------------------------------------------------------------------- Wed Jun 19 15:16:07 UTC 2019 - Joseph Cayouette <[email protected]> - Updated wording for prometheus section - Jeos VM update - Port 8050 for graphical console display - Content life-cycle docs are not enough for customer to understand (bsc#1137955) - Salt boot formula fails for SLES11 SP3 terminal (bsc#1136857) - Certificate verify failed when using vmware esxi virtual host gatherer (bsc#1136561) -------------------------------------------------------------------
Make an exact copy of your changes above including white space and add them to the doc indexes.
osc vc uyuni-doc-indexes.changes
uyuni-doc-indexes.changes------------------------------------------------------------------- Wed Jun 19 15:16:07 UTC 2019 - Joseph Cayouette <[email protected]> - Updated wording for prometheus section - Jeos VM update - Port 8050 for graphical console display - Content life-cycle docs are not enough for customer to understand (bsc#1137955) - Salt boot formula fails for SLES11 SP3 terminal (bsc#1136857) - Certificate verify failed when using vmware esxi virtual host gatherer (bsc#1136561) -------------------------------------------------------------------
-
Checkin the changes:
osc ci -m "update"
-
You can check the build results in your home project; e.g. with:
osc pr
-
Once you are certain doc packages are building properly on OBS submit an service request to Julio (If everything looks good he will accept and the docs will be included in the new RPM’s.):
osc sr -m 'update'
This completes publishing on OBS.