Closed Bug 1473603 Opened 2 years ago Closed 2 years ago

Turn "Version History" sections in Data documentation into actual subsections

Categories

(Toolkit :: Telemetry, enhancement, P3)

enhancement

Tracking

()

RESOLVED FIXED
mozilla64
Tracking Status
firefox64 --- fixed

People

(Reporter: janerik, Assigned: Anushi1998, Mentored)

Details

(Whiteboard: [good first bug][lang=rst])

Attachments

(1 file)

Some of the "Version History" sections in the ping descriptions are shown in the Data Documentation ToC, because they are erroneously top-level headings (e.g. [1]).
They should be turned into second-level headings instead.

This is needed for:

- Environment
- main ping
- crash ping
- event ping

[1]: https://searchfox.org/mozilla-central/rev/6ef785903fee6c0b16a1eab79d722373d940fd78/toolkit/components/telemetry/docs/data/main-ping.rst#680
Mentor: jrediger
Whiteboard: [good first bug][lang=rst]
To help Mozilla out with this bug, here's the steps:

0) Comment here on the bug that you want to volunteer to help. I (or someone else) will assign it to you.
1) Download and build the Firefox documentation: 
    For the setup: https://developer.mozilla.org/en-US/docs/Mozilla/Developer_guide/Build_Instructions/Simple_Firefox_build
    Don't do a full build, don't run |./mach build|. 
- If you have any problems, please ask on IRC (https://wiki.mozilla.org/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: https://developer.mozilla.org/en-US/docs/Mozilla/Developer_guide/Introduction
2) Start working on this bug. 
- Open toolkit/components/telemetry/docs/data/environment.rst
- Look for "Version History" and change the line under it from "=" signs to "-" signs
- Do the same for these files:
  toolkit/components/telemetry/docs/data/main-ping.rst
  toolkit/components/telemetry/docs/data/crash-ping.rst
  toolkit/components/telemetry/docs/data/event-ping.rst
- 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 (https://wiki.mozilla.org/Irc) most hours of most days.
3) Build your change with `mach doc` and view your test in the browser (it should automatically open it). Check that in the Telemetry Data Documentation Table of Contents you don't see the "Version History" sections anymore. 
4) Submit the patch (including an automated test, if applicable) for review. Mark me as a reviewer so I'll get an email to come look at your code.
- Here's the guide: https://developer.mozilla.org/en-US/docs/Mozilla/Developer_guide/How_to_Submit_a_Patch
5) After a series of reviews and changes to your patch, I'll mark it for checkin or push it to autoland. Your code will soon be shipping to Firefox users worldwide!
6) ...now you get to think about what kind of bug you'd like to work on next. Let me know what you're interested in and I can help you find your next contribution.
Priority: -- → P3
I would like to work on this bug. thanks
Also can I take 2-3 days as I am out of town?
Hi :janerik 
Can I take on this bug?
Flags: needinfo?(gfritzsche)
Hi :janerik
Can you please explain what you mean by "automated test" in step 4? I have done rest steps and will submit patch asap :)
Attached patch bug1473603.patchSplinter Review
Attachment #9007675 - Flags: review+
Attachment #9007675 - Flags: review+ → review?(gfritzsche)
Assignee: nobody → anushimaheshwari95
Attachment #9007675 - Flags: review?(gfritzsche) → review?(jrediger)
Sorry, I was gone for a bit. Assigned it to you and assigned the review to me. Will get to it today.
There is no need for automated tests for this bug, you can ignore that statement.
Flags: needinfo?(gfritzsche)
Attachment #9007675 - Flags: review?(jrediger) → review+
Keywords: checkin-needed
janerik: Sure, thanks :)
Pushed by ebalazs@mozilla.com:
https://hg.mozilla.org/integration/mozilla-inbound/rev/b2d727e72cd8
Changed "Version History" sections in Data Documentation into secondary-level headings. r=janerik
Keywords: checkin-needed
https://hg.mozilla.org/mozilla-central/rev/b2d727e72cd8
Status: NEW → RESOLVED
Closed: 2 years ago
Resolution: --- → FIXED
Target Milestone: --- → mozilla64
You need to log in before you can comment on or make changes to this bug.