Skip to content

Conversation

@rikatz
Copy link
Member

@rikatz rikatz commented Oct 20, 2025

What type of PR is this?
/kind documentation

What this PR does / why we need it:
This is an attempt to implement multiversion for our API Reference.

While it is very "rudimentary", it allows us to set different versions of API on the navigation bar.

The rationale about keeping just the current versions (1.3, 1.4 and main) is because before 1.3 we didn't had experimental APIs and I've tried to not overcomplicate it.

Once a new release is cut, the release manager or some contributor must:

  • update the generate.sh to add the new branch
  • update the nav.yml.tmpl to add the new branch/version
  • Run the update of nav

Which issue(s) this PR fixes:
Fixes #4151

Does this PR introduce a user-facing change?:

NONE

@k8s-ci-robot k8s-ci-robot added release-note-none Denotes a PR that doesn't merit a release note. kind/documentation Categorizes issue or PR as related to documentation. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. labels Oct 20, 2025
@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by: rikatz
Once this PR has been reviewed and has the lgtm label, please assign aojea for approval. For more information see the Code Review Process.

The full list of commands accepted by this bot can be found here.

Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@k8s-ci-robot k8s-ci-robot added the size/M Denotes a PR that changes 30-99 lines, ignoring generated files. label Oct 20, 2025
@rikatz rikatz force-pushed the multi-version-apiref branch 2 times, most recently from b1b95ba to e0bc4a4 Compare October 20, 2025 22:48
@youngnick
Copy link
Contributor

Like this PR, but could we add the update steps into RELEASE.md as well?

Aside from that, this LGTM.

@snorwin
Copy link
Member

snorwin commented Oct 21, 2025

Awesome, I’ve been waiting for this feature, thanks, @rikatz.

@rikatz rikatz force-pushed the multi-version-apiref branch from e0bc4a4 to c35e936 Compare October 21, 2025 17:32
@rikatz
Copy link
Member Author

rikatz commented Oct 21, 2025

@youngnick fixed

@rikatz
Copy link
Member Author

rikatz commented Oct 22, 2025

/cc @youngnick @robscott

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

Labels

cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. kind/documentation Categorizes issue or PR as related to documentation. release-note-none Denotes a PR that doesn't merit a release note. size/M Denotes a PR that changes 30-99 lines, ignoring generated files.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Add version button on the docs

4 participants