Skip to content

clean up upgrade docs navigation and fix missing visibility of v1.16-v1.17#1013

Merged
karmada-bot merged 1 commit into
karmada-io:mainfrom
vanshiz:cleanup-upgrade-docs
May 21, 2026
Merged

clean up upgrade docs navigation and fix missing visibility of v1.16-v1.17#1013
karmada-bot merged 1 commit into
karmada-io:mainfrom
vanshiz:cleanup-upgrade-docs

Conversation

@vanshiz
Copy link
Copy Markdown
Contributor

@vanshiz vanshiz commented May 20, 2026

What type of PR is this?
/kind feature

What this PR does / why we need it:

  • Remove hardcoded minor version upgrade links from docs/administrator/upgrading/README.md and i18n/zh/docusaurus-plugin-content-docs/current/administrator/upgrading/README.md to reduce manual maintenance overhead. The sidebar already handles navigation for these docs.
  • Add v1.16-v1.17 to sidebars.js and versioned_sidebars/version-v1.17-sidebars.json to make the existing v1.16-v1.17.md visible on the website.

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

Special notes for your reviewer:
N/A

@karmada-bot karmada-bot added the kind/feature Categorizes issue or PR as related to a new feature. label May 20, 2026
@karmada-bot karmada-bot requested review from Poor12, Tingtal and samzong May 20, 2026 18:14
@karmada-bot
Copy link
Copy Markdown
Contributor

Welcome @vanshiz! It looks like this is your first PR to karmada-io/website 🎉

@karmada-bot karmada-bot added the size/M Denotes a PR that changes 30-99 lines, ignoring generated files. label May 20, 2026
@vanshiz vanshiz changed the title clean up upgrade docs navigation and fix missing visibility of v1.16-… clean up upgrade docs navigation and fix missing visibility of v1.16-v1.17 May 20, 2026
Copy link
Copy Markdown

@gemini-code-assist gemini-code-assist Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Code Review

This pull request streamlines the upgrade documentation by replacing a long list of version-specific links in the README files with a general instruction to refer to the corresponding guides. It also adds the v1.16-v1.17 upgrade path to the sidebar configurations. Feedback focuses on improving terminology consistency by capitalizing "PATCH" and "MINOR" to match other sections, as well as refining sentence structure and formatting in the documentation.

Comment thread docs/administrator/upgrading/README.md Outdated
Comment thread docs/administrator/upgrading/README.md Outdated
Comment thread i18n/zh/docusaurus-plugin-content-docs/current/administrator/upgrading/README.md Outdated
Comment thread i18n/zh/docusaurus-plugin-content-docs/current/administrator/upgrading/README.md Outdated
@zhzhuang-zju
Copy link
Copy Markdown
Contributor

Thanks @vanshiz. Generally LGTM, please squash the commits into one, so we can move forward

…v1.17

Signed-off-by: vanshiz <vanshikabhargava29@gmail.com>
@vanshiz vanshiz force-pushed the cleanup-upgrade-docs branch from 289c492 to 24fd9d9 Compare May 21, 2026 01:35
@zhzhuang-zju
Copy link
Copy Markdown
Contributor

/lgtm
/cc @windsonsea

@karmada-bot karmada-bot requested a review from windsonsea May 21, 2026 02:59
@karmada-bot karmada-bot added the lgtm Indicates that a PR is ready to be merged. label May 21, 2026
Copy link
Copy Markdown
Member

@RainbowMango RainbowMango left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

/approve

@karmada-bot
Copy link
Copy Markdown
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: RainbowMango

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

The pull request process is described here

Details 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

@karmada-bot karmada-bot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label May 21, 2026
@karmada-bot karmada-bot merged commit f0b5b1a into karmada-io:main May 21, 2026
7 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

approved Indicates a PR has been approved by an approver from all required OWNERS files. kind/feature Categorizes issue or PR as related to a new feature. lgtm Indicates that a PR is ready to be merged. 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.

clean up upgrade docs navigation and fix missing visibility of v1.16-v1.17

4 participants