1380766 - Remove mentions of Firefox Hello and loop from webrtc telemetry docs

Status: RESOLVED FIXED

(Toolkit :: Telemetry, enhancement, P4)

Description

[Chris H-C :chutten]

The webrtc portion of the "main" ping docs at [1] contain references to Firefox Hello (also known as "loop").

We can remove those references, as we don't collect any data about it anymore (see bug 1306631). (In fact, I don't think the product exists any more).

http://gecko.readthedocs.io/en/latest/toolkit/components/telemetry/telemetry/data/main-ping.html#webrtc

Comment 1

[vikram]

I'll will give it try. But any guidelines/first-steps to be followed. This is my first one.

Comment 2

[Chris H-C :chutten]

Excellent!

First things first, you must get a copy of the source code and be able to successfully build it. There are lovely guides on MDN ( like this one: https://developer.mozilla.org/en-US/docs/Mozilla/Developer_guide/Introduction ) and if you join IRC ( https://wiki.mozilla.org/Irc ) the channel #introduction is filled with people that can help you out.

From there it is a matter of editing toolkit/components/telemetry/docs/data/main-ping.rst so that the "webrtc" section no longer mentions Firefox Hello or loop.

Continue following the developer guide for instructions for how to submit a patch for review and mark me as a reviewer.

Once it's ready, we'll land your patch so that your improvement can start helping people as soon as possible.

Please let me know if you have any further questions.

Comment 3

[vikram]

Thanks. I'll have an update within few days.

Comment 4

[vikram]

Sorry I'm unable to download mozilla build due to space issues in my Laptop. Please assign to somebody else.

Comment 5

[Chris H-C :chutten]

That's okay, thank you for trying!

Comment 6

[rajeev29five]

I would like to work on this. I have the source code . What do I need to do next?

Comment 7

[Alessio Placitelli [:Dexter]]

(In reply to rajeev29five from comment #6)
> I would like to work on this. I have the source code . What do I need to do
> next?

Hi Rajeev!

I've assigned the bug to you, please see comment 2 for a description of the task. Let us know if you have any question!

Comment 8

[rajeev29five]

Attachment: main-ping.rst

Comment 9

[rajeev29five]

Comment on attachment 8896558 [details]
main-ping.rst

Sorry made mistake of attaching the source file.

Comment 10

[sajattack]

Rajeev, I think you're supposed to submit the patch through version control. See https://developer.mozilla.org/en-US/docs/Mozilla/Developer_guide/How_to_Submit_a_Patch

Comment 11

[rajeev29five]

Sorry I had little problem with my laptop and had to build firefox again. I'll submit the patch for review in a day or two.

Comment 12

[akriti verma]

hi, I want to work on this bug. Can you assign this to me.

Comment 13

[Chris H-C :chutten]

Sorry, akriti, it seems as though rajeev is still working on this one. We have other bugs you can try your hand at, however! Have you seen Bugs Ahoy? https://www.joshmatthews.net/bugsahoy/

Comment 14

[rajeev29five]

Sorry, I won't be able to submit the patch, my laptop broke down :( .Please assign this bug to someone else.

Comment 15

[Chris H-C :chutten]

I'm sorry to hear that! I hope things work out.

akriti verma, are you still interested in working on this bug?

Comment 16

[akriti verma]

Yes I will work on it.Thanks.

Comment 17

[akriti verma]

Hi Chris ,
I tried opening this link : http://gecko.readthedocs.io/en/latest/toolkit/components/telemetry/telemetry/data/main-ping.html#webrtc 
but it says "The page does not exist".

Comment 18

[Alessio Placitelli [:Dexter]]

(In reply to akriti verma from comment #17)
> Hi Chris ,
> I tried opening this link :
> http://gecko.readthedocs.io/en/latest/toolkit/components/telemetry/telemetry/
> data/main-ping.html#webrtc 
> but it says "The page does not exist".

Hi Akriti,

we had a few problems with the docs lately. They were migrated to a new location, here's the updated link: https://firefox-source-docs.mozilla.org/toolkit/components/telemetry/telemetry/data/main-ping.html#webrtc

Comment 19

[akriti verma]

Attachment: Bug 1380766 - Removed mentions of Firefox Hello and loop from webrtc telemetry docs.

Review commit: https://reviewboard.mozilla.org/r/172902/diff/#index_header
See other reviews: https://reviewboard.mozilla.org/r/172902/

Comment 20

[Chris H-C :chutten]

Comment on attachment 8901418 [details]
Bug 1380766 - Removed mentions of Firefox Hello and loop from webrtc telemetry docs.

https://reviewboard.mozilla.org/r/172902/#review178602

::: toolkit/components/telemetry/docs/data/main-ping.rst:431
(Diff revision 1)
>  Contains special statistics gathered by WebRTC related components.
>  
>  So far only a bitmask for the ICE candidate type present in a successful or
>  failed WebRTC connection is getting reported through C++ code as
>  IceCandidatesStats, because the required bitmask is too big to be represented
>  in a regular enum histogram. Further this data differentiates between Loop

There remains at least one reference in this file to Loop/Hello. Take a look around and make sure that you remove them all.

Comment 21

[akriti verma]

Hi Chris,
Is there a way to download just one file from the mozilla-central repository , in case an important file is accidentally deleted or edited. I checked the repository on github but i only see "Readme".

Comment 22

[Chris H-C :chutten]

If you are using git or hg, you already have all of the files locally in the "local repository" and you should be able to restore your state from it very quickly.

In git a command to restore your files to the state they were in the last time you made a commit would be `git reset --hard HEAD` (commanding git to `reset` your files to the most recent commit (HEAD) without saving your intermediate state (hard reset))

In hg I think a command to do this would be `hg revert --all`. I'm not an hg person usually, so you might benefit by asking on the #introduction IRC channel (https://wiki.mozilla.org/Irc contains instructions) for some real-time assistance.

Comment 23

[akriti verma]

Comment on attachment 8901418 [details]
Bug 1380766 - Removed mentions of Firefox Hello and loop from webrtc telemetry docs.

Review request updated; see interdiff: https://reviewboard.mozilla.org/r/172902/diff/1-2/

Comment 24

[Chris H-C :chutten]

Comment on attachment 8901418 [details]
Bug 1380766 - Removed mentions of Firefox Hello and loop from webrtc telemetry docs.

https://reviewboard.mozilla.org/r/172902/#review180096

::: toolkit/components/telemetry/docs/data/main-ping.rst:430
(Diff revision 2)
>  Contains special statistics gathered by WebRTC related components.
>  
>  So far only a bitmask for the ICE candidate type present in a successful or
>  failed WebRTC connection is getting reported through C++ code as
>  IceCandidatesStats, because the required bitmask is too big to be represented
> -in a regular enum histogram. Further this data differentiates between Loop
> +in a regular enum histogram. 

Can you remove this end-of-line whitespace?

::: toolkit/components/telemetry/docs/data/main-ping.rst:432
(Diff revision 2)
>  IceCandidatesStats, because the required bitmask is too big to be represented
> -in a regular enum histogram. Further this data differentiates between Loop
> +in a regular enum histogram. 
> -(aka Firefox Hello) connections and everything else, which is categorized as
> -WebRTC.
>  
> -Note: in most cases the webrtc and loop dictionaries inside of
> +Note: in most cases the webrtc dictionaries inside of

"dictionaries" should become singular, "dictionary"

Comment 25

[akriti verma]

Comment on attachment 8901418 [details]
Bug 1380766 - Removed mentions of Firefox Hello and loop from webrtc telemetry docs.

Review request updated; see interdiff: https://reviewboard.mozilla.org/r/172902/diff/2-3/

Comment 26

[Chris H-C :chutten]

Comment on attachment 8901418 [details]
Bug 1380766 - Removed mentions of Firefox Hello and loop from webrtc telemetry docs.

https://reviewboard.mozilla.org/r/172902/#review180522

Just restore the previous, excellent, commit message and this will be good to go.

::: commit-message-0f3a3:1
(Diff revision 3)
> +Bug 1380766 - New Patch

Needs a proper commit message. Your "Removed mentions of Firefox Hello and loop from webrtc telemetry docs." was excellent.

If you'd like some reading on why commit messages are important and some good examples (though not exactly mozilla-central specific) I recommend reading https://chris.beams.io/posts/git-commit/

Comment 27

[akriti verma]

Comment on attachment 8901418 [details]
Bug 1380766 - Removed mentions of Firefox Hello and loop from webrtc telemetry docs.

Review request updated; see interdiff: https://reviewboard.mozilla.org/r/172902/diff/3-4/

Comment 28

[akriti verma]

hi Chris,
As advised by you i have changed the commit message.

Comment 29

[Pulsebot]

Pushed by [e-mail]:
https://hg.mozilla.org/integration/autoland/rev/12176fca6b3a
Removed mentions of Firefox Hello and loop from webrtc telemetry docs. r=chutten

Comment 30

[Chris H-C :chutten]

Thank you very much! I have triggered your commit to push in to autoland. This usually means that it will be in the next build of Firefox and the source documentation should be online shortly thereafter.

Do you need help finding another bug to work on? I find Bugs Ahoy is very good at showing good first bugs: https://www.joshmatthews.net/bugsahoy/

Comment 31

[Wes Kocher (:KWierso) (Not reading bugmail; email directly if needed)]

https://hg.mozilla.org/mozilla-central/rev/12176fca6b3a

Comment 32

[akriti verma]

Hi Chris ,
Can you help me find another bug related to telemetry?

Comment 33

[Chris H-C :chutten]

Certainly. Let's see... what do you think about bug 972324? It's available. It's about ensuring that if anything would break data collection at the server, it would fail a test on Firefox first.