Bug 1450968 - Update remote content Telemetry documentation draft
authorMathieu Leplatre <mathieu@mozilla.com>
Tue, 03 Apr 2018 07:57:20 -0700
changeset 776659 60fe4687968b6c1d5fea11674ca8189caec1ddad
parent 772574 7b9da7139d94951431a148dcaf8a388640c91b27
push id104938
push usermleplatre@mozilla.com
push dateTue, 03 Apr 2018 14:58:08 +0000
bugs1450968
milestone61.0a1
Bug 1450968 - Update remote content Telemetry documentation MozReview-Commit-ID: HUOxIY2yz8G
toolkit/components/normandy/docs/index.rst
toolkit/components/telemetry/docs/collection/uptake.rst
--- a/toolkit/components/normandy/docs/index.rst
+++ b/toolkit/components/normandy/docs/index.rst
@@ -1,8 +1,10 @@
+.. _components/normandy:
+
 ====================
 Shield Recipe Client
 ====================
 
 Normandy (aka the Shield Recipe Client) is a targeted change control
 system, allowing small changes to be made within a release of Firefox,
 such as studies. It downloads recipes and actions from the `recipe
 server`_, verifies their cryptographic signatures, and then executes
--- a/toolkit/components/telemetry/docs/collection/uptake.rst
+++ b/toolkit/components/telemetry/docs/collection/uptake.rst
@@ -19,17 +19,17 @@ The helper — described below — reports predefined update status, which eventually gives a unified way to obtain:
    Examples of update status: *up-to-date, success, network error, server error, signature error, server backoff, unknown error…*
 
 
 Usage
 -----
 
 .. code-block:: js
 
-   const { UptakeTelemetry } = Cu.import("resource://services-common/uptake-telemetry.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:
   - ``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.
@@ -82,14 +82,14 @@ Use-cases
 The following remote data sources are already using this unified histogram.
 
 * remote settings changes monitoring
 * add-ons blocklist
 * gfx blocklist
 * plugins blocklist
 * certificate revocation
 * certificate pinning
+* :ref:`Shield Recipe client <components/normandy>`
 
 Obviously, the goal is to eventually converge and avoid ad-hoc Telemetry probes for measuring uptake of remote content. Some notable potential use-cases are:
 
 * nsUpdateService
 * mozapps extensions update
-* Shield recipe client