docs-fp-o-ci-test/build-scripts

Building the docs

This script is used in OpenShift to rebuild the whole site for Fedora.

Local testing

Test the build locally using podman.

First, make sure your in the right directory — it's the same one that has this README.md file. Then build the container on your system:

$ podman build --no-cache -t fedora-docs-openshift-rebuild . 

And then run it:

$ mkdir output
$ podman run --rm -it -e "BUILD_ENV=stg" -v $(pwd)/output:/antora/output fedora-docs-openshift-rebuild

The output will be saved in ./output/.

Changing configuration

You can also set different environment variables by setting -e "VAR_NAME=value" in the podman run command. See a list of supported variables below.

# The script requires the following environment variables to be set:
# 
# Variable          Values      Effect
# -----------------|-----------------------------------------------------------
# BUILD_ENV         prod        Build the production version of the site
#                               using the "prod" branch. DEFAULT
#                   stg         Build the staging version of the site
#                               using the "stg" branch.
# -----------------|-----------------------------------------------------------
# BUILD_LANGS       english     Build the "en-US" version only. DEFAULT
#                   translated  Build only the translated versions.
#                   all         Build the "en-US" and the translated versions.

Please note that rebuilding all the languages locally will take many hours and results in gigabytes of output.