1339023 - Make Telemetry in-tree docs index page point to the updated Histogram docs

Status: RESOLVED FIXED

(Toolkit :: Telemetry, defect, P1)

Description

[Alessio Placitelli [:Dexter]]

The docs at [1] still point to the MDN wiki page for adding a new telemetry probe rather than pointing at the in-tree docs for histograms. We should update fix this.

[1]- https://gecko.readthedocs.io/en/latest/toolkit/components/telemetry/telemetry/index.html

Comment 1

[Alessio Placitelli [:Dexter]]

Attachment: Bug 1339023 - Make Telemetry in-tree docs index page point to the updated Histogram docs.

Review commit: https://reviewboard.mozilla.org/r/112038/diff/#index_header
See other reviews: https://reviewboard.mozilla.org/r/112038/

Comment 2

[Georg Fritzsche [:gfritzsche]]

Comment on attachment 8836660 [details]
Bug 1339023 - Make Telemetry in-tree docs index page point to the updated Histogram docs.

https://reviewboard.mozilla.org/r/112038/#review113280

Lets also update "main-ping.rst".

::: toolkit/components/telemetry/docs/index.rst:11
(Diff revision 1)
>  
>  Telemetry is a feature that allows data collection. This is being used to collect performance metrics and other information about how Firefox performs in the wild.
>  
>  Client-side, this consists of:
>  
> -* data collection in `Histograms <https://developer.mozilla.org/en-US/docs/Mozilla/Performance/Adding_a_new_Telemetry_probe>`_, :doc:`collection/scalars` and other data structures
> +* data collection in :doc:`collection/histograms`, :doc:`collection/scalars` and other data structures

Let's just point to the "collection/index.rst" and just mention histograms & scalars as examples without links.

Comment 3

[Alessio Placitelli [:Dexter]]

Comment on attachment 8836660 [details]
Bug 1339023 - Make Telemetry in-tree docs index page point to the updated Histogram docs.

Review request updated; see interdiff: https://reviewboard.mozilla.org/r/112038/diff/1-2/

Comment 4

[Georg Fritzsche [:gfritzsche]]

Comment on attachment 8836660 [details]
Bug 1339023 - Make Telemetry in-tree docs index page point to the updated Histogram docs.

https://reviewboard.mozilla.org/r/112038/#review113286

::: toolkit/components/telemetry/docs/index.rst:11
(Diff revisions 1 - 2)
>  
>  Telemetry is a feature that allows data collection. This is being used to collect performance metrics and other information about how Firefox performs in the wild.
>  
>  Client-side, this consists of:
>  
> -* data collection in :doc:`collection/histograms`, :doc:`collection/scalars` and other data structures
> +* :doc:`data collection <collection/index>`, e.g. histograms and scalars

"e.g. in ..."

::: toolkit/components/telemetry/docs/data/main-ping.rst:241
(Diff revision 2)
>  ~~~~~~~~~~~~
>  Integer count of pending pings that are overdue.
>  
>  histograms
>  ----------
> -This section contains the histograms that are valid for the current platform. ``Flag`` and ``count`` histograms are always created and submitted, with their default value being respectively ``false`` and ``0``. Other histogram types (`see here <https://developer.mozilla.org/en-US/docs/Mozilla/Performance/Adding_a_new_Telemetry_probe#Choosing_a_Histogram_Type>`_) are not created nor submitted if no data was added to them. The type and format of the reported histograms is described by the ``Histograms.json`` file. Its most recent version is available `here <https://dxr.mozilla.org/mozilla-central/source/toolkit/components/telemetry/Histograms.json>`_. The ``info.revision`` field indicates the revision of the file that describes the reported histograms.
> +This section contains the histograms that are valid for the current platform. ``Flag`` and ``count`` histograms are always created and submitted, with their default value being respectively ``false`` and ``0``. Other histogram types (:doc:`../collection/histograms`) are not created nor submitted if no data was added to them. The type and format of the reported histograms is described by the ``Histograms.json`` file. Its most recent version is available `here <https://dxr.mozilla.org/mozilla-central/source/toolkit/components/telemetry/Histograms.json>`_. The ``info.revision`` field indicates the revision of the file that describes the reported histograms.

Please make this a ref to "choosing a histogram type".
http://www.sphinx-doc.org/en/stable/markup/inline.html#ref-role

Comment 5

[Alessio Placitelli [:Dexter]]

Comment on attachment 8836660 [details]
Bug 1339023 - Make Telemetry in-tree docs index page point to the updated Histogram docs.

Review request updated; see interdiff: https://reviewboard.mozilla.org/r/112038/diff/2-3/

Comment 6

[Pulsebot]

Pushed by [e-mail]:
https://hg.mozilla.org/integration/autoland/rev/d65a97f5fd29
Make Telemetry in-tree docs index page point to the updated Histogram docs. r=gfritzsche

Comment 7

[Wes Kocher (:KWierso) (Not reading bugmail; email directly if needed)]

https://hg.mozilla.org/mozilla-central/rev/d65a97f5fd29