Merge pull request #643 from stackhpc/zed-upgrade-docs

docs: Add upgrading page

Author: markgoddard

doc/requirements.txt

@@ -5,3 +5,4 @@
 reno>=3.4.0 # Apache-2.0
 sphinx>=4.2.0 # BSD
 sphinxcontrib-svg2pdfconverter>=0.1.0 # BSD
+Sphinx-Substitution-Extensions # Apache-2.0

doc/source/conf.py

@@ -29,16 +29,19 @@
 # -- StackHPC Kayobe configuration --------------------------------------
 # Variables to override
 
+previous_series = "yoga"
 current_series = "zed"
 branch = f"stackhpc/{current_series}"
 
 # Substitutions loader
-rst_epilog = """
+rst_prolog = """
 .. |current_release| replace:: {current_release}
 .. |current_release_git_branch_name| replace:: {current_release_git_branch_name}
+.. |previous_release| replace:: {previous_release}
 """.format(  # noqa: E501
     current_release_git_branch_name=branch,
     current_release=current_series,
+    previous_release=previous_series,
 )
 
 # -- General configuration ----------------------------------------------------
@@ -51,6 +54,7 @@
     'sphinx.ext.extlinks',
     #'sphinx.ext.intersphinx',
     'sphinxcontrib.rsvgconverter',
+    'sphinx_substitution_extensions',
 ]
 
 # autodoc generation is a bit aggressive and a nuisance when doing heavy
@@ -118,3 +122,6 @@
     f"{project}-doc": (f"https://docs.openstack.org/{project}/{current_series}/", "%s documentation")
     for project in extlinks_projects
 }
+extlinks["skc-doc"] = (f"https://stackhpc-kayobe-config.readthedocs.io/en/stackhpc-{current_series}/", "%s documentation")
+extlinks["kayobe-renos"] = (f"https://docs.openstack.org/releasenotes/kayobe/{current_series}.html", "%s release notes")
+extlinks["kolla-ansible-renos"] = (f"https://docs.openstack.org/releasenotes/kolla-ansible/{current_series}.html", "%s release notes")

doc/source/configuration/wazuh.rst

@@ -302,6 +302,8 @@ Encrypt the keys (and remember to commit to git):
 
 ``ansible-vault encrypt --vault-password-file ~/vault.pass $KAYOBE_CONFIG_PATH/ansible/wazuh/certificates/certs/*.key``
 
+.. _wazuh-verification:
+
 Verification
 ------------
 

doc/source/operations/index.rst

@@ -7,6 +7,7 @@ This guide is for operators of the StackHPC Kayobe configuration project.
 .. toctree::
    :maxdepth: 1
 
+   upgrading
    rabbitmq
    octavia
    hotfix-playbook