Bug 1455353 Fix sphinx warnings in Telemetry documentation r=chutten

--HG--
extra : rebase_source : 7d4d1d937f3e7196b2500645a8be42044702a686
This commit is contained in:
Issei Horie 2018-04-21 20:41:36 +09:00
Родитель c9b1f5222f
Коммит cf5bb5b758
5 изменённых файлов: 9 добавлений и 6 удалений

Просмотреть файл

@ -107,6 +107,7 @@ The following is a sample histogram declaration from ``Histograms.json`` for a h
.. code-block:: json
{
"MEMORY_RESIDENT": {
"record_in_processes": ["main", "content"],
"alert_emails": ["team@mozilla.xyz"],
@ -117,7 +118,8 @@ The following is a sample histogram declaration from ``Histograms.json`` for a h
"n_buckets": 50,
"bug_numbers": [12345],
"description": "Resident memory size (KB)"
},
}
}
Histograms which track timings in milliseconds or microseconds should suffix their names with ``"_MS"`` and ``"_US"`` respectively. Flag-type histograms should have the suffix ``"_FLAG"`` in their name.

Просмотреть файл

@ -29,7 +29,7 @@ For security/privacy reasons `Mozilla.ContentTelemetry` will only work on a list
Example:
.. code-block:: csv
::
origin hc_telemetry 1 https://discovery.addons.mozilla.org

Просмотреть файл

@ -81,8 +81,8 @@ The recorded failure types are:
* "eUnreachable" - The remote server was unreachable.
* "eChannelOpen" - The connection failed when we tried to open the channel.
* "eRedirect" - The connection failed when being redirected.
* "abort" - What XMLHttpRequest means by "abort" (see `MDN <https://developer.mozilla.org/en-US/docs/Web/Events/abort>`_)
* "timeout" - What XMLHttpRequest means by "timeout" (see `MDN <https://developer.mozilla.org/en-US/docs/Web/Events/timeout>`_)
* "abort" - What XMLHttpRequest means by "abort" (see `MDN <https://developer.mozilla.org/en-US/docs/Web/Events/abort>`__)
* "timeout" - What XMLHttpRequest means by "timeout" (see `MDN <https://developer.mozilla.org/en-US/docs/Web/Events/timeout>`__)
This field is optional.

Просмотреть файл

@ -1987,6 +1987,7 @@ Example
^^^^^^^
::
"org.mozilla.passwordmgr.passwordmgr": {
"_v": 2,
"numSavedPasswords": 32,

Просмотреть файл

@ -6,7 +6,7 @@ In Firefox, the Telemetry system collects various measures of Firefox performanc
.. important::
Every new data collection in Firefox needs a `data collection review <https://wiki.mozilla.org/Firefox/Data_Collection#Requesting_Approval>`_ from a data collection peer. Just set the feedback? flag for one of the data peers. They try to reply within a business day.
Every new data collection in Firefox needs a `data collection review <https://wiki.mozilla.org/Firefox/Data_Collection#Requesting_Approval>`__ from a data collection peer. Just set the feedback? flag for one of the data peers. They try to reply within a business day.
What is your goal?
==================
@ -22,7 +22,7 @@ From there, questions you should ask are:
- How many people do you need this data from?
- Is data from the pre-release channels sufficient?
This also informs the `data collection review <https://wiki.mozilla.org/Firefox/Data_Collection>`_, which requires a plan for how to use the data. Data collection review is required for all new data collection.
This also informs the `data collection review <https://wiki.mozilla.org/Firefox/Data_Collection>`__, which requires a plan for how to use the data. Data collection review is required for all new data collection.
Data collection levels
======================