1436786 - Link to DTMO from ReadTheDocs

Status: RESOLVED FIXED

(Toolkit :: Telemetry, enhancement, P1)

Description

[Ryan Harter [:harter]]

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

Comment 1

[Georg Fritzsche [: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?

Comment 2

[Ryan Harter [:harter]]

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?

Comment 3

[Georg Fritzsche [: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.

Comment 4

[Jan-Erik Rediger [:janerik]]

Attachment: Link to DTMO from main Telemetry documentation

Comment 5

[Georg Fritzsche [:gfritzsche]]

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.

Comment 6

[Jan-Erik Rediger [:janerik]]

I'm fine with moving it into the start chapter under its own heading.
The changed sentence sounds much better as well.

Comment 7

[Jan-Erik Rediger [:janerik]]

Attachment: Link to DTMO from main Telemetry documentation

Comment 8

[Jan-Erik Rediger [:janerik]]

Attachment: Link to DTMO from main Telemetry documentation

Comment 9

[Georg Fritzsche [: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.

Comment 10

[Jan-Erik Rediger [:janerik]]

Attachment: Link to DTMO from main Telemetry documentation

Comment 11

[Jan-Erik Rediger [:janerik]]

Attachment: Link to DTMO from main Telemetry documentation

Comment 12

[Pulsebot]

Pushed by [e-mail]:
https://hg.mozilla.org/integration/mozilla-inbound/rev/c0f166bfad30
Link to DTMO from main Telemetry documentation. r=gfritzsche

Comment 13

[Cristian Brindusan [:cbrindusan]]

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