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

Document: Adding release version dropdown for book-v1,v2,v3 #3320

Closed
pratikmota opened this issue Apr 8, 2023 · 4 comments · Fixed by #3332
Closed

Document: Adding release version dropdown for book-v1,v2,v3 #3320

pratikmota opened this issue Apr 8, 2023 · 4 comments · Fixed by #3332
Assignees
Labels
kind/documentation Categorizes issue or PR as related to documentation. kind/feature Categorizes issue or PR as related to a new feature.

Comments

@pratikmota
Copy link
Contributor

What do you want to happen?

Kubebuilder documentation has 3 versions. Book-v1,v2 and v3.
Problem:

  1. Right now legacy documentation (v2 and v1) URL is given in the introduction. If someone directly checks other pages then might not get from where they can open different version documentation.
  2. Difficult to find different version documentation for new users in first glance.
  3. In the future if different versions v4, v5 etc will come then it will be difficult to maintain and for a new user it will be difficult to find an old version of the documentation.

Solution

  1. We need to add a book versions list in Menu
  2. User can just hover and check different versions like v3-book, v2-book and v1-book
  3. By click on particular version, it will open in new tab
  4. By this solution it will be very easy for new users to find different versions of documentation and also easy to maintain different versions for future use cases.
    image

Extra Labels

/kind documentation

@pratikmota pratikmota added the kind/feature Categorizes issue or PR as related to a new feature. label Apr 8, 2023
@k8s-ci-robot k8s-ci-robot added the kind/documentation Categorizes issue or PR as related to documentation. label Apr 8, 2023
@pratikmota
Copy link
Contributor Author

pratikmota commented Apr 8, 2023

@camilamacedo86 / @varshaprasad96 : Can you please check if this change request will be useful for the community? I have done local changes related to it. If the request looks fine. I will raise PR.

@pratikmota
Copy link
Contributor Author

/assign

@pratikmota
Copy link
Contributor Author

pratikmota commented Apr 8, 2023

PR for book-v3 branch: #3321

@pratikmota
Copy link
Contributor Author

PR for master branch: #3332

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
kind/documentation Categorizes issue or PR as related to documentation. kind/feature Categorizes issue or PR as related to a new feature.
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants