1349165 - DevTools: complete documentation gaps for how to add telemetry to panels

Status: RESOLVED FIXED

(DevTools :: General, enhancement, P3)

Description

[Soledad Penades [:sole] [:spenades]]

There's some documentation in https://dxr.mozilla.org/mozilla-central/source/devtools/client/shared/telemetry.js but it is missing crucial parts such as the need to request a data review from the data team. This bug aims to fill in these gaps by documenting this on the docs folder.

We can then point people to this file each time telemetry is required for a new functionality.

Comment 1

[Soledad Penades [:sole] [:spenades]]

Attachment: Bug 1349165 - DevTools: complete documentation gaps for how to add telemetry to panels.

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

Comment 2

[Patrick Brosset <:pbro>]

Comment on attachment 8850501 [details]
Bug 1349165 - DevTools: complete documentation gaps for how to add telemetry to panels.

https://reviewboard.mozilla.org/r/123100/#review125412

You might want to add an entry in SUMMARY.md too so it can be seen in the table of contents when we generate the gitbook out of our docs.

::: devtools/docs/frontend/telemetry.md:85
(Diff revision 1)
> +```
> +
> +... or closing:
> +
> +```javascript
> +this._telemetry.toolOpened("mytoolname");

I think you meant `toolClosed` here

::: devtools/docs/frontend/telemetry.md:152
(Diff revision 1)
> +
> +Go to [about:telemetry](about:telemetry) to see stats relating to your local instance.
> +
> +### Global data
> +
> +Data aggregated from large groups of Firefox users is available at [telemetry.mozilla.org](https://telemetry.mozilla.org). 

nit: mozreview sees a trailing whitespace at the end of this line.

Comment 3

[Soledad Penades [:sole] [:spenades]]

Comment on attachment 8850501 [details]
Bug 1349165 - DevTools: complete documentation gaps for how to add telemetry to panels.

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

Comment 4

[Soledad Penades [:sole] [:spenades]]

Comment on attachment 8850501 [details]
Bug 1349165 - DevTools: complete documentation gaps for how to add telemetry to panels.

https://reviewboard.mozilla.org/r/123100/#review125412

Done too

> I think you meant `toolClosed` here

Fixed!

> nit: mozreview sees a trailing whitespace at the end of this line.

fixed too

Comment 5

[J. Ryan Stinnett [:jryans] (Use needinfo, replies may be slow)]

Comment on attachment 8850501 [details]
Bug 1349165 - DevTools: complete documentation gaps for how to add telemetry to panels.

https://reviewboard.mozilla.org/r/123100/#review125488

Thanks, looks comprehensive to me! :)

Should `telemetry.js` have a comment that points to these docs?

Comment 6

[Soledad Penades [:sole] [:spenades]]

Comment on attachment 8850501 [details]
Bug 1349165 - DevTools: complete documentation gaps for how to add telemetry to panels.

https://reviewboard.mozilla.org/r/123100/#review125488

OMG Yes! I meant to remove the comments in telemetry.js and point them to this file - let me address that before landing. Thanks!

Comment 7

[Soledad Penades [:sole] [:spenades]]

Comment on attachment 8850501 [details]
Bug 1349165 - DevTools: complete documentation gaps for how to add telemetry to panels.

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

Comment 8

[Pulsebot]

Pushed by [e-mail]:
https://hg.mozilla.org/integration/autoland/rev/59db25d0260b
DevTools: complete documentation gaps for how to add telemetry to panels. r=jryans,pbro

Comment 9

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

https://hg.mozilla.org/mozilla-central/rev/59db25d0260b