From: Zac Dover <zac.dover@gmail.com>
Date: Wed, 24 Mar 2021 15:47:17 +0000 (+1000)
Subject: doc/cephadm: rewrite "dry run" section in osd.rst
X-Git-Tag: v16.2.2~1^2~31
X-Git-Url: http://git-server-git.apps.pok.os.sepia.ceph.com/?a=commitdiff_plain;h=ab3ea265c5444a4b72f26d967573d41a1bde2689;p=ceph.git

doc/cephadm: rewrite "dry run" section in osd.rst

This rewrites the "dry run" section of the "OSD Service"
chapter of the Cephdam documentation. This commit makes
minor changes that reduce the cognitive load of the
reader.

Signed-off-by: Zac Dover <zac.dover@gmail.com>
(cherry picked from commit e61237f3a1f83b90d4ab22396c6e8291620a60fa)
---

diff --git a/doc/cephadm/osd.rst b/doc/cephadm/osd.rst
index adf44d182e1e..e61ef1534f52 100644
--- a/doc/cephadm/osd.rst
+++ b/doc/cephadm/osd.rst
@@ -150,16 +150,21 @@ There are a few ways to create new OSDs:
 Dry Run
 -------
 
-``--dry-run`` will cause the orchestrator to present a preview of what will happen
-without actually creating the OSDs.
+The ``--dry-run`` flag causes the orchestrator to present a preview of what
+will happen without actually creating the OSDs.
 
-Example::
+For example:
 
-    # ceph orch apply osd --all-available-devices --dry-run
-    NAME                  HOST  DATA     DB WAL
-    all-available-devices node1 /dev/vdb -  -
-    all-available-devices node2 /dev/vdc -  -
-    all-available-devices node3 /dev/vdd -  -
+   .. prompt:: bash #
+
+     ceph orch apply osd --all-available-devices --dry-run
+
+   ::
+
+     NAME                  HOST  DATA      DB  WAL
+     all-available-devices node1 /dev/vdb  -   -
+     all-available-devices node2 /dev/vdc  -   -
+     all-available-devices node3 /dev/vdd  -   -
 
 .. _cephadm-osd-declarative: