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

Remove version switcher from docs homepage #8257

Merged
merged 1 commit into from
Sep 9, 2020
Merged

Remove version switcher from docs homepage #8257

merged 1 commit into from
Sep 9, 2020

Conversation

yzdocs
Copy link
Contributor

@yzdocs yzdocs commented Sep 9, 2020

Fixes #8063.

@lnhsingh, @Amruta-Ranade, @jseldess: This PR removes the version switcher from the Docs homepage, which I believe was requested by Amruta.

While making this change, I noticed that there are CRDB pages linked from the CC part of the sidenav, namely the pages under "Use Your Cluster" > "Migrate Data." Those will have the version switcher displayed, since they are actually CRDB pages and not CC pages. Is that fine? Note that this is similar to the issue affecting breadcrumbs. When the same pages are linked from multiple sidenav locations, breadcrumbs will not work as expected.

@cockroach-teamcity
Copy link
Member

This change is Reviewable

@cockroach-teamcity
Copy link
Member

@yzdocs
Copy link
Contributor Author

yzdocs commented Sep 9, 2020

While making this change, I noticed that there are CRDB pages linked from the CC part of the sidenav, namely the pages under "Use Your Cluster" > "Migrate Data." Those will have the version switcher displayed, since they are actually CRDB pages and not CC pages.

One way to get around this that I can think of: In the CC folder, have hard symlinks pointing to pages in CRDB. But in order for this to work, symlinked pages cannot use the {{ page.version.version }} macro to include files, because those break in the unversioned CC folder. In other words, only verison-neutral files can be included by pages that need to be in both CC and CRDB.

@Amruta-Ranade
Copy link
Contributor

Thanks, YZ! I think it's okay if the CRDB pages show the version selector even if they are linked from the CC nav.

@yzdocs
Copy link
Contributor Author

yzdocs commented Sep 9, 2020

Sounds good, thanks Amruta! I will merge this PR today then.

@yzdocs yzdocs merged commit b899376 into master Sep 9, 2020
@yzdocs yzdocs deleted the versions branch September 9, 2020 20:20
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.

Versioning
4 participants