Magic-Mirror/gecko-dev
1
0
Fork 0
mirror of https://github.com/mozilla/gecko-dev.git synced 2024-10-23 10:15:41 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Bug 1522559 - Fix formatting of Telemetry docs r=gfritzsche

Browse Source 
Fix formatting of Telemetry docs (uptake and data collection index)

Differential Revision: https://phabricator.services.mozilla.com/D17528

--HG--
extra : moz-landing-system : lando
This commit is contained in:
Mathieu Leplatre 2019-01-24 17:49:31 +00:00
parent 898b9f3cd6
commit 0019ec958f
2 changed files with 6 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
toolkit/components/telemetry/docs/collection/index.rst
View File

@ -16,9 +16,9 @@ The current data collection possibilities include:
* :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>`

5
toolkit/components/telemetry/docs/collection/uptake.rst
View File

@ -28,8 +28,9 @@ Usage
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.