1633418 - [perfdocs] Add the ability to include static content

Status: RESOLVED FIXED

(Testing :: Performance, task, P1)

Description

[Alexandru Ionescu (needinfo me) [:alexandrui]]

Bug 1632111 needs to add some static content to the content generated by perfdocs. This bug adds the ability to specify the static content from tree to be added alongside with the fetched one.

Comment 1

[Greg Mierzwinski [:sparky]]

Hi :myeongjun :)

As we discussed in our meeting on Monday, I think this would be a good next bug for you.

What we'll want to start with is discovering any extra .rst files in the perfdocs folder and gathering them into the matched dict under the field static (or some other name): https://searchfox.org/mozilla-central/source/tools/lint/perfdocs/gatherer.py#73-85

To test this, you can add a random .rst file in the raptor perfdocs folder (you can link it to the index.rst file in a similar way to how we make the main page, i.e. use the :doc: label).

Next step will be to get those static listed files into the generated folder. You'll have to start by modifying this code to get frameworks_info to hold both the generated page, as well as the static pages: https://searchfox.org/mozilla-central/source/tools/lint/perfdocs/generator.py#79-114

Finally, you'll have to save those files to the generated folder here: https://searchfox.org/mozilla-central/source/tools/lint/perfdocs/generator.py#150-161

This is a bigger issue than your last few bugs so just take it one step at a time and you'll solve it in no time :)
Let me know if you hit any issues or have any questions about it!

Comment 2

[Myeongjun Go]

Thanks guiding :)
I'll go over it and ask you again if I have any questions. Maybe, I gonna ask you for checking :)

Comment 3

[Myeongjun Go]

Hello sparky :)
I want to check what I understand.
After this issue is solved, If I (or someone) make .rst(e.g, random.rst) file and add label(e.g, :doc:random), User could watch docs(e.g, random and raptor that exists now) on web page?
If I understand it correctly, I gonna start working on it.
Thanks.

Comment 4

[Greg Mierzwinski [:sparky]]

Hi Jun, yes exactly! :)

Comment 5

[Myeongjun Go]

Attachment: Bug 1633418 - [Perfdocs] Add the ability to include static content into perfdocs r=sparky

Comment 6

[Pulsebot]

Pushed by [e-mail]:
https://hg.mozilla.org/integration/autoland/rev/30bd0450a381
[Perfdocs] Add the ability to include static content into perfdocs r=sparky,perftest-reviewers

Comment 7

[Atila Butkovits]

https://hg.mozilla.org/mozilla-central/rev/30bd0450a381