-
Notifications
You must be signed in to change notification settings - Fork 160
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
docs: Tidy the navbar #3339
docs: Tidy the navbar #3339
Conversation
83302b1
to
06cfc76
Compare
217af41
to
1769dda
Compare
6e80bf4
to
13580ac
Compare
13580ac
to
42323a0
Compare
website/sidebars.js
Outdated
{ | ||
type: 'doc', | ||
id: 'installation/index', | ||
label: '0. Install Weave GitOps', |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I know we're all nerds but are our customers fine with starting to count from 0?
website/sidebars.js
Outdated
link: { | ||
type: 'doc', | ||
id: 'installation/weave-gitops-enterprise/index', | ||
id: 'installation/index', |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Putting my comment here as the page in question isn't changed as part of this PR: The page's title should follow a similar pattern as the "part 1" and "part 2" pages and have a title preceded by "Part 0: ".
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
it does and doesn't make sense to do that.
the installation section is still separate from the getting started section, the getting started just links back to installation in its first.
if i were to pull installation under getting started, then yes having it be part 0 makes sense (i can even 1-index more naturally there). but if we want installation to remain separate (and there is a good case for doing that), then it makes less sense to have titled with a number for people who are coming just to the installation bit
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
d5491d7
to
817113f
Compare
And break up 'Getting Started'. This layout is inspired by Tilt's docs, which are often mentioned as Good.
817113f
to
c874de1
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Love it! ✨
And break up 'Getting Started'. This layout is inspired by Tilt's docs, which are often mentioned as Good. The sidebar here is set to always expanded so they are always visible by default.
This follows changes in #3332 which crowded the navbar and can go in after #3328
Part of weaveworks/weave-gitops-enterprise#2274
The navbar is not versionable which is a right pain, so either we never touch the navbar, or we live with it 🤷♀️ .