1399924 - Fix typos and misspelled terms in Telemetry documentation

Status: RESOLVED FIXED

(Toolkit :: Telemetry, enhancement, P1)

Description

[Francesco Lodolo [:flod]]

Noticed at least add-on spelled as addon in a few places. Worth taking a look.

Comment 1

[Francesco Lodolo [:flod]]

Attachment: Bug 1399924 - Fix typos, update feedback instructions in Telemetry documentation

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

Comment 2

[Francesco Lodolo [:flod]]

Comment on attachment 8908261 [details]
Bug 1399924 - Fix typos, update feedback instructions in Telemetry documentation

https://reviewboard.mozilla.org/r/179910/#review185114

::: toolkit/components/telemetry/docs/data/sync-ping.rst:115
(Diff revision 1)
>  ----
>  
>  discarded
>  ~~~~~~~~~
>  
> -The ping may only contain a certain number of entries in the ``"syncs"`` array, currently 500 (it is determined by the ``"services.sync.telemetry.maxPayloadCount"`` preference).  Entries beyond this are discarded, and recorded in the discarded count.
> +The ping may only contain a certain number of entries in the ``"syncs"`` array, currently 500 (it is determined by the ``"services.sync.telemetry.maxPayloadCount"`` preference). Entries beyond this are discarded, and recorded in the discarded count.

If you're wondering, in these 3 sentences I removed the double space after punctuation.

Comment 3

[Georg Fritzsche [:gfritzsche]]

Comment on attachment 8908261 [details]
Bug 1399924 - Fix typos, update feedback instructions in Telemetry documentation

Thanks for looking through all this!
I'm about to head to PTO, so redirecting this review.

Comment 4

[Chris H-C :chutten]

Comment on attachment 8908261 [details]
Bug 1399924 - Fix typos, update feedback instructions in Telemetry documentation

https://reviewboard.mozilla.org/r/179912/#review186184

As much as it pains my en-CA heart to let all the "double-letter to single-letter" en-US conversions slide... I guess we probably should write to a en-US standard, eh?

::: toolkit/components/telemetry/docs/concepts/sessions.rst:37
(Diff revision 1)
>  * specific measurements: histogram & scalar data, etc.
>  
>  This has some advantages:
>  
>  * Latency - Sending a ping with all the data of a subsession immediately after it ends means we get the data from installs faster. For ``main`` pings, we aim to send a ping at least daily by starting a new subsession at local midnight.
> -* Correlation - By starting new subsessions when fundamental settings change (i.e. changes to the *environment*), we can correlate a subsessions data better to those settings.
> +* Correlation - By starting new subsessions when fundamental settings change (i.e. changes to the *environment*), we can correlate a subsession data better to those settings.

Should be "...we can correlate a subsession's data better to those settings"

Or, more formally, grammatically, "...we can better correlate a subsession's data to those settings."

::: toolkit/components/telemetry/docs/data/environment.rst:394
(Diff revision 1)
>  - ``windowsBuildNumber``: the Windows build number.
>  - ``windowsUBR``: the Windows UBR number, only available for Windows >= 10. This value is incremented by Windows cumulative updates patches.
>  - ``installYear``: the Windows only integer representing the year the OS was installed.
>  - ``locale``: the string representing the OS locale.
>  
> -addons
> +add-ons

This is the name of the data section, which is unhyphenated in the JSON representation. I think we'd like to keep it unhyphenated here.

Comment 5

[Francesco Lodolo [:flod]]

(In reply to Chris H-C :chutten from comment #4)
> As much as it pains my en-CA heart to let all the "double-letter to
> single-letter" en-US conversions slide... I guess we probably should write
> to a en-US standard, eh?

That's my take, yes. At least for consistency.

> > -addons
> > +add-ons
> 
> This is the name of the data section, which is unhyphenated in the JSON
> representation. I think we'd like to keep it unhyphenated here.

I kept a few of those unchanged, didn't realize it was the case for this one.

Comment 6

[Francesco Lodolo [:flod]]

Comment on attachment 8908261 [details]
Bug 1399924 - Fix typos, update feedback instructions in Telemetry documentation

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

Comment 7

[Francesco Lodolo [:flod]]

Unrelated changes in https://reviewboard.mozilla.org/r/179912/diff/1-2/ are due to a rebase against master of the bookmark.

Comment 8

[Francesco Lodolo [:flod]]

(In reply to Francesco Lodolo [:flod] from comment #7)
> Unrelated changes in https://reviewboard.mozilla.org/r/179912/diff/1-2/ are
> due to a rebase against master of the bookmark.

Ehm, master -> central. Too much git these days.

Comment 9

[Chris H-C :chutten]

Comment on attachment 8908261 [details]
Bug 1399924 - Fix typos, update feedback instructions in Telemetry documentation

https://reviewboard.mozilla.org/r/179912/#review186508

Comment 10

[Pulsebot]

Pushed by [e-mail]:
https://hg.mozilla.org/integration/autoland/rev/407de8da5b2b
Fix typos, update feedback instructions in Telemetry documentation r=chutten

Comment 11

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

https://hg.mozilla.org/mozilla-central/rev/407de8da5b2b