]> git.apps.os.sepia.ceph.com Git - ceph.git/commitdiff
doc/mgr: edit telemetry (4 of x) 63776/head
authorZac Dover <zac.dover@proton.me>
Thu, 5 Jun 2025 03:05:54 +0000 (13:05 +1000)
committerZac Dover <zac.dover@proton.me>
Thu, 12 Jun 2025 03:10:50 +0000 (13:10 +1000)
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 <zac.dover@proton.me>
(cherry picked from commit b199d75763baf654fe1b21a780a4f6bcd0c4735b)

doc/mgr/telemetry.rst

index 7889c62b2bb977f9e97c42b8ae98a21d8da7e499..f5468384a7121b0884e63db17cb5fc8e9281036e 100644 (file)
@@ -326,8 +326,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 #
 
@@ -346,8 +347,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 #
 
@@ -355,4 +357,3 @@ cluster, run a command of the following form:
 
 If the ``ident`` channel is enabled, its details will not be displayed in the
 leaderboard.
-