To provide a way of building a container image to build the Uyuni documentation, as it requires to install a big set of tools using zypper, nvm, cpan, gem etc.

Besides the container, a helper is provider so people that does not know anything about containers can easily use them.

This a result of SUSE's Hack Week 22

• uyuni-docs-helper: The bash script that allows any contributor to build, inspect the outputs of the build procedure via HTTP and even get outputs at the local system.

./uyuni-docs-helper -r master -o /tmp/test -c obs-packages-suma-en -p suma would build the HTML and PDFs for English language, from the master branch at https://github.com/uyuni-project/uyuni-docs (default repository), for SUSE Manager.

• image directory: Contains the Dockerfile, the startup.sh script for the container, and the build-and-publish helper (that can be used to build and publish the container after changing whatever is needed on the other two files, passing arguments to the build, such as --no-cache is allowed).

• Have podman installed (recommended)

or

• Have docker installed and an alias podman that calls docker (for bash that means adding alias docker='podman' to the file ~/.alias)

For publishing the image, you will need a Docker Hub account, and then talk to Julio González Gil to get added as maintainer at the Docker Hub.

We plan to move the images to GitHub packages in the future.

See TROUBLESHOOTING.md