Docs: fix parent of WSL.md for the MkDocs sidebar
Nobody has claimed this yet.
Assessment
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Newbie friendliness
- 92/100
- Issue type
- Documentation
- Clarity
- Clearly specified
- Activity status
- Active
- Tech stack
- markdown, yaml
- Domain
- documentation
Research direction
Open docs/WSL.md and inspect its YAML front matter: it currently sets parent: Management Hub. Change that to parent: Installing the management hub only, then check the sibling nav_order values under that section in docs/docs/hub/hub.md to confirm nav_order: 3 places the page after "Getting to know the management hub". Done means the page renders under the intended sidebar section at the intended position.
Written by the indexing model from the issue text.
Description
The docs site (open-horizon/open-horizon.github.io) now pulls docs/ from this repository at build time and builds its sidebar from the title / parent / nav_order front matter.
docs/WSL.md has:
title: Windows WSL2 Installation
nav_order: 3
parent: Management Hub
No page has the title Management Hub, so the page cannot be placed and shows at the top level of the sidebar. The section it belongs to is titled Installing the management hub only.
Fix: change the front matter of docs/WSL.md to:
parent: Installing the management hub only
That title is defined in open-horizon.github.io (docs/docs/hub/hub.md). The sibling nav_order values under it are currently 1, 2, 2, 5 and 6, so also confirm that nav_order: 3 puts the page where you want it. The intended position is after "Getting to know the management hub".
Tracking: open-horizon/open-horizon.github.io#729.
- Dominant language
- Shell
- Stars
- 12
- Forks
- 46
- Avg merge
- 5d 12h
- Merged PRs (30d)
- 3
Getting set up
- No Dockerfile or Docker Compose file
- No pull request template
- Read the contributing guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from open-horizon/devops
-
Difficulty 3/5 1-2 days Newbie friendliness 69/100
open-horizon/devops#235 · 1 comment ·
-
AIO error about `--short` flag in `docker compose version --short` in multiple placesMay be free again @dlarson04 claimed this 95 days ago, and no pull request is open. Openbug
open-horizon/devops#232 · 1 assignee ·
-
bug
Difficulty 3/5 1-2 days Newbie friendliness 66/100
open-horizon/devops#231 ·
-
test-mgmt-hub.sh also failsMay be free again @naphelps claimed this 371 days ago, and no pull request is open. Open
open-horizon/devops#220 · 1 assignee ·
-
Difficulty 4/5 3-5 days Newbie friendliness 35/100
open-horizon/devops#217 ·
All issues in open-horizon/devops
Similar issues
-
Difficulty 1/5 Under an hour Newbie friendliness 92/100
danilogiles/enki-browser#113 ·
Maintainers usually reply within 1 day
-
paraview 6.2.0 uses Abseil 20260526 symbols but does not pin libabseil (undefined symbol with libabseil 20260817)Possibly taken @jschueller claimed this today. Open
Difficulty 2/5 1-3 hours Newbie friendliness 64/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
kaovilai/k8s-cbt-s3mover-demo#144 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 62/100
MezzoSplash/gevechtspel2#124 ·
Maintainers usually reply within 1 day
-
status:needs-review type:bug
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
Gentleman-Programming/engram#2206 ·
Maintainers usually reply within 1 day