Closed Bug 1455353 Opened 3 years ago Closed 3 years ago

Fix sphinx warnings in Telemetry documentation

Categories

(Toolkit :: Telemetry, enhancement, P3)

enhancement

Tracking

()

RESOLVED FIXED
mozilla61
Tracking Status
firefox61 --- fixed

People

(Reporter: chutten, Assigned: is2ei, Mentored)

Details

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

Attachments

(1 file)

There are a lot of warnings when running ./mach doc. Some of them are in Telemetry documentation. We can fix them.

Specifically:
$ ./mach doc 2> >(grep elemetry) 1> /dev/null
/home/chutten/mozilla-central/obj-debug-x86_64-pc-linux-gnu/docs/html/main/_staging/toolkit/components/telemetry/telemetry/start/adding-a-new-probe.rst:3: WARNING: Duplicate explicit target name: "data collection review".
/home/chutten/mozilla-central/obj-debug-x86_64-pc-linux-gnu/docs/html/main/_staging/toolkit/components/telemetry/telemetry/fhr/dataformat.rst:1997: WARNING: Definition list ends without a blank line; unexpected unindent.
/home/chutten/mozilla-central/obj-debug-x86_64-pc-linux-gnu/docs/html/main/_staging/toolkit/components/telemetry/telemetry/data/health-ping.rst:3: WARNING: Duplicate explicit target name: "mdn".
/home/chutten/mozilla-central/obj-debug-x86_64-pc-linux-gnu/docs/html/main/_staging/toolkit/components/telemetry/telemetry/collection/histograms.rst:108: WARNING: Could not lex literal_block as "json". Highlighting skipped.
/home/chutten/mozilla-central/obj-debug-x86_64-pc-linux-gnu/docs/html/main/_staging/toolkit/components/telemetry/telemetry/collection/hybrid-content.rst:32: WARNING: Pygments lexer name u'csv' is not known
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 source code: https://developer.mozilla.org/en-US/docs/Mozilla/Developer_guide/Build_Instructions/Simple_Firefox_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. You will need to fix the errors as mentioned in comment#22. To run ./mach doc you will need a Linux or Mac build (Windows support for ./mach doc isn't quite complete)
- 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 build` and test your change with `mach test toolkit/components/telemetry/tests/`. Also check your changes for adherence to our style guidelines by using `mach lint`
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
Whiteboard: [lang=rst] → [good first bug][lang=rst]
Eurgh, I didn't mean comment#22, I meant "in the summary"
Hello

Can I work on this issue?
Flags: needinfo?(chutten)
You certainly may. Please let me know if you have any problems.

...oh wait, Step 3 isn't so relevant here. For Step 3 you build by running `./mach doc` and you test by running `./mach doc 2> >(grep elemetry) 1> /dev/null` and seeing if there is any output.
Assignee: nobody → is2ei.horie
Status: NEW → ASSIGNED
Flags: needinfo?(chutten)
Thanks for the info!
I create a patch. Could you review it, please?
Attachment #8969881 - Flags: review?(chutten)
Comment on attachment 8969881 [details] [diff] [review]
bug-1455353.patch

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

Looks good! I'm going to take this patch for a spin before I put it up for checkin so I can see how it looks. That'll have to happen tomorrow because I'm on Windows today :S

But we can consider this patch done in the meantime. What did you have in mind for what you'd like to work on next?
Attachment #8969881 - Flags: review?(chutten) → review+
Flags: needinfo?(chutten)
(In reply to Chris H-C :chutten from comment #6)
> Comment on attachment 8969881 [details] [diff] [review]
> bug-1455353.patch
> 
> Review of attachment 8969881 [details] [diff] [review]:
> -----------------------------------------------------------------
> 
> Looks good! I'm going to take this patch for a spin before I put it up for
> checkin so I can see how it looks. That'll have to happen tomorrow because
> I'm on Windows today :S
> 
> But we can consider this patch done in the meantime. What did you have in
> mind for what you'd like to work on next?

Thanks! I haven't decide what I will work on next...
Is there any issue for beginner? :)
Looks good on my local, let's get this in.

And it looks like you found your next bug already, good work.
Flags: needinfo?(chutten)
Keywords: checkin-needed
Pushed by cbrindusan@mozilla.com:
https://hg.mozilla.org/integration/mozilla-inbound/rev/766dd36bfd6d
Fix sphinx warnings in Telemetry documentation r=chutten
Keywords: checkin-needed
https://hg.mozilla.org/mozilla-central/rev/766dd36bfd6d
Status: ASSIGNED → RESOLVED
Closed: 3 years ago
Resolution: --- → FIXED
Target Milestone: --- → mozilla61
You need to log in before you can comment on or make changes to this bug.