Releasing a new documentation version

This guide is directed at internal contributors, as an external contributor, you cannot release a new documentation version.

Whenever there is a new Stackable Data Platform release, the documentation is also released with a new version. This process has been automated with scripts, which are found in the scripts directory of the documentation repository.

The process consists of two steps:

  1. Making a new release branch (make-release-branch.sh).

  2. Publishing the new version by modifying the playbooks (publish-new-version.sh).

Consult the scripts for details about the required steps, as well as prerequisites. Furthermore the troubleshooting page can be helpful to understand and fix Antora build errors.