From 4935ad8aed2aa796015473de5b38cc973ba85ba1 Mon Sep 17 00:00:00 2001 From: Zac Dover Date: Tue, 23 May 2023 06:06:52 +1000 Subject: [PATCH] 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 --- doc/mgr/telemetry.rst | 22 +++++++++++++--------- 1 file changed, 13 insertions(+), 9 deletions(-) diff --git a/doc/mgr/telemetry.rst b/doc/mgr/telemetry.rst index 72ec61dada8..90d45766c15 100644 --- a/doc/mgr/telemetry.rst +++ b/doc/mgr/telemetry.rst @@ -272,17 +272,21 @@ completely optional, and disabled by default.:: Leaderboard ----------- -Users who are interested in participating in a leaderboard in the `public -dashboards `_ can do so with:: +To participate in a leaderboard in the `public dashboards +`_, 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. -- 2.39.5