Skip to content

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

@zhzhuang-zju

Description

@zhzhuang-zju

What would you like to be added:

There are two issues with the current upgrade docs:

  1. Files docs/administrator/upgrading/README.md and i18n/zh/docusaurus-plugin-content-docs/current/administrator/upgrading/README.md manually maintain minor version upgrade links under Details Upgrading Instruction. This does not provide much value and adds unnecessary maintenance overhead.
    ### [v0.8 to v0.9](./v0.8-v0.9.md)
    ### [v0.9 to v0.10](./v0.9-v0.10.md)
    ### [v0.10 to v1.0](./v0.10-v1.0.md)
    ### [v1.0 to v1.1](./v1.0-v1.1.md)
    ### [v1.1 to v1.2](./v1.1-v1.2.md)
    ### [v1.2 to v1.3](./v1.2-v1.3.md)
    ### [v1.3 to v1.4](./v1.3-v1.4.md)
    ### [v1.4 to v1.5](./v1.4-v1.5.md)
    ### [v1.5 to v1.6](./v1.5-v1.6.md)
    ### [v1.6 to v1.7](./v1.6-v1.7.md)
    ### [v1.7 to v1.8](./v1.7-v1.8.md)
    ### [v1.8 to v1.9](./v1.8-v1.9.md)
    ### [v1.9 to v1.10](./v1.9-v1.10.md)
    ### [v1.10 to v1.11](./v1.10-v1.11.md)
    ### [v1.11 to v1.12](./v1.11-v1.12.md)
    ### [v1.12 to v1.13](./v1.12-v1.13.md)
    ### [v1.13 to v1.14](./v1.13-v1.14.md)

We can remove them, like:

diff --git a/docs/administrator/upgrading/README.md b/docs/administrator/upgrading/README.md
index 5889289..cd57ae2 100644
--- a/docs/administrator/upgrading/README.md
+++ b/docs/administrator/upgrading/README.md
@@ -14,24 +14,7 @@ To upgrade Karmada, you can follow the [Upgrade Guide](./how-to-upgrade.md).

 ## Details Upgrading Instruction

-The following instructions are for minor version upgrades. Cross-version upgrades are not recommended.
-And it is recommended to use the latest patch version when upgrading, for example, if you are upgrading from 
+Cross-version upgrades are not recommended. And it is recommended to use the latest patch version when upgrading, for example, if you are upgrading from 
 v1.1.x to v1.2.x and the available patch versions are v1.2.0, v1.2.1 and v1.2.2, then select v1.2.2.

-### [v0.8 to v0.9](./v0.8-v0.9.md)
-### [v0.9 to v0.10](./v0.9-v0.10.md)
-### [v0.10 to v1.0](./v0.10-v1.0.md)
-### [v1.0 to v1.1](./v1.0-v1.1.md)
-### [v1.1 to v1.2](./v1.1-v1.2.md)
-### [v1.2 to v1.3](./v1.2-v1.3.md)
-### [v1.3 to v1.4](./v1.3-v1.4.md)
-### [v1.4 to v1.5](./v1.4-v1.5.md)
-### [v1.5 to v1.6](./v1.5-v1.6.md)
-### [v1.6 to v1.7](./v1.6-v1.7.md)
-### [v1.7 to v1.8](./v1.7-v1.8.md)
-### [v1.8 to v1.9](./v1.8-v1.9.md)
-### [v1.9 to v1.10](./v1.9-v1.10.md)
-### [v1.10 to v1.11](./v1.10-v1.11.md)
-### [v1.11 to v1.12](./v1.11-v1.12.md)
-### [v1.12 to v1.13](./v1.12-v1.13.md)
-### [v1.13 to v1.14](./v1.13-v1.14.md)
+For detailed instructions on minor version upgrades, refer to the corresponding upgrade guide.
  1. docs/administrator/upgrading/v1.16-v1.17.md exists but is not configured in sidebars.js and versioned_sidebars/version-v1.17-sidebars.json, so it is not visible on the website.

Metadata

Metadata

Assignees

Labels

good first issueDenotes an issue ready for a new contributor, according to the "help wanted" guidelines.help wantedDenotes an issue that needs help from a contributor. Must meet "help wanted" guidelines.kind/featureCategorizes issue or PR as related to a new feature.

Type

No type
No fields configured for issues without a type.

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions