starlingx/docs
Code Issues Proposed changes

Merge "Update release info"

Browse Source
This commit is contained in:
Zuul
2025-01-28 15:45:21 +00:00
committed by Gerrit Code Review
parent 8e5c75cc97 c60a2a8132
commit bb265e607d
1 changed files with 4 additions and 16 deletions
Download Patch File Download Diff File Expand all files Collapse all files

20
doc/source/contributor/doc_contribute_guide.rst
View File

@@ -1924,18 +1924,6 @@ To do so:
#. On a working branch, open the file :file:`doc/source/conf.py`. #. On a working branch, open the file :file:`doc/source/conf.py`.
#. If you are updating on a new branch, change the configuration assignment
``starlingxdocs_plus_this_version`` to the name of the new branch.
For example:
.. code-block::
starlingxdocs_plus_this_version="Version 9.0"
Otherwise, confirm that the value is correct for the branch you are
updating.
#. Locate the configuration assignment ``starlingxdocs_plus_other_versions``. #. Locate the configuration assignment ``starlingxdocs_plus_other_versions``.
This assignment takes a *key,value* pair for each branch other than the This assignment takes a *key,value* pair for each branch other than the
@@ -1958,7 +1946,7 @@ To do so:
.. code-block:: .. code-block::
starlingxdocs_plus_other_versions = [("Version 6.0","r/stx.6.0"),("Version 7.0","r/stx.7.0"),("Version 8.0","r/stx.8.0"),("Latest","")] starlingxdocs_plus_other_versions = [("Version 6.0","r/stx.6.0"),("Version 7.0","r/stx.7.0"),("Version 8.0","r/stx.8.0"),("Version 9.0","r/stx.9.0")]
.. note:: .. note::
@@ -1968,9 +1956,9 @@ To do so:
``master`` documentation is at the base URL ``docs.startlingx.io``, this ``master`` documentation is at the base URL ``docs.startlingx.io``, this
means that the value must be an empty string, as show above. means that the value must be an empty string, as show above.
********************* **********************
Adding the promte job Adding the promote job
********************* **********************
A ``promote`` job must be created for merged reviews on a new release branch to A ``promote`` job must be created for merged reviews on a new release branch to
be published to docs.starlingx.io. be published to docs.starlingx.io.