Skip to content

Commit fc25b1e

Browse files
committed
doc/mgr: edit telemetry.rst
Edit doc/mgr/telemetry.rst. Follow up on the suggestions made by Anthony D'Atri in ceph#63740. Make several changes that were not earmarked in that PR, but that nonetheless improve the quality of the English in telemetry.rst. Signed-off-by: Zac Dover <[email protected]>
1 parent 1e37f66 commit fc25b1e

File tree

1 file changed

+16
-15
lines changed

1 file changed

+16
-15
lines changed

doc/mgr/telemetry.rst

Lines changed: 16 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -248,22 +248,21 @@ Where:
248248
.. glossary::
249249

250250
NAME
251-
Collection name; prefix indicates the channel the collection
252-
belongs to.
251+
Collection name. The prefix indicates the channel to which the
252+
collection belongs.
253253

254254
STATUS
255-
Indicates whether the collection metrics are reported; this is
256-
determined by the status (enabled / disabled) of the channel
257-
the collection belongs to, along with the enrollment status of
258-
the collection (whether the user is opted-in to this
259-
collection).
255+
Indicates whether the collection metrics are reported. This is
256+
determined by the status (``enabled`` or ``disabled``) to which
257+
the channel of the collection belongs, along with the
258+
enrollment status of the collection (whether the user is
259+
opted-in to this collection).
260260

261261
DESC
262262
General description of the collection.
263263

264-
To print the diff that displays the differences between (1) the collections you
265-
are enrolled to and (2) the new, available collections, run the following
266-
command:
264+
To display any difference between the currenty-enrolled collections and any new
265+
or available collections, run the following command:
267266

268267
.. prompt:: bash #
269268

@@ -275,8 +274,8 @@ To enroll to the most recent collections, run the following command:
275274

276275
ceph telemetry on
277276

278-
Enable a new channel that is disabled by running a command of the following
279-
form:
277+
Enable a new channel that is currently disabled by running a command of the
278+
following form:
280279

281280
.. prompt:: bash #
282281

@@ -305,14 +304,16 @@ the following form:
305304
Manually sending telemetry
306305
--------------------------
307306

308-
To ad hoc [fixme] send telemetry data:
307+
To send an ansynchronous, one-time set of telemetry data, run the following
308+
command:
309309

310310
.. prompt:: bash #
311311

312312
ceph telemetry send
313313

314-
In case telemetry is not enabled (with ``ceph telemetry on``), you need to add
315-
``--license sharing-1-0`` to the ``ceph telemetry send`` command.
314+
If telemetry has not been enabled (by running the command ``ceph telemetry
315+
on``), you need to add ``--license sharing-1-0`` to the ``ceph telemetry send``
316+
command.
316317

317318
Sending telemetry through a proxy
318319
---------------------------------

0 commit comments

Comments
 (0)