1937656 - [meta] Make it easier for someone viewing a job on try to find documentation on a performance test

Status: NEW

(Testing :: Performance, enhancement, P2)

Description

[Andrej (:aglavic)]

This was feedback taken from the performance team during our Android Performance Weekly checkin
The issue at hand was the team was trying to figure out from a try job, how to find the commands to run the test
I knew that the documentation could be found on mozilla source docs under the raptor and talos performance documentation sections of a job
However, infrequent users, or simply non-power users have no reasonable way to find how to run a job locally from a try job
The gap between documentation on how to run a job and those jobs on try needs to be a small as possible so people who want to know how to run a job locally can do so easily and intuitively

Comment 1

[Greg Mierzwinski [:sparky]]

We already link to the documentation from the performance tab so I'm not sure what else could be done there. Maybe they need to be made aware of that?

We have some code available in mozperftest now though (through the alert layer) which could allow us to have a task name passed in and run the exact command the CI test runs.

Comment 2

[Andrej (:aglavic)]

I guess I was envisioning a little question mark to appear on treeherder near the job name, that links to a general documentation on how to run locally

Comment 3

[Greg Mierzwinski [:sparky]]

How different would that be from the link to the test from the performance tab? The reason I ask is because the test docs linked already contain a command that can be used to run the test.

Comment 4

[Andrej (:aglavic)]

Then I think this bug should be changed to understand why the applink startup test does not have that hyperlink appearing

Comment 5

[Greg Mierzwinski [:sparky]]

Ah ok, seems like we have a good bit of work to do there. They should be found here, but I don't see the applink tests there: https://firefox-source-docs.mozilla.org/testing/perfdocs/mozperftest.html

Is the folder that contains the test specified in the mozperftest perfdocs config.yml file?

Comment 6

[Andrej (:aglavic)]

it also looks like the links in the performance docs are not working properly, I'll put in a patch to fix that

Comment 7

[Andrej (:aglavic)]

Link in performance tab:
https://firefox-source-docs.mozilla.org/testing/perfdocs/raptor.html#speedometer3-d
Link that works:
https://firefox-source-docs.mozilla.org/testing/perfdocs/raptor.html#speedometer3-b

Comment 8

[Andrej (:aglavic)]

The link in the performance tab just links to the top of the page, and the one that works opens the specific job

Comment 9

[Greg Mierzwinski [:sparky]]

(In reply to Andrej (:aglavic) from comment #8)

The link in the performance tab just links to the top of the page, and the one that works opens the specific job

There's a few tests that this happens with (not just sp3). I think it's something related to duplicate headings, or the headings are not being created correctly in perfdocs.