Bug 1522559 - Fix formatting of Telemetry docs r=gfritzsche
authorMathieu Leplatre <mathieu@mozilla.com>
Thu, 24 Jan 2019 17:49:31 +0000
changeset 512538 0750fe612685873d9ec80760984a87c2a4b069a9
parent 512537 2a05e7932e637ebf73ce13dc56175e8a69152839
child 512540 878bd06dc8589af32a22a94eef3a85b2df6a31cf
push id10566
push userarchaeopteryx@coole-files.de
push dateMon, 28 Jan 2019 12:41:12 +0000
treeherdermozilla-beta@69a3d7c8d04b [default view] [failures only]
perfherder[talos] [build metrics] [platform microbench] (compared to previous push)
reviewersgfritzsche
bugs1522559
milestone66.0a1
first release with
nightly linux32
nightly linux64
nightly mac
nightly win32
nightly win64
last release without
nightly linux32
nightly linux64
nightly mac
nightly win32
nightly win64
Bug 1522559 - Fix formatting of Telemetry docs r=gfritzsche Fix formatting of Telemetry docs (uptake and data collection index) Differential Revision: https://phabricator.services.mozilla.com/D17528
toolkit/components/telemetry/docs/collection/index.rst
toolkit/components/telemetry/docs/collection/uptake.rst
--- a/toolkit/components/telemetry/docs/collection/index.rst
+++ b/toolkit/components/telemetry/docs/collection/index.rst
@@ -11,19 +11,19 @@ In cases where this isn't possible and m
 *Note:* Every new data collection must go through a `data collection review <https://wiki.mozilla.org/Firefox/Data_Collection>`_.
 
 The current data collection possibilities include:
 
 * :doc:`scalars` allow recording of a single value (string, boolean, a number)
 * :doc:`histograms` can efficiently record multiple data points
 * ``environment`` data records information about the system and settings a session occurs in
 * :doc:`events` can record richer data on individual occurrences of specific actions
-* :doc:`measuring elapsed time <measuring-time>`
-* :doc:`custom pings <custom-pings>`
-* :doc:`stack capture <stack-capture>` allow recording application call stacks
+* :doc:`Measuring elapsed time <measuring-time>`
+* :doc:`Custom pings <custom-pings>`
+* :doc:`Stack capture <stack-capture>` allow recording application call stacks
 * :doc:`Use counters <use-counters>` measure the usage of web platform features
 * :doc:`Experiment annotations <experiments>`
 * :doc:`Remote content uptake <uptake>`
 * :doc:`Hybrid Content Telemetry <hybrid-content>` allows recording telemetry from semi-privileged hosted content
 * :doc:`WebExtension API <webextension-api>` can be used in privileged webextensions
 
 .. toctree::
    :maxdepth: 2
--- a/toolkit/components/telemetry/docs/collection/uptake.rst
+++ b/toolkit/components/telemetry/docs/collection/uptake.rst
@@ -23,18 +23,19 @@ Usage
 -----
 
 .. code-block:: js
 
    const { UptakeTelemetry } = ChromeUtils.import("resource://services-common/uptake-telemetry.js", {});
 
    UptakeTelemetry.report(source, status);
 
-- ``source`` - a ``string`` that is an identifier for the update source (eg. ``addons-blocklist``)
-- ``status`` - one of the following status constants:
+- ``source``, a ``string`` that is an identifier for the update source (eg. ``addons-blocklist``)
+- ``status``, one of the following status constants:
+
   - ``UptakeTelemetry.STATUS.UP_TO_DATE``: Local content was already up-to-date with remote content.
   - ``UptakeTelemetry.STATUS.SUCCESS``: Local content was updated successfully.
   - ``UptakeTelemetry.STATUS.BACKOFF``: Remote server asked clients to backoff.
   - ``UptakeTelemetry.STATUS.PREF_DISABLED``: Update is disabled in user preferences.
   - ``UptakeTelemetry.STATUS.PARSE_ERROR``: Parsing server response has failed.
   - ``UptakeTelemetry.STATUS.CONTENT_ERROR``: Server response has unexpected content.
   - ``UptakeTelemetry.STATUS.SIGNATURE_ERROR``: Signature verification after diff-based sync has failed.
   - ``UptakeTelemetry.STATUS.SIGNATURE_RETRY_ERROR``: Signature verification after full fetch has failed.