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

fix(docs): fix and cleanup VuePress config #3738

Merged
merged 7 commits into from Mar 11, 2022
Merged

Conversation

kidonng
Copy link
Contributor

@kidonng kidonng commented Mar 11, 2022

Description

  • Use relative links: so they can be picked up by VuePress
  • Remove v0.45.0 migration link from the sidebar: it's been almost 1.5 years
  • Fix wrong zh-TW and zh-CN config position: previously they don't have any effect
  • Refactor sidebar: languages besides the en-US now have "Advanced Installation" in the sidebar, also makes the sidebar more maintainable
  • Enable VuePress evergreen: make the site smaller and faster

Regarding the sidebar refactor, this is the biggest part of this PR. Currently overrides are configured so existing sidebar items stay the same, but eventually the each translated pages should have the right title and then remove the override. Refer to comments in the code.

Motivation and Context

Closes #

Screenshots (if appropriate):

How Has This Been Tested?

  • I have tested using MacOS
  • I have tested using Linux
  • I have tested using Windows

Checklist:

  • I have updated the documentation accordingly.
  • I have updated the tests accordingly.

Copy link
Member

@davidkna davidkna left a comment

Choose a reason for hiding this comment

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

@matchai Can you check GA what the impact of enabling evergreen would amount to?

docs/.vuepress/config.js Outdated Show resolved Hide resolved
@matchai
Copy link
Member

matchai commented Mar 11, 2022

@davidkna Great idea referring to GA!
If Analytics is anything to go by, we've had 25 IE sessions this year, with a 100% bounce rate.
If VuePress isn't shooing them off, something else might be. In any case, I think enabling evergreen is a worthwhile improvement.

Co-authored-by: David Knaack <davidkna@users.noreply.github.com>
Copy link
Member

@matchai matchai left a comment

Choose a reason for hiding this comment

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

LGTM! 👍
Thank you for tidying up the docs, @kidonng!

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.

None yet

4 participants