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 Older Documentation Version Websites for Released Branches #536

Open
Xieql opened this issue Jan 3, 2024 · 2 comments
Open

Add Older Documentation Version Websites for Released Branches #536

Xieql opened this issue Jan 3, 2024 · 2 comments

Comments

@Xieql
Copy link
Contributor

Xieql commented Jan 3, 2024

What would you like to be added:

part of #215

Why is this needed:

Currently, we are considering implementing a version menu in our documentation to enable users to switch to their desired document version.

The method for adding a version menu is detailed in the Docsy documentation on versioning:
(see https://www.docsy.dev/docs/adding-content/versioning/)

image

version_menu = "Releases"

# Add your release versions here
[[params.versions]]
  version = "master"
  url = "https://kurator.dev"

[[params.versions]]
  version = "v0.5"
  url = "https://v0-5.kurator.dev"

[[params.versions]]
  version = "v0.4"
  url = "https://v0-4.kurator.dev"

However, we face a challenge as the older version websites (such as https://v0-4.kurator.dev/) do not currently exist. Therefore, it is necessary to create and add websites for the older documentation versions, aligning with each released branch.

This concept is inspired by the versioning system used on the https://github.com/kubeflow/website

@hzxuzhonghu
Copy link
Member

So if we add subdomain like https://v0-4.kurator.dev/, then it works?

@Xieql
Copy link
Contributor Author

Xieql commented Jan 4, 2024

So if we add subdomain like https://v0-4.kurator.dev/, then it works?

I think so.

This version menu just offer a button to switch to another subdomain. If we already have the orlder version site, user can switch to their desired document version in this way.

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

No branches or pull requests

2 participants