Closed Bug 1730029 Opened 3 years ago Closed 2 years ago

[perfdocs] Hierarchy doesn't appear in side bar

Categories

(Testing :: Performance, defect, P3)

defect

Tracking

(firefox97 fixed)

RESOLVED FIXED
97 Branch
Tracking Status
firefox97 --- fixed

People

(Reporter: mcomella, Assigned: sparky)

References

Details

Attachments

(1 file)

Steps to reproduce

Expected

In the side bar, "Raptor" appears highlighted below the "Performance Testing" side bar item

Actual

"Raptor" doesn't appear in the side bar at all and "Performance Testing" is not highlighted.

I don't know if this is by design from how the docs are set up or a generation error. However, I find it confusing that the docs seem orphaned once you select a page from the "Performance Testing" page – it's hard to go back and navigate through them.

The severity field is not set for this bug.
:Sylvestre, could you have a look please?

For more information, please visit auto_nag documentation.

Flags: needinfo?(sledru)

Yeah, I agree it is confusing. I guess it is because it isn't part of the doc tree?!

Alex, it is that something you could help with?

Severity: -- → S3
Flags: needinfo?(sledru) → needinfo?(afinder)

Kimberly: This seems like a valuable improvement we can make to the performance test documentation. The side bar should reflect the documentation structure. What do you think?

Flags: needinfo?(afinder) → needinfo?(ksereduck)

I agree. It seems perfdocs doesn't always behave the way other documentation does (i.e. you can't run ./mach doc testing/raptor to generate only raptor docs)

Flags: needinfo?(ksereduck)
Priority: -- → P3
Component: Documentation Infrastructure → Performance
Product: Firefox Build System → Testing
See Also: → 1675536
Summary: perfdocs hierarchy doesn't appear in side bar → [perfdocs] Hierarchy doesn't appear in side bar

This patch fixes the issue that was preventing the perfdocs hierarchy from being shown. It adds the toctree to the index.rst template and also modifies the generator to insert the required frameworks into the toctree.

Assignee: nobody → gmierz2
Status: NEW → ASSIGNED
Pushed by gmierz2@outlook.com:
https://hg.mozilla.org/integration/autoland/rev/c005aaed5bfb
Show perfdocs hierarchy in the sidebar. r=perftest-reviewers,kimberlythegeek
Status: ASSIGNED → RESOLVED
Closed: 2 years ago
Resolution: --- → FIXED
Target Milestone: --- → 97 Branch
You need to log in before you can comment on or make changes to this bug.

Attachment

General

Created:
Updated:
Size: