1231721 - Add WebRTC docs to in-tree Telemetry docs

Status: RESOLVED FIXED

(Toolkit :: Telemetry, defect, P2)

Description

[Alessio Placitelli [:Dexter]]

It looks like even if WebRTC is mentioned in Telemetry in-tree docs, it is not documented [0].

We should expand the documentation on WebRTC a bit, as done for the info section (for example).

[0] - https://gecko.readthedocs.org/en/latest/toolkit/components/telemetry/telemetry/main-ping.html

Comment 1

[Alessio Placitelli [:Dexter]]

:drno, do you think you could help us with this?

Comment 2

[Nils Ohlmeier [:drno]]

Attachment: MozReview Request: Bug 1231721: added documentation for webrtc dictionary in amin telemetry ping

Bug 1231721: added documentation for webrtc dictionary in amin telemetry ping

Comment 3

[Nils Ohlmeier [:drno]]

Comment on attachment 8697407 [details]
MozReview Request: Bug 1231721: added documentation for webrtc dictionary in amin telemetry ping

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

Comment 4

[Nils Ohlmeier [:drno]]

Let me know if this is good enough or not.

Comment 5

[Alessio Placitelli [:Dexter]]

Comment on attachment 8697407 [details]
MozReview Request: Bug 1231721: added documentation for webrtc dictionary in amin telemetry ping

https://reviewboard.mozilla.org/r/27599/#review24887

This looks good, thanks for taking care of it quickly. There's just one issue, reported below.

::: toolkit/components/telemetry/docs/main-ping.rst:172
(Diff revision 1)
> +~~~~~~

WebRTC should be at the same level as "info" ("chromeHangStats" and "threadHangStats" are wrong, sorry!). Use "-" instead of "~" to use the correct level.

Comment 6

[Nils Ohlmeier [:drno]]

Comment on attachment 8697407 [details]
MozReview Request: Bug 1231721: added documentation for webrtc dictionary in amin telemetry ping

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

Comment 7

[Alessio Placitelli [:Dexter]]

Comment on attachment 8697407 [details]
MozReview Request: Bug 1231721: added documentation for webrtc dictionary in amin telemetry ping

https://reviewboard.mozilla.org/r/27599/#review24939

Thanks, this looks good!

Comment 8

[Pulsebot]

https://hg.mozilla.org/integration/mozilla-inbound/rev/0dd2b21ff58d

Comment 9

[Carsten Book [:Tomcat]]

https://hg.mozilla.org/mozilla-central/rev/0dd2b21ff58d