Skip to content

Commit b199d75

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]>
1 parent 12ffad5 commit b199d75

File tree

1 file changed

+9
-8
lines changed

1 file changed

+9
-8
lines changed

doc/mgr/telemetry.rst

Lines changed: 9 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -300,14 +300,14 @@ Sending telemetry through a proxy
300300
---------------------------------
301301

302302
If the cluster cannot directly connect to the configured telemetry
303-
endpoint (default ``telemetry.ceph.com``), you can configure a HTTP/HTTPS
304-
proxy server with:
303+
endpoint (default: ``telemetry.ceph.com``), configure a HTTP/HTTPS
304+
proxy server by running a command of the following form:
305305

306306
.. prompt:: bash #
307307

308308
ceph config set mgr mgr/telemetry/proxy https://10.0.0.1:8080
309309

310-
You can also include a ``user:pass`` if needed:
310+
Include a ``user:pass`` if needed by running a command of the following form:
311311

312312
.. prompt:: bash #
313313

@@ -317,8 +317,9 @@ You can also include a ``user:pass`` if needed:
317317
Contact and Description
318318
-----------------------
319319

320-
A contact and description can be added to the report. This is
321-
completely optional, and disabled by default:
320+
A contact and description can be added to the report. This is optional and is
321+
disabled by default. Run commands of the following forms to add contacts and
322+
descriptions:
322323

323324
.. prompt:: bash #
324325

@@ -337,13 +338,13 @@ To participate in a leaderboard in the `public dashboards
337338
ceph config set mgr mgr/telemetry/leaderboard true
338339

339340
The leaderboard displays basic information about the cluster. This includes the
340-
total storage capacity and the number of OSDs. To add a description of the
341-
cluster, run a command of the following form:
341+
cluster's total storage capacity and the number of OSDs. To add a description
342+
of the cluster so that it can more easily be identified on the leaderboard, run
343+
a command of the following form:
342344

343345
.. prompt:: bash #
344346

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

347349
If the ``ident`` channel is enabled, its details will not be displayed in the
348350
leaderboard.
349-

0 commit comments

Comments
 (0)