openstack/kolla-ansible
Code Issues Proposed changes

Fix links in docs for unmaintained releases

Browse Source 
Links in docs for unmaintained branches (Yoga and Zed) are still
pointing to stable/<release> branches in repository. Instead they
should point to unmaintained/<release>. This patch aims to fix that.

Closes-Bug: #2066052

Change-Id: I7e30ee5754ca2ecf9d4a2d3519f9e0bdf3f0aeea
This commit is contained in:
Grzegorz Bialas 2024-08-23 15:36:14 +02:00
parent ab4a79d552
commit c0ce3802ab
1 changed files with 13 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
doc/source/conf.py
View File

@ -117,14 +117,26 @@ openstack_projects = [
# Global variables # Global variables
# For replacement, use in docs as |VAR_NAME| (note there's no space around variable name) # For replacement, use in docs as |VAR_NAME| (note there's no space around variable name)
# When adding new variables, make sure you add them to GLOBAL_VARIABLE_MAP dictionary as well # When adding new variables, that you want to use in documentation, make sure you add
# them to GLOBAL_VARIABLE_MAP dictionary as well. KOLLA_OPENSTACK_RELEASE_UNMAINTAINED is
# used only to denote unmaintained branches, and it is not intended to be used for
# replacing anything in documentation.
KOLLA_OPENSTACK_RELEASE = openstackdocstheme.ext._get_series_name() KOLLA_OPENSTACK_RELEASE = openstackdocstheme.ext._get_series_name()
KOLLA_OPENSTACK_RELEASE_UNMAINTAINED = [
'yoga',
'zed',
]
if KOLLA_OPENSTACK_RELEASE == 'latest': if KOLLA_OPENSTACK_RELEASE == 'latest':
KOLLA_OPENSTACK_RELEASE = 'master' KOLLA_OPENSTACK_RELEASE = 'master'
KOLLA_BRANCH_NAME = 'master' KOLLA_BRANCH_NAME = 'master'
TESTED_RUNTIMES_GOVERNANCE_URL = 'https://governance.openstack.org/tc/reference/runtimes/' TESTED_RUNTIMES_GOVERNANCE_URL = 'https://governance.openstack.org/tc/reference/runtimes/'
elif KOLLA_OPENSTACK_RELEASE in KOLLA_OPENSTACK_RELEASE_UNMAINTAINED:
KOLLA_BRANCH_NAME = 'unmaintained/{}'.format(KOLLA_OPENSTACK_RELEASE)
TESTED_RUNTIMES_GOVERNANCE_URL =\
'https://governance.openstack.org/tc/reference/runtimes/{}.html'.format(KOLLA_OPENSTACK_RELEASE)
else: else:
KOLLA_BRANCH_NAME = 'stable/{}'.format(KOLLA_OPENSTACK_RELEASE) KOLLA_BRANCH_NAME = 'stable/{}'.format(KOLLA_OPENSTACK_RELEASE)
TESTED_RUNTIMES_GOVERNANCE_URL =\ TESTED_RUNTIMES_GOVERNANCE_URL =\