1532652 - Scalar in-tree documentation contains dead link

Status: RESOLVED FIXED

(Toolkit :: Telemetry, enhancement, P3)

Description

[Mirko Brodesser (:mbrodesser-Igalia), offline until 8th of October]

https://firefox-source-docs.mozilla.org/toolkit/components/telemetry/telemetry/collection/scalars.html contains a link to https://dxr.mozilla.org/mozilla-central/source/toolkit/components/telemetry/Telemetry.h, which doesn't exist. It should be https://dxr.mozilla.org/mozilla-central/source/toolkit/components/telemetry/core/Telemetry.h instead.

Comment 1

[Chris H-C :chutten]

Set it up as mentored by Alessio

Comment 2

[Chris H-C :chutten]

To help Mozilla out with this bug, here's the steps:

1. Comment here on the bug that you want to volunteer to help. The bug mentor (or someone else) will assign it to you.
2. Download and build the Firefox source code
   • If you have any problems, please ask on IRC in the #introduction channel. They're there to help you get started.
   • You can also read the Developer Guide, which has answers to most development questions:
3. Start working on this bug. You'll be editing the link in toolkit/components/telemetry/docs/collection/scalars.html that points to Telemetry.h to point to https://hg.mozilla.org/mozilla-central/file/tip/toolkit/components/telemetry/core/Telemetry.h
   • If you have any problems with this bug, please comment on this bug and set the needinfo flag for me. Also, you can find me and my teammates on the #telemetry channel on IRC most hours of most days.
4. Build your change with mach doc and test your change by opening the Scalar doc within the opened window and ensuring the link displays properly and works properly.
5. Submit the patch for review. Mark the mentor as a reviewer so they'll get an email to come look at your code.
   • How to Submit a Patch
6. After a series of reviews and changes to your patch, the mentor'll mark it for checkin or push it to autoland. Your code will soon be shipping to Firefox users worldwide!
7. ...now you get to think about what kind of bug you'd like to work on next. Let us know what you're interested in and we can help you find your next contribution.

Comment 3

[clement.allain]

Hello ! I am new here and I would like give this bug a try.

Just a question, the author suggests pointing the link to dxr.mozilla.org whereas Chris suggests hg.mozilla.org.
As I do not have the background and both link works, and because every other links in this scalars.html point to dxr, I'd choose dxr, am I right ?

Comment 4

[Chris H-C :chutten]

Great! I'll assign it to you.

I recommended hg.mozilla.org because that is the canonical source of where source code lives. DXR is a tool built on top of the source code repository to make it searchable.

Whichever you prefer is ultimately fine. Your reason is an excellent reason for choosing DXR.

Comment 5

[clement.allain]

Attachment: Bug 1532652: Fix telemetry source code links in Scalars documentation

Comment 6

[Pulsebot]

Pushed by [e-mail]:
https://hg.mozilla.org/integration/autoland/rev/91936ad1c3f1
Fix telemetry source code links in Scalars documentation r=janerik

Comment 7

[Stefan Hindli [:stefan_hindli]]

https://hg.mozilla.org/mozilla-central/rev/91936ad1c3f1