]> git.apps.os.sepia.ceph.com Git - ceph.git/commitdiff
doc/mgr: edit telemetry (3 of x) 63773/head
authorZac Dover <zac.dover@proton.me>
Thu, 5 Jun 2025 02:24:08 +0000 (12:24 +1000)
committerZac Dover <zac.dover@proton.me>
Thu, 17 Jul 2025 03:40:08 +0000 (13:40 +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 third hundred lines in doc/mgr/telemetry.rst.

Signed-off-by: Zac Dover <zac.dover@proton.me>
(cherry picked from commit 3ce61e065121e07e2c37097f1fe6736bdf985e8e)

doc/mgr/telemetry.rst

index 577e666c932bb22d51d3b4d59902fd8d8c9af01e..66e233096342ae26e9906f589d819828925070fe 100644 (file)
@@ -218,10 +218,10 @@ If telemetry is off you can preview a sample report by channel with:
 Collections
 -----------
 
-Collections represent different aspects of data that we collect within a
+Collections represent different aspects of data collected within a
 channel.
 
-List all collections with:
+To list all collections, run the following command:
 
 .. prompt:: bash #
 
@@ -246,35 +246,38 @@ List all collections with:
 
 Where:
 
+.. glossary:: 
+
         NAME
-                Collection name. The prefix indicates the channel to which the
-                collection belongs.
+                Collection name; prefix indicates the channel the collection
+                belongs to.
 
         STATUS
-                Indicates whether the collection metrics are reported. This is
-                determined by the status (``enabled`` or ``disabled``) to which
-                the channel of the collection belongs, along with the
-                enrollment status of the collection (whether the user is
-                opted-in to this collection).
+                Indicates whether the collection metrics are reported; this is
+                determined by the status (enabled / disabled) of the channel
+                the collection belongs to, along with the enrollment status of
+                the collection (whether the user is opted-in to this
+                collection).
 
         DESC
                 General description of the collection.
 
-To display any difference between the currenty-enrolled collections and any new
-or available collections, run the following command:
+To print the diff that displays the differences between (1) the collections you
+are enrolled to and (2) the new, available collections, run the following
+command:
 
 .. prompt:: bash #
 
    ceph telemetry diff
 
-Enroll to the most recent collections with:
+To enroll to the most recent collections, run the following command:
 
 .. prompt:: bash #
 
    ceph telemetry on
 
-Enable a new channel that is currently disabled by running a command of the
-following form:
+Enable a new channel that is disabled by running a command of the following
+form:
 
 .. prompt:: bash #
 
@@ -283,8 +286,8 @@ following form:
 Interval
 --------
 
-The module compiles and sends a new report every 24 hours by default.
-You can adjust this interval with:
+The telemetry module compiles and sends a new report every 24 hours by default.
+Adjust this interval by running a command of the following form:
 
 .. prompt:: bash #
 
@@ -293,7 +296,8 @@ You can adjust this interval with:
 Status
 --------
 
-The see the current configuration:
+To print the current configuration of the telemetry module, run a command of
+the following form:
 
 .. prompt:: bash #