1402249 - Add the first-session-shutdown document to the TOC

Status: RESOLVED FIXED

(Toolkit :: Telemetry, enhancement, P1)

Description

[Alessio Placitelli [:Dexter]]

When building the docs locally, I get the following error:

> checking consistency...
> /home/.../telemetry/data/first-shutdown.rst: WARNING: document isn't included in any toctree

We should add the reference to [1] and make sure the error goes away by checking the output of

> ./mach doc

[1] - https://dxr.mozilla.org/mozilla-central/source/toolkit/components/telemetry/docs/data/index.rst

Comment 1

[Alessio Placitelli [:Dexter]]

Anthony, sorry for not catching this during the review: do you mind taking this up?

Comment 2

[Anthony Miyaguchi [:amiyaguchi]]

Attachment: Add the first-session-shutdown document to the TOC

Comment 3

[Alessio Placitelli [:Dexter]]

Comment on attachment 8911274 [details] [diff] [review]
Add the first-session-shutdown document to the TOC

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

::: toolkit/components/telemetry/docs/data/index.rst
@@ +15,4 @@
>     backgroundhangmonitor-ping
>     anonymous-ping
>     *-ping
> +   first-shutdown

Please move this above the *-ping entry.

Comment 4

[Anthony Miyaguchi [:amiyaguchi]]

Attachment: Add the first-session-shutdown document to the TOC

Comment 5

[Alessio Placitelli [:Dexter]]

Comment on attachment 8912067 [details] [diff] [review]
Add the first-session-shutdown document to the TOC

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

Thanks Anthony! Only one note: next time you rename a file, use "hg rename" because it will retain the file history. It's not a problem for this since there wasn't much action on this file :)

Comment 6

[Pulsebot]

Pushed by [e-mail]:
https://hg.mozilla.org/integration/mozilla-inbound/rev/aef322779c5d
Add the first-session-shutdown document to the TOC. r=Dexter

Comment 7

[Sebastian Hengst [:aryx] (needinfo me if it's about an intermittent or backout)]

https://hg.mozilla.org/mozilla-central/rev/aef322779c5d