openstack/openstack-ansible
Code Issues Proposed changes

[doc] Add release codename to formal_name

Browse Source 
It might be expected, that formal name of the release is in compliance
with the approve release naming [1]. So let's start using codename
in addition to the release version as "formal_name" in docs.

With that non-formal name should remain as a simple version.

[1] https://governance.openstack.org/tc/reference/release-naming.html

Change-Id: I86ac0f45c2768d284d1a8baea4291d57c1df6e02
This commit is contained in:
Dmitriy Rabotyagov
2025-05-28 13:05:12 +02:00
parent 3ad6cd1703
commit 4c184fb3a9
2 changed files with 9 additions and 9 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
doc/source/conf.py
View File

@@ -35,9 +35,9 @@ import yaml
# Variables to override
target_name = 'openstack-ansible'
description = 'OpenStack-Ansible deploys OpenStack environments using Ansible.'
previous_series_name = '2025.1'
previous_series_name = '2025.1 (Epoxy)'
previous_slurp_name = None
current_series_name = '2025.2'
current_series_name = '2025.2 (Flamingo)'
# General information about the project.
project = 'OpenStack-Ansible'
@@ -76,7 +76,7 @@ dev_docs_prefix = ("https://docs.openstack.org/openstack-ansible/"
"{}/%s".format(current_series))
if previous_slurp_name:
slurp_epilog = f"replace:: or {previous_slurp_name.capitalize()}"
slurp_epilog = f"replace:: or {previous_slurp_name}"
else:
slurp_epilog = "unicode:: U+200B"
@@ -93,9 +93,9 @@ rst_epilog = """
""".format( # noqa: E501
current_release_git_branch_name=branch,
current_release_gnocchi_git_branch_name=gnocchi_branch,
previous_series_name=previous_series_name,
previous_release_formal_name=previous_series_name.capitalize(),
current_release_formal_name=current_series_name.capitalize(),
previous_series_name=previous_series_name.split(' ')[0],
previous_release_formal_name=previous_series_name,
current_release_formal_name=current_series_name,
slurp_epilog=slurp_epilog,
latest_tag=latest_tag,
upgrade_warning=upgrade_warning,

6
doc/source/index.rst
View File

@@ -9,13 +9,13 @@ OpenStack-Ansible provides Ansible playbooks and roles for deploying
and configuring an OpenStack environment.
Documentation for all previous releases is available by substituting ``latest``
with an expected release (i.e. ``2025.1``) directly in the address bar (URL)
with an expected release (i.e. "|previous_series_name|") directly in the address bar (URL)
of your browser.
Support status for each OpenStack release can be found on `releases.openstack.org <https://releases.openstack.org/>`_
2025.2 (Flamingo): Under Development
------------------------------------
|current_release_formal_name|: Under Development
------------------------------------------------
.. toctree::
:maxdepth: 2