]> git.apps.os.sepia.ceph.com Git - ceph-ci.git/commitdiff
doc/mgr: edit "leaderboard" in telemetry.rst
authorZac Dover <zac.dover@proton.me>
Mon, 22 May 2023 20:06:52 +0000 (06:06 +1000)
committerZac Dover <zac.dover@proton.me>
Mon, 22 May 2023 20:11:39 +0000 (06:11 +1000)
Standardize the presentation of commands in the "Leaderboard" section of
doc/mgr/telemetry.rst.

Follow-up to https://github.com/ceph/ceph/pull/50977

Signed-off-by: Zac Dover <zac.dover@proton.me>
doc/mgr/telemetry.rst

index 72ec61dada868eff2afa9f5faf9eae488654f62b..90d45766c15bce3006bd1e15d36296889cde5d55 100644 (file)
@@ -272,17 +272,21 @@ completely optional, and disabled by default.::
 Leaderboard
 -----------
 
-Users who are interested in participating in a leaderboard in the `public
-dashboards <https://telemetry-public.ceph.com/>`_ can do so with::
+To participate in a leaderboard in the `public dashboards
+<https://telemetry-public.ceph.com/>`_, run the following command:
 
-  ceph config set mgr mgr/telemetry/leaderboard true
+.. prompt:: bash $
 
-The leaderboard displays basic information about the cluster, like total
-storage capacity, number of OSDs, etc. A description of the cluster can be
-added with::
+   ceph config set mgr mgr/telemetry/leaderboard true
 
-  ceph config set mgr mgr/telemetry/leaderboard_description 'Ceph cluster for Computational Biology at the University of XYZ'
+The leaderboard displays basic information about the cluster. This includes the
+total storage capacity and the number of OSDs. To add a description of the
+cluster, run a command of the following form: 
 
-In case the 'ident' channel is enabled, its details will not be displayed in
-the leaderboard.
+.. prompt:: bash $
+
+   ceph config set mgr mgr/telemetry/leaderboard_description 'Ceph cluster for Computational Biology at the University of XYZ'
+
+If the ``ident`` channel is enabled, its details will not be displayed in the
+leaderboard.