Skip to content

Commit f1e962e

Browse files
committed
doc/mgr: edit telemetry (4 of x)
Improve the English and the formatting in doc/mgr/telemetry.rst. This follows up on ceph#63476. This commit edits the final part of doc/mgr/telemetry.rst. Signed-off-by: Zac Dover <[email protected]> (cherry picked from commit b199d75)
1 parent 9d59f75 commit f1e962e

File tree

1 file changed

+6
-5
lines changed

1 file changed

+6
-5
lines changed

doc/mgr/telemetry.rst

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -326,8 +326,9 @@ running a command of the following form:
326326
Contact and Description
327327
-----------------------
328328

329-
A contact and description can be added to the report. This is
330-
completely optional, and disabled by default:
329+
A contact and description can be added to the report. This is optional and is
330+
disabled by default. Run commands of the following forms to add contacts and
331+
descriptions:
331332

332333
.. prompt:: bash #
333334

@@ -346,13 +347,13 @@ To participate in a leaderboard in the `public dashboards
346347
ceph config set mgr mgr/telemetry/leaderboard true
347348

348349
The leaderboard displays basic information about the cluster. This includes the
349-
total storage capacity and the number of OSDs. To add a description of the
350-
cluster, run a command of the following form:
350+
cluster's total storage capacity and the number of OSDs. To add a description
351+
of the cluster so that it can more easily be identified on the leaderboard, run
352+
a command of the following form:
351353

352354
.. prompt:: bash #
353355

354356
ceph config set mgr mgr/telemetry/leaderboard_description 'Ceph cluster for Computational Biology at the University of XYZ'
355357

356358
If the ``ident`` channel is enabled, its details will not be displayed in the
357359
leaderboard.
358-

0 commit comments

Comments
 (0)