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

Add multi-version support #114

Merged
merged 8 commits into from
Jan 24, 2020
Merged

Add multi-version support #114

merged 8 commits into from
Jan 24, 2020

Conversation

Hoverbear
Copy link
Contributor

@Hoverbear Hoverbear commented Jan 8, 2020

Add multi-version support to website. It's important since we'll soon be posting 3.1/4.0 etc.

This also restructures our menus!

Here's a preview!

image
image

Note: No awkward tabs in the hero!

Some notes:

  • The top menu is restructured, partially to give better accessibility and partially to give more flexibility so that if a user selects the non-default version of TiKV they can consistently stay on that version so long as they remain in the documentation sections of the site.
  • The Side menu has a much nicer visual appearance now
  • Linking schemes should remain consistent.
  • Some minor page movement occurred. They're not ultra-popular pages so it's safe to just let search engines rediscover them
  • Versions are expected to be fairly normal (3.1.0, 4.0.0, 4.0-beta, etc)
  • There's some hacks to get this to work because Hugo isn't very flexible.

Future work will be:

  • Improve version selector
  • Teach Google not to return results for older versions unless asked. (See canonical pages etc)

Signed-off-by: Ana Hobden <[email protected]>
@Hoverbear Hoverbear requested a review from dcalvin January 8, 2020 00:49
@Hoverbear Hoverbear self-assigned this Jan 8, 2020
@dcalvin
Copy link
Member

dcalvin commented Jan 8, 2020

Bulma Menus looks cool!!!

@dcalvin
Copy link
Member

dcalvin commented Jan 8, 2020

Also is there any feature or content specific to 3.1 beta?

@Hoverbear
Copy link
Contributor Author

Not at the moment!

We've published 3.1.0-beta though so it makes sense for it to be present and evolve into 3.1 itself. Things we need to add:

Signed-off-by: Ana Hobden <[email protected]>
Signed-off-by: Ana Hobden <[email protected]>
Signed-off-by: Ana Hobden <[email protected]>
@Hoverbear
Copy link
Contributor Author

Using the Bulma menu styles now:

image

@dcalvin
Copy link
Member

dcalvin commented Jan 9, 2020

Looking at the preview of Bulma version, I have some questions:

  • On the horizontal menu, should we lay out the subsections of documentation? This makes the whole site look like a documentation side. Normally these subsections should be under one Doc tab.
  • Can we support folding/unfolding the navigation TOC on the left after we enter the doc? It looks more comfortable in style, but just is too long when all of subsections are in listed together.
  • Can we support in-page TOC on the right?

@Hoverbear
Copy link
Contributor Author

Hoverbear commented Jan 10, 2020

Looking at the preview of Bulma version,

Bulma is the CSS framework @lucperkins used to create the TiKV site, it's not just some piece of tech backing our menus, it's the overall look at feel of our entire site. :)

On the horizontal menu, should we lay out the subsections of documentation? This makes the whole site look like a documentation side. Normally these subsections should be under one Doc tab.

I rather like this way, but if you'd prefer we can collapse them. I did collapse the menus on mobile :)

Can we support folding/unfolding the navigation TOC on the left after we enter the doc? It looks more comfortable in style, but just is too long when all of subsections are in listed together.

Bulma doesn't support this out of the box. I might be able to hack on it a bit to add this feature. :)

Can we support in-page TOC on the right?

Apparently Hugo does generate a TOC so maybe (https://gohugo.io/content-management/toc/)! I feel like this is outside of the scope of this PR though?

@Hoverbear
Copy link
Contributor Author

On the horizontal menu, should we lay out the subsections of documentation? This makes the whole site look like a documentation side. Normally these subsections should be under one Doc tab.

Fixed :)

@dcalvin
Copy link
Member

dcalvin commented Jan 16, 2020

On the horizontal menu, should we lay out the subsections of documentation? This makes the whole site look like a documentation side. Normally these subsections should be under one Doc tab.

Fixed :)
Thanks. Some further comments:

  • The text font on the left navigation do not look so distinguishable between different levels of titles.
  • The left navigation is not so responsive if I use the top navigation under docs, for example, If I select Reference, the left navigation does not auto scroll down to the corresponding position. It has to be scrolled down manually.
  • It could be better if we could collapse the left navigation bar by default and make it more responsive. But if not, I prefer our previous layout (using horizontal navigation tabs)

@Hoverbear
Copy link
Contributor Author

Sounds like you're unsatisfied with Bulma's menus! I am too! I'm going to build some menus with something else and we can evaluate that. :)

@Hoverbear
Copy link
Contributor Author

@dcalvin
Copy link
Member

dcalvin commented Jan 23, 2020

@dcalvin Can you have a try with https://deploy-preview-114--tikv.netlify.com/docs/3.0/tasks/monitor/key-metrics/

This looks good enough to merge. I like it. And I tested it on phone, looking good too. Thanks.

Copy link
Member

@dcalvin dcalvin left a comment

Choose a reason for hiding this comment

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

LGTM

@Hoverbear Hoverbear merged commit 70ad9c8 into tikv:master Jan 24, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants