Skip to content

Commit

Permalink
Updated release instructions for reduced versionss on RTD
Browse files Browse the repository at this point in the history
Signed-off-by: Andreas Maier <maiera@de.ibm.com>
  • Loading branch information
andy-maier committed Jun 26, 2024
1 parent b77a393 commit 25ddfc5
Show file tree
Hide file tree
Showing 2 changed files with 17 additions and 12 deletions.
1 change: 1 addition & 0 deletions changes/1567.cleanup.rst
Original file line number Diff line number Diff line change
@@ -1,2 +1,3 @@
Docs: Reduced number of versions shown in generated documentation to only
the latest fix version of each minor version, and the master version.
Updated the release instructions accordingly.
28 changes: 16 additions & 12 deletions docs/development.rst
Original file line number Diff line number Diff line change
Expand Up @@ -868,7 +868,7 @@ local clone of the python-zhmcclient Git repo.
Github, and finally creates a new stable branch on Github if the master
branch was released.

7. Verify the publishing
7. Verify the publishing and hide the previous fix version in ReadTheDocs

Wait for the "publish" workflow for the new release to have completed:
https://github.com/zhmcclient/python-zhmcclient/actions/workflows/publish.yml
Expand All @@ -881,17 +881,21 @@ local clone of the python-zhmcclient Git repo.
* Verify that the new version has a release on Github at
https://github.com/zhmcclient/python-zhmcclient/releases

* Verify that the new version has documentation on ReadTheDocs at
https://python-zhmcclient.readthedocs.io/en/latest/changes.html

The new version ``M.N.U`` should be automatically active on ReadTheDocs,
causing the documentation for the new version to be automatically
built and published.

If you cannot see the new version after some minutes, log in to
https://readthedocs.org/projects/python-zhmcclient/versions/
and activate the new version.

* Go to https://readthedocs.org/projects/python-zhmcclient/versions/ and:

- Verify that the new version ``M.N.U`` has been built successfully
and shows up at
https://python-zhmcclient.readthedocs.io/en/latest/changes.html.
If you cannot see the new version once its build is complete, a typical
issue may be that it was not activated automatically. Activate the new
version in that case.

- Go to the settings of the previous fix version in ReadTheDocs
(i.e. ``M.N.U-1``) if that exists, and set it to "hidden" (it remains
active). Hiding it causes it to be removed from the version list shown
at the bottom of the left hand pane of the generated documentation.
Keeping it active will cause any links to that version (that users may
have obtained in the past), still to work.

.. _`Starting a new version`:

Expand Down

0 comments on commit 25ddfc5

Please sign in to comment.