From: Zac Dover <zac.dover@proton.me>
Date: Mon, 22 May 2023 20:06:52 +0000 (+1000)
Subject: doc/mgr: edit "leaderboard" in telemetry.rst
X-Git-Tag: v17.2.7~386^2
X-Git-Url: http://git.apps.os.sepia.ceph.com/?a=commitdiff_plain;h=cf6508215e545c364e9a6d946a905fbac6d8324e;p=ceph.git

doc/mgr: edit "leaderboard" in telemetry.rst

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>
(cherry picked from commit 4935ad8aed2aa796015473de5b38cc973ba85ba1)
---

diff --git a/doc/mgr/telemetry.rst b/doc/mgr/telemetry.rst
index 388353b84adcf..90d45766c15bc 100644
--- a/doc/mgr/telemetry.rst
+++ b/doc/mgr/telemetry.rst
@@ -269,3 +269,24 @@ completely optional, and disabled by default.::
   ceph config set mgr mgr/telemetry/description 'My first Ceph cluster'
   ceph config set mgr mgr/telemetry/channel_ident true
 
+Leaderboard
+-----------
+
+To participate in a leaderboard in the `public dashboards
+<https://telemetry-public.ceph.com/>`_, run the following command:
+
+.. prompt:: bash $
+
+   ceph config set mgr mgr/telemetry/leaderboard true
+
+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: 
+
+.. 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.
+