Closed Bug 1436786 Opened 4 years ago Closed 4 years ago

Link to DTMO from ReadTheDocs

Categories

(Toolkit :: Telemetry, enhancement, P1)

x86_64
Linux
enhancement
Points:
1

Tracking

()

RESOLVED FIXED
mozilla61
Tracking Status
firefox61 --- fixed

People

(Reporter: harter, Assigned: janerik)

Details

Attachments

(1 file, 4 obsolete files)

During the experimentation summit, someone noted that it's difficult to discover DTMO if you're looking at the Mozilla Source Tree Docs [1]. Can we add a link to DTMO from this documentation?


[1] https://firefox-source-docs.mozilla.org/toolkit/components/telemetry/telemetry/data/index.html
Flags: needinfo?(gfritzsche)
That is a good point, the in-tree docs are a bit disconnected.
We should probably mention both TMO (as portal) and DTMO prominently.
Any suggestions on where?

Adding a section to "Getting started" with forward references should probably be good.
Adding some linkage around individual other pages could be useful?
Flags: needinfo?(gfritzsche)
Assignee: gfritzsche → nobody
Flags: needinfo?(rharter)
Linking from "Getting Started" makes sense to me. I'd probably add a full section named "Further Reading" under the "Telemetry" heading.

Who should be responsible for executing this change, Georg?
Flags: needinfo?(rharter) → needinfo?(gfritzsche)
Cheers, that makes sense.
While we're at it, we might want to add other forward links there as well like to the Telemetry portal.

I'll make this show up in our triage, then we can line it up to work on.
Flags: needinfo?(gfritzsche)
Whiteboard: [measurement:client]
Component: Documentation and Knowledge Repo (RTMO) → Telemetry
Product: Data Platform and Tools → Toolkit
Whiteboard: [measurement:client]
Assignee: nobody → jrediger
Priority: P2 → P1
Comment on attachment 8958848 [details] [diff] [review]
Link to DTMO from main Telemetry documentation

Review of attachment 8958848 [details] [diff] [review]:
-----------------------------------------------------------------

The content looks good.
I think this should live in docs/start though. Can we just put it in docs/start/index.rst for now?

::: toolkit/components/telemetry/docs/further_reading/index.rst
@@ +1,5 @@
> +===============
> +Further Reading
> +===============
> +
> +* `Telemetry Landing Page <https://telemetry.mozilla.org/>`_ - Measurement Dashboards, Tools, Documentation

"Discover all important resources for working with data."?
That's what we're trying to achieve with the page now.
Attachment #8958848 - Flags: review?(gfritzsche)
I'm fine with moving it into the start chapter under its own heading.
The changed sentence sounds much better as well.
Attachment #8958848 - Attachment is obsolete: true
Attachment #8958953 - Attachment is obsolete: true
Attachment #8958953 - Flags: review?(gfritzsche)
Comment on attachment 8958954 [details] [diff] [review]
Link to DTMO from main Telemetry documentation

Review of attachment 8958954 [details] [diff] [review]:
-----------------------------------------------------------------

Thanks!

::: toolkit/components/telemetry/docs/start/index.rst
@@ +11,5 @@
> +
> +Further Reading
> +###############
> +
> +* `Telemetry Landing Page <https://telemetry.mozilla.org/>`_ - Discover all important resources for working with data

One last request: Let's call it "Telemetry portal".
I'm trying to establish that naming, it's more clear and shorter.
Attachment #8958954 - Flags: review?(gfritzsche) → review+
Attachment #8958954 - Attachment is obsolete: true
Attachment #8959134 - Attachment is obsolete: true
Pushed by ryanvm@gmail.com:
https://hg.mozilla.org/integration/mozilla-inbound/rev/c0f166bfad30
Link to DTMO from main Telemetry documentation. r=gfritzsche
Keywords: checkin-needed
https://hg.mozilla.org/mozilla-central/rev/c0f166bfad30
Status: NEW → RESOLVED
Closed: 4 years ago
Resolution: --- → FIXED
Target Milestone: --- → mozilla61
You need to log in before you can comment on or make changes to this bug.