1451351 - Move obsolete documentation to subfolder

Status: RESOLVED FIXED

(Toolkit :: Telemetry, enhancement, P3)

Description

[Jan-Erik Rediger [:janerik] (Away until 2024-12-23)]

We should move obsolete documentation to a subfolder below the Telemetry documentation.

This currently includes:

- browser/docs/UITelemetry.rst
- toolkit/components/telemetry/docs/fhr/index.rst

Comment 1

[Chris H-C :chutten]

We can make this a mentored good second bug, I think?

Comment 2

[Jan-Erik Rediger [:janerik] (Away until 2024-12-23)]

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 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. 

Create a new directory named `obsolete` under `toolkit/components/telemetry/docs/`
Create a file named `index.rst` in that directory and add the heading `Obsolete Documentation` and add the Table of Contents (see `toolkit/components/telemetry/docs/data/index.rst` for an example of the syntax)
Copy over the `fhr` directory, create a new folder `uitelemetry` and copy over `browser/docs/UITelemetry.rst` as `index.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`. Open the documentation in the browser and check that the documentation is readable and linked from the sidebar and the table of contents of the subsection. 
4) Submit the patch 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.

Comment 3

[Issei Horie [:is2ei]]

Hi,
Could I work on this issue?

Comment 4

[Jan-Erik Rediger [:janerik] (Away until 2024-12-23)]

Yes, please. The instructions should be pretty clear already. If you have questions please ping me.

Comment 5

[Issei Horie [:is2ei]]

Attachment: bug-1451351.patch

I attached a patch.
Could you review it, please? Thanks!

Comment 6

[Jan-Erik Rediger [:janerik] (Away until 2024-12-23)]

Comment on attachment 8973490 [details] [diff] [review]
bug-1451351.patch

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

Sorry, in the initial instructions I failed to make it clear that the old files can be removed. That's on me.
Could you remove the now-old `browser/docs/UITelemetry.rst` file and the `toolkit/components/telemetry/docs/fhr` directory?

::: toolkit/components/telemetry/docs/obsolete/index.rst
@@ +7,5 @@
> +.. toctree::
> +   :maxdepth: 5
> +   :titlesonly:
> +
> +   uitelemetry/index   

There are trailing spaces here at the end. Please remove them.

Comment 7

[Issei Horie [:is2ei]]

Attachment: bug-1451351.patch

Thanks! I forgot to run "addremove".
I fixed the patch. Could you review it, please?

Comment 8

[Jan-Erik Rediger [:janerik] (Away until 2024-12-23)]

Comment on attachment 8973998 [details] [diff] [review]
bug-1451351.patch

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

Thanks! That looks good. I will mark this for check-in now and it will then land sometime soon.

Comment 9

[Pulsebot]

Pushed by [e-mail]:
https://hg.mozilla.org/integration/mozilla-inbound/rev/a36ab577057d
Move obsolete documentation to subfolder. r=janerik

Comment 10

[Eliza Balazs [:ebalazs_]]

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