Adjust formatting for branch-cutting instructions 77/91977/1
authorThanh Ha <zxiiro@gmail.com>
Tue, 11 Aug 2020 14:04:16 +0000 (10:04 -0400)
committerThanh Ha (zxiiro) <zxiiro@gmail.com>
Tue, 11 Aug 2020 15:08:09 +0000 (15:08 +0000)
Formatting is off for some of the wording as the incorrect syntax
or indentation level was used.

Signed-off-by: Thanh Ha <zxiiro@gmail.com>
Change-Id: I9f19b5c2395034f2ee846ee422ce3566d547763e
(cherry picked from commit bfe13a6d7027c400d570e81b7b7701f8cf71bb74)

docs/release-process/branch-cutting.rst

index 4353792284b0d8d4eb5e72f38c73bc2f73844d71..74b330622254b12bbe7a4ca71984cca70602e769 100644 (file)
@@ -9,7 +9,7 @@ in order to perform the necessary task in Parentheses.
 JJB (releng/builder)
 --------------------
 
-#. Export ${NEXT_RELEASE} and ${CURR_RELEASE} with new and current release names.
+#. Export ``${NEXT_RELEASE}`` and ``${CURR_RELEASE}`` with new and current release names.
    **(releng/builder committers)**
 
    .. code-block:: bash
@@ -17,8 +17,8 @@ JJB (releng/builder)
       export NEXT_RELEASE="Neon"
       export CURR_RELEASE="Fluorine"
 
-#. Change JJB yaml files from `stream:fluorine` branch pointer from `master -> stable/${CURR_RELEASE,,}`
-   and create new `stream: ${NEXT_RELEASE,,}` branch pointer to branch master. This
+#. Change JJB yaml files from ``stream: fluorine`` branch pointer from *master -> stable/${CURR_RELEASE,,}*
+   and create new ``stream: ${NEXT_RELEASE,,}`` branch pointer to branch master. This
    requires handling two different file formats interspersed with in autorelease projects.
    **(releng/builder committers)**
 
@@ -183,11 +183,12 @@ Manual steps to version bump (Autorelease)
 Documentation post branch tasks
 -------------------------------
 
-#. Git remove all files/directories from the docs/release-notes/* directory. **(Release Engineering Team)**
+#. Git remove all files/directories from the ``docs/release-notes/*`` directory.
+   **(Release Engineering Team)**
 
-  .. code-block:: bash
+   .. code-block:: bash
 
-      git checkout master
-      git rm -rf docs/release-notes/<project file and/or folder>
-      git commit -sm "Reset release notes for next dev cycle"
-      git review
+       git checkout master
+       git rm -rf docs/release-notes/<project file and/or folder>
+       git commit -sm "Reset release notes for next dev cycle"
+       git review