1478711 - Docs table of contents sidebar is displaying the wrong headings

Status: RESOLVED FIXED

(Tree Management :: Treeherder, defect, P1)

Description

[Ed Morley [:emorley]]

Subheadings from certain pages are being bubbled up to the top navigation, making the links pretty confusing.

Comment 1

[GitHub Bugzilla PR Linker]

Attachment: Link to GitHub pull-request: https://github.com/mozilla/treeherder/pull/3835

Comment 2

[Treeherder GitHub Bugbot]

Commits pushed to master at https://github.com/mozilla/treeherder

https://github.com/mozilla/treeherder/commit/d3c18b3bc53025f1ca4f69540d701b14319716d3
Bug 1478711 - Correct docs build directory path in .gitignore

After the move in #3813.

https://github.com/mozilla/treeherder/commit/6c2f305ac083afa4500e6f546c0e5574599f37ce
Bug 1478711 - Vagrant: Open port 8001 for sphinx-autobuild

Since the port was changed in #3813 from 8000 to 8001 (presumably so
it didn't clash with Virtualbox when run directly from the guest),
however this broke running the docs from inside the VM (for those
who don't want to install the docs dependencies on the host).

https://github.com/mozilla/treeherder/commit/78c2c57fc9c3bf014a5016ff46e885a41ddefba8
Bug 1478711 - Docs: Fix navigation links

Previously the mixture of heading types was confusing the RTD theme,
causing the navigation sidebar to display at the top level not just
the page links, but links to subsections within those pages too.
The subsection names taken out of context were pretty confusing,
making it hard to navigate the docs.

https://github.com/mozilla/treeherder/commit/bcffd1ce3e96ffc9405dc223807f5bdfa5dcfc3d
Bug 1478711 - Docs: Correct out of date UI testing advice

* The tests can now be run inside the VM.
* There is no longer a coverage report output.

https://github.com/mozilla/treeherder/commit/7f5e7c0643cc18a31acbef62c27fd5dae93d0866
Bug 1478711 - Docs: Fix SETA typos