kurator icon indicating copy to clipboard operation
kurator copied to clipboard

Add Older Documentation Version Websites for Released Branches

Open Xieql opened this issue 1 year ago • 2 comments

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

Xieql avatar Jan 03 '24 08:01 Xieql