Alphabetize documentation sidenav elements #5080
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…ation.yaml This reverts commit 52a8775.
jmuzina
added
Review: QA needed
Review: Code needed
Review: UX needed
Documentation 📝
Demo
Jenkins 
demos.haus 
bartaz
reviewed
May 7, 2024
side-navigation.yaml
Outdated
| url: /docs/base/typography | ||
| - title: Paper background | ||
| url: /docs/base/paper | ||
| ordering: alphabetical |
There was a problem hiding this comment.
Would it work if we move ordering up one level (alongside heading and subheadings, to avoid additional nesting level of items)?
bartaz
added
Review: QA +1
Review: Code +1 (with changes)
and removed
Review: QA needed
Review: UX needed
Review: Code needed
labels
|
Just a little question/suggestion on the yaml structure, but otherwise great idea. Thanks for the sort implementation. |
bartaz
reviewed
May 7, 2024
side-navigation.yaml
Outdated
| @@ -106,6 +108,7 @@ | |||
| url: /docs/patterns/tabs | |||
| - title: Tooltips | |||
| url: /docs/patterns/tooltips | |||
| ordering: alphabetical | |||
There was a problem hiding this comment.
Small thing, but I'd suggest moving ordering up under heading, so it's clearer what it applies to.
So like:
- heading: Components
ordering: alphabetical
subheadings:
…
There was a problem hiding this comment.
Ordering has been moved accordingly @bartaz
jmuzina
force-pushed
the
sidenav-alphabetical-order
branch
from
c1fe3ca
to
590c9d1
Compare
bartaz
approved these changes
May 7, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Done
@bartaz noticed today that the ordering of items in the side-nav is not alphabetical (as he was expecting it to be). This PR alphabetizes the sidenav items by title using Python, hopefully eliminating the tech debt of manually ensuring the nav items are alphabetized and preventing this sort of issue from arising in the future.
This is configurable in
side-navigation.yamlso that only nav items withordering: alphabeticalhave their subheadings sorted (since there are still some cases where we want fine-grain control over subheading order, such as "Welcome".This results in a few changes to the sidenav ordering vs our current setup:
Closes WD-11052
QA
Check if PR is ready for release
If this PR contains Vanilla SCSS code changes, it should contain the following changes to make sure it's ready for the release:
Feature 🎁,Breaking Change 💣,Bug 🐛,Documentation 📝,Maintenance 🔨.package.jsonshould be updated relative to the most recent release, following semver convention: