openstack/governance
Code Issues Proposed changes

Align release naming terminology

Browse Source 
Throughout the doc we've used different combinations of words to
express same thing:
* release number
* version number

Also in some places we've used `release name` when intention was to
set number as a guidance.

Now doc is aligned to use `release number` constently.

Change-Id: I952332333d1564012887c560edd46fb7cd90bd15
This commit is contained in:
Dmitriy Rabotyagov
2023-04-27 11:38:50 +02:00
parent 967446d0a1
commit 497958ee6f
1 changed files with 7 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files

14
reference/release-naming.rst
View File

@ -39,8 +39,8 @@ in some places.
* Testing tools: Use release number which is more aligned with what stable
branches are going to use.
* Release notes: For the version of specific project use combined OpenStack release and
the project's version, like "OpenStack 2023.1 (Nova 27.X.Y)".
* Release notes: For the version of specific project use combined OpenStack release
number and the project's version, like "OpenStack 2023.1 (Nova 27.X.Y)".
There should not be OpenStack release name, like "Antelope" included in the version.
Examples:
@ -49,7 +49,7 @@ in some places.
* OpenStack 2023.2 (Neutron 23.0.0)
In case when there is no need to give version of the specific project, but
just version of OpenStack, there should be only version number used, like
just version of OpenStack, there should be only release number used, like
"OpenStack 2023.1".
Examples:
@ -57,7 +57,7 @@ in some places.
* OpenStack 2023.2
* OpenStack 2024.1
* Project specific documentation: use release name combined with version of the project.
* Project specific documentation: use release number combined with version of the project.
Examples:
@ -65,7 +65,7 @@ in some places.
* OpenStack 2023.2 (Neutron 23.0.0)
* OpenStack documentation: in cases when there is need to just give version of OpenStack
without specific project's version, use version number without marketing name.
without specific project's version, use release number without marketing name.
Examples:
@ -77,9 +77,9 @@ in some places.
milestone name.
* Marketing materials: Release name is still there to be used in any marketing or
other non-technical materials. Version number can be also used in such cases.
other non-technical materials. Release number must be also used in such cases.
* Other, non-marketing related places: use release name combined with version of
* Other, non-marketing related places: use release number combined with version of
the project unless there is clear reason to use OpenStack release name instead.
Examples: