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

Doc Versioning #3048

Closed
MarckK opened this issue Sep 5, 2020 · 2 comments · Fixed by #3114
Closed

Doc Versioning #3048

MarckK opened this issue Sep 5, 2020 · 2 comments · Fixed by #3114
Assignees

Comments

@MarckK
Copy link
Member

MarckK commented Sep 5, 2020

This is a Feature Request

What would you like to be added

Doc Versioning.

Docsy makes it easy to do doc versioning, including the ability to display a banner on archived doc sites/versions: https://www.docsy.dev/docs/adding-content/versioning/

Why is this needed

To differentiate Jenkins X 3 docs from Jenkins X 2 docs.

Comments

This isn't an immediately pressing issue, but as Jenkins X 3 matures, it will be helpful and clarifying if the docs are versioned.

@borntorock
Copy link
Contributor

A reference example of docsy docs for versioning is Kubeflow docs which has no box mentioning on the stable docs built from v1.1 or master branch but for other versions in dropped down option a box appears on almost all webpages displaying something like this:

Version v0.7 of the documentation is no longer actively maintained. The site that you are currently viewing is an archived snapshot. For up-to-date documentation, see the latest version.

Link: https://v0-7.kubeflow.org/docs/

The source code of the Kubeflow docs is present here.

@ankitm123
Copy link
Member

/assign

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

Successfully merging a pull request may close this issue.

3 participants