From: Zac Dover <zac.dover@proton.me>
Date: Tue, 1 Apr 2025 20:44:41 +0000 (+1000)
Subject: doc/dev/release-process: followup on PR#62610
X-Git-Tag: testing/wip-vshankar-testing-20250407.170244-debug~51^2
X-Git-Url: http://git.apps.os.sepia.ceph.com/?a=commitdiff_plain;h=2e294dcb7c551d3876b9105bb45ccf030d165cfc;p=ceph-ci.git

doc/dev/release-process: followup on PR#62610

Make minor usage and markup changes to doc/dev/release-process.rst to
follow up on Dan Mick's contribution in https://github.com/ceph/ceph/pull/62610.

Signed-off-by: Zac Dover <zac.dover@proton.me>
---

diff --git a/doc/dev/release-process.rst b/doc/dev/release-process.rst
index c0f4e9a27c9..eccd6cc3952 100644
--- a/doc/dev/release-process.rst
+++ b/doc/dev/release-process.rst
@@ -228,31 +228,32 @@ the container, release builds do not, because the build does not
 sign the packages.  Thus, release builds do not build the containers.
 This must be done after :ref:`Signing and Publishing the Build`.
 
-A Jenkins job named ceph-release-containers exists so that we can
-test the images before release.  The job exists both for convenience and
-because it requires access to both x86_64 and arm64 builders.  Start the
-job manually on the Jenkins server.  This job:
+A Jenkins job named ``ceph-release-containers`` exists so that we can test the
+images before release. The job exists both for convenience and because it
+requires access to both x86_64 and arm64 builders. Start the job manually on
+the Jenkins server. This job:
 
 * builds the architecture-specific container imagess and pushes them to
-  quay.ceph.io/ceph/prerelease-amd64 and
-  quay.ceph.io/ceph/prerelease-arm64
+  ``quay.ceph.io/ceph/prerelease-amd64`` and
+  ``quay.ceph.io/ceph/prerelease-arm64``
 
-* fuses the architecture-specific images together into a 'manifest-list'
-  or 'fat' container image and pushes it to quay.ceph.io/ceph/prerelease
+* fuses the architecture-specific images together into a "manifest-list"
+  or "fat" container image and pushes it to ``quay.ceph.io/ceph/prerelease``
 
 Finally, when all appropriate testing and verification is done on the
-container images, run ``make-manifest-list.py --promote`` from the ceph
+container images, run ``make-manifest-list.py --promote`` from the Ceph
 source tree (at ``container/make-manifest-list.py``) to promote them to
 their final release location on ``quay.io/ceph/ceph`` (you must ensure
-you're logged into ``quay.io/ceph`` with appropriate permissions):
+that you're logged into ``quay.io/ceph`` with appropriate permissions):
 
     .. prompt:: bash
 
        cd <ceph-checkout>/src/container
        ./make-manifest-list.py --promote
 
-The --promote step should only be performed as the final step in releasing
-containers, when the container images have been tested to be good.
+The ``--promote`` step should be performed only as the final step in releasing
+containers, after the container images have been tested and have been confirmed
+to be good.
 
 
 6. Announce the Release