Closed
Bug 1309256
Opened 8 years ago
Closed 8 years ago
Add documentation for BrowserUsageTelemetry
Categories
(Toolkit :: Telemetry, defect, P1)
Toolkit
Telemetry
Tracking
()
RESOLVED
FIXED
mozilla52
Tracking | Status | |
---|---|---|
firefox52 | --- | fixed |
People
(Reporter: Dexter, Assigned: Dexter)
References
Details
(Whiteboard: [measurement:client])
Attachments
(1 file, 2 obsolete files)
(deleted),
patch
|
Dexter
:
review+
|
Details | Diff | Splinter Review |
We should probably start documenting BrowserUsageTelemetry and how it behaves/what does it do, especially since we're routing searches through it.
We could start by adding some high level docs to: http://gecko.readthedocs.io/en/latest/browser/browser/index.html
Assignee | ||
Updated•8 years ago
|
Component: Search → Telemetry
Priority: -- → P2
Product: Firefox → Toolkit
Whiteboard: [measurement:client:tracking] → [measurements:client]
Assignee | ||
Updated•8 years ago
|
Whiteboard: [measurements:client] → [measurement:client]
Assignee | ||
Updated•8 years ago
|
Assignee: nobody → alessio.placitelli
Priority: P2 → P1
Assignee | ||
Updated•8 years ago
|
Points: --- → 1
Assignee | ||
Comment 1•8 years ago
|
||
Georg, I'm too much into the domain right now. Do you feel like this docs give a satisfying high level overview of the BrowserUsageModule?
Moreover, should you review this or should :mak/:gijs?
Attachment #8806664 -
Flags: feedback?(gfritzsche)
Assignee | ||
Comment 2•8 years ago
|
||
Comment on attachment 8806664 [details] [diff] [review]
bug1309256.patch
Marco, I'm not sure if you or Georg should review this. Anyway, does it look reasonable to you or is there anything else that you feel should be added to the docs?
Attachment #8806664 -
Flags: feedback?(mak77)
Comment 3•8 years ago
|
||
Comment on attachment 8806664 [details] [diff] [review]
bug1309256.patch
Review of attachment 8806664 [details] [diff] [review]:
-----------------------------------------------------------------
LGTM, I'm honestly not sure how many details we should go into here. It may depend on the expected audience, whether it's technical, analytical or general purpose.
Attachment #8806664 -
Flags: feedback?(mak77) → feedback+
Comment 4•8 years ago
|
||
Comment on attachment 8806664 [details] [diff] [review]
bug1309256.patch
Review of attachment 8806664 [details] [diff] [review]:
-----------------------------------------------------------------
Lets also reference this from the toolkit/components/telemetry docs.
::: browser/docs/BrowserUsageTelemetry.rst
@@ +21,5 @@
> +**Histograms**
> +
> +- *SEARCH_COUNTS*
> +
> +**Scalars**
Instead of listing histograms and scalars, should this talk more about the tasks it does?
E.g. talking about measuring tab & window interactions, uri loads and navigation events (plus example probe references).
Attachment #8806664 -
Flags: feedback?(gfritzsche) → feedback+
Assignee | ||
Comment 5•8 years ago
|
||
Attachment #8806664 -
Attachment is obsolete: true
Attachment #8808220 -
Flags: review?(gfritzsche)
Comment 6•8 years ago
|
||
Comment on attachment 8808220 [details] [diff] [review]
bug1309256.patch
Review of attachment 8808220 [details] [diff] [review]:
-----------------------------------------------------------------
Looks good with the below fixed.
::: toolkit/components/telemetry/docs/data/index.rst
@@ +18,5 @@
> The `mozilla-pipeline-schemas repository <https://github.com/mozilla-services/mozilla-pipeline-schemas/>`_ contains schemas for some of the pings.
> +
> +Browser Usage Telemetry
> +~~~~~~~~~~~~~~~~~~~~~~~
> +For more information, see :ref:`browserusagetelemetry`.
This is probably better listed in docs/collection/index.rst.
Attachment #8808220 -
Flags: review?(gfritzsche) → review+
Assignee | ||
Comment 7•8 years ago
|
||
Attachment #8808220 -
Attachment is obsolete: true
Attachment #8808940 -
Flags: review+
Assignee | ||
Comment 8•8 years ago
|
||
This only updates the in-tree docs, no need for a try push.
Status: NEW → ASSIGNED
Keywords: checkin-needed
Pushed by cbook@mozilla.com:
https://hg.mozilla.org/integration/mozilla-inbound/rev/e9d203fbb3f3
Add documentation for BrowserUsageTelemetry. r=gfritzsche
Keywords: checkin-needed
Comment 10•8 years ago
|
||
bugherder |
Status: ASSIGNED → RESOLVED
Closed: 8 years ago
Resolution: --- → FIXED
Target Milestone: --- → mozilla52
You need to log in
before you can comment on or make changes to this bug.
Description
•