Skip to content
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

Merged
merged 2 commits into from
Feb 13, 2023
Merged

docs: Tidy the navbar #3339

merged 2 commits into from
Feb 13, 2023

Conversation

Callisto13
Copy link
Contributor

@Callisto13 Callisto13 commented Feb 1, 2023

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.

image (27)

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 🤷‍♀️ .

@Callisto13 Callisto13 added the documentation Improvements or additions to documentation label Feb 1, 2023
@Callisto13 Callisto13 force-pushed the ee-page branch 2 times, most recently from 217af41 to 1769dda Compare February 2, 2023 10:53
@Callisto13 Callisto13 force-pushed the getting-started branch 2 times, most recently from 6e80bf4 to 13580ac Compare February 6, 2023 11:41
{
type: 'doc',
id: 'installation/index',
label: '0. Install Weave GitOps',
Copy link
Member

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?

link: {
type: 'doc',
id: 'installation/weave-gitops-enterprise/index',
id: 'installation/index',
Copy link
Member

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: ".

Copy link
Contributor Author

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

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

image (5)

Looks like this now

Base automatically changed from ee-page to main February 6, 2023 15:36
@Callisto13 Callisto13 force-pushed the getting-started branch 2 times, most recently from d5491d7 to 817113f Compare February 10, 2023 10:49
And break up 'Getting Started'. This layout is inspired by Tilt's docs,
which are often mentioned as Good.
Copy link
Member

@makkes makkes left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Love it! ✨

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants