From 0ba61248919ace88b5312b635c080faf1998dcde Mon Sep 17 00:00:00 2001 From: Zac Dover Date: Thu, 5 Jun 2025 13:05:54 +1000 Subject: [PATCH] doc/mgr: edit telemetry (4 of x) Improve the English and the formatting in doc/mgr/telemetry.rst. This follows up on https://github.com/ceph/ceph/pull/63476. This commit edits the final part of doc/mgr/telemetry.rst. Signed-off-by: Zac Dover (cherry picked from commit b199d75763baf654fe1b21a780a4f6bcd0c4735b) --- doc/mgr/telemetry.rst | 11 ++++++----- 1 file changed, 6 insertions(+), 5 deletions(-) diff --git a/doc/mgr/telemetry.rst b/doc/mgr/telemetry.rst index cd430ca536517..80359c4cc4cc3 100644 --- a/doc/mgr/telemetry.rst +++ b/doc/mgr/telemetry.rst @@ -324,8 +324,9 @@ running a command of the following form: Contact and Description ----------------------- -A contact and description can be added to the report. This is -completely optional, and disabled by default: +A contact and description can be added to the report. This is optional and is +disabled by default. Run commands of the following forms to add contacts and +descriptions: .. prompt:: bash # @@ -344,8 +345,9 @@ To participate in a leaderboard in the `public dashboards 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: +cluster's total storage capacity and the number of OSDs. To add a description +of the cluster so that it can more easily be identified on the leaderboard, run +a command of the following form: .. prompt:: bash # @@ -353,4 +355,3 @@ cluster, run a command of the following form: If the ``ident`` channel is enabled, its details will not be displayed in the leaderboard. - -- 2.39.5