fix: found issues reported by new no-unmatched-anchor rule#600
Open
JounQin wants to merge 1 commit intorelease-4.2from
Open
fix: found issues reported by new no-unmatched-anchor rule#600JounQin wants to merge 1 commit intorelease-4.2from
JounQin wants to merge 1 commit intorelease-4.2from
Conversation
Contributor
|
Important Review skippedAuto reviews are disabled on base/target branches other than the default branch. 🗂️ Base branches to auto review (3)
Please check the settings in the CodeRabbit UI or the ⚙️ Run configurationConfiguration used: Organization UI Review profile: CHILL Plan: Pro Run ID: You can disable this status message by setting the Use the checkbox below for a quick retry:
WalkthroughThe PR adds explicit MDX anchor identifiers to 40+ documentation section headings for improved linking stability, consolidates Kubernetes version compatibility references to a central Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~12 minutes Possibly related PRs
Suggested reviewers
Poem
🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
📝 Coding Plan
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
Member
Author
|
@coderabbitai review |
Contributor
✅ Actions performedReview triggered.
|
Member
Author
|
@coderabbitai review |
Contributor
✅ Actions performedReview triggered.
|
Contributor
There was a problem hiding this comment.
Pull request overview
Updates the docs site to address link/anchor validation errors (from the new no-unmatched-anchor rule) by adding explicit anchor IDs to headings and correcting intra-/inter-document anchor references. The PR also updates the docs build toolchain dependency (@alauda/doom), resulting in a large yarn.lock refresh.
Changes:
- Add explicit heading anchors across many
.mdxpages and fix anchor/link targets. - Update
@alauda/doomdependency (and corresponding lockfile), plus assorted transitive dependency updates. - Remove an unused SVG asset.
Reviewed changes
Copilot reviewed 48 out of 50 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
| yarn.lock | Updates lockfile due to @alauda/doom change and transitive dependency refresh. |
| package.json | Pins @alauda/doom dependency to a URL. |
| lint/public/logo.svg | Removes an SVG asset from the repo. |
| docs/en/virtualization/virtualization/virtual_machine/how_to/vm_gpust.mdx | Fixes an inline anchor definition for pciDeviceSelector. |
| docs/en/virtualization/virtualization/virtual_machine/functions/virtual_management.mdx | Adds explicit heading IDs for anchor stability. |
| docs/en/virtualization/virtualization/network/how_to/vm_sriov.mdx | Fixes malformed inline anchor id (#VF_ID → VF_ID). |
| docs/en/virtualization/virtualization/network/functions/vm_network.mdx | Updates section/link to point at the corrected anchor. |
| docs/en/virtualization/virtualization/installation.mdx | Adds explicit heading ID for deep-linking. |
| docs/en/upgrade/overview.mdx | Removes content that included an anchor link that no longer exists. |
| docs/en/storage/storagesystem_minio/installation.mdx | Adds explicit heading ID for “Storage Pool Overview”. |
| docs/en/storage/storagesystem_ceph/concepts/concept.mdx | Adds explicit IDs to multiple headings. |
| docs/en/security/users_and_roles/idp/functions/ldap_manage.mdx | Adds explicit heading ID for “Add LDAP”. |
| docs/en/overview/kubernetes-support-matrix.mdx | Adds explicit ID for “Version Support Matrix”. |
| docs/en/observability/monitor/functions/manage_dashboard.mdx | Adds explicit heading ID and updates internal references. |
| docs/en/networking/overview.mdx | Adds explicit heading ID for “GatewayAPI”. |
| docs/en/extend/upload_package.mdx | Adds explicit heading ID for “Common Parameters”. |
| docs/en/extend/cluster_plugin.mdx | Adds explicit heading ID for “Installing via YAML”. |
| docs/en/developer/s2i/functions/s2i_application_management.mdx | Adds explicit heading ID for “Procedure”. |
| docs/en/developer/building_application/working_with_helm_charts.mdx | Adds explicit heading ID for section 1. |
| docs/en/developer/building_application/namespace/update_overcommit.mdx | Fixes heading capitalization (“UnderStanding” → “Understanding”). |
| docs/en/developer/building_application/namespace/security_policies.mdx | Adds explicit heading ID for “Namespace Labels”. |
| docs/en/developer/building_application/namespace/resource_quota.mdx | Adds explicit heading ID for “Other Quotas”. |
| docs/en/developer/building_application/create_applications/operator_app.mdx | Fixes heading capitalization and adds explicit ID. |
| docs/en/developer/building_application/concepts/custom_application.mdx | Fixes whitespace/wrapping issues and trailing spaces in code block. |
| docs/en/configure/networking/how_to/kube_ovn/multiple_networks.mdx | Adds explicit heading ID for “Deploying the Multus CNI Plugin”. |
| docs/en/configure/networking/functions/configure_subnet.mdx | Adds explicit IDs to headings referenced by links. |
| docs/en/configure/networking/functions/configure_gatewayapi_route.mdx | Fixes an anchor link to point to the correct document. |
| docs/en/configure/networking/functions/configure_domain.mdx | Adds explicit heading ID for “Creating Domain…”. |
| docs/en/configure/networking/functions/configure_alb.mdx | Adds explicit heading ID for “dslx”. |
| docs/en/configure/clusters/on-premises.mdx | Adds explicit heading ID for “Node Settings”. |
| docs/en/configure/clusters/nodes/overview.mdx | Fixes a link target to the correct prerequisites section. |
| docs/en/configure/clusters/managed/register.mdx | Updates link to support matrix anchor; formatting cleanup. |
| docs/en/configure/clusters/managed/import/tencent-tke.mdx | Updates prerequisites link to support matrix anchor. |
| docs/en/configure/clusters/managed/import/standard-kubernetes.mdx | Updates prerequisites link to support matrix anchor; formatting cleanup; adds explicit anchor to a subsection. |
| docs/en/configure/clusters/managed/import/openshift.mdx | Updates prerequisites link to support matrix anchor; formatting cleanup. |
| docs/en/configure/clusters/managed/import/huawei-cce.mdx | Updates prerequisites link to support matrix anchor. |
| docs/en/configure/clusters/managed/import/gcp-gke.mdx | Updates prerequisites link to support matrix anchor. |
| docs/en/configure/clusters/managed/import/azure-aks.mdx | Updates prerequisites link to support matrix anchor; adds explicit heading ID for FAQ entry. |
| docs/en/configure/clusters/managed/import/aws-eks.mdx | Updates prerequisites link to support matrix anchor. |
| docs/en/configure/clusters/managed/import/alibaba-ack.mdx | Updates prerequisites link to support matrix anchor. |
| docs/en/configure/clusters/managed/how-to/fetch-kubeconfig.mdx | Converts a manual <span id> anchor to an explicit heading ID. |
| docs/en/configure/clusters/managed/cloud-init/storage/huawei-cce.mdx | Adds explicit heading ID for “Default Storage Class Description”. |
| docs/en/configure/clusters/managed/cloud-init/storage/google-gke.mdx | Adds explicit heading IDs for multiple sections. |
| docs/en/configure/clusters/managed/cloud-init/storage/azure-aks.mdx | Adds explicit heading IDs for multiple sections. |
| docs/en/configure/clusters/managed/cloud-init/storage/aws-eks.mdx | Adds explicit heading ID for “Configure Available Storage Class Parameters”. |
| docs/en/configure/clusters/managed/cloud-init/network/huawei-cce.mdx | Adds explicit heading ID for “Create Certificate”. |
| docs/en/configure/clusters/managed/cloud-init/network/google-gke.mdx | Adds explicit heading ID for “Create Certificate”. |
| docs/en/configure/clusters/managed/cloud-init/network/azure-aks.mdx | Adds explicit heading IDs for multiple sections. |
| docs/en/configure/clusters/managed/cloud-init/network/aws-eks.mdx | Adds explicit heading IDs for multiple sections. |
| docs/en/configure/backup/overview.mdx | Adds explicit heading IDs for backup/restore sections. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Comment on lines
16
to
18
| "dependencies": { | ||
| "@alauda/doom": "^1.20.4" | ||
| "@alauda/doom": "https://pkg.pr.new/@alauda/doom@0f1b2c8" | ||
| }, |
There was a problem hiding this comment.
@alauda/doom is pinned to a pkg.pr.new preview URL. That host is typically ephemeral and can break installs/auditing later (including supply-chain review and offline builds). Prefer a published npm version (or an internal registry) and only use preview URLs in temporary branches/CI experiments.
Deploying alauda-container-platform with
|
| Latest commit: |
2179eb4
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://7005669e.alauda-container-platform.pages.dev |
| Branch Preview URL: | https://fix-unmatched-anchors-4-2.alauda-container-platform.pages.dev |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
Contributor
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Nitpick comments (1)
docs/en/developer/building_application/create_applications/operator_app.mdx (1)
11-11: Optional wording polish: hyphenate “Operator-Backed” in the heading.Using the compound adjective form improves consistency/readability in English docs.
Suggested tweak
-## Understanding Operator Backed Application {`#understanding-operator-backed-application`} +## Understanding Operator-Backed Application {`#understanding-operator-backed-application`}🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@docs/en/developer/building_application/create_applications/operator_app.mdx` at line 11, Change the heading "Understanding Operator Backed Application" to the hyphenated form "Understanding Operator-Backed Application" and update the header ID/anchor to match (e.g., {`#understanding-operator-backed-application`}) so the visible title and its linkable identifier remain consistent; edit the line containing that heading text to apply the hyphenation in both the displayed string and the anchor.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@package.json`:
- Line 17: Add an inline comment next to the "@alauda/doom" dependency in
package.json explaining this is a temporary pkg.pr.new pre-release URL used to
test the new "no-unmatched-anchor" lint rule and that it should be replaced with
the published npm version (e.g., the prior ^1.20.4) once released; update the
package.json dependencies section with that TODO comment and also add/confirm a
short note in the PR or release plan indicating there is an active plan to
replace this URL with the official npm release before merging to release-4.2.
---
Nitpick comments:
In `@docs/en/developer/building_application/create_applications/operator_app.mdx`:
- Line 11: Change the heading "Understanding Operator Backed Application" to the
hyphenated form "Understanding Operator-Backed Application" and update the
header ID/anchor to match (e.g., {`#understanding-operator-backed-application`})
so the visible title and its linkable identifier remain consistent; edit the
line containing that heading text to apply the hyphenation in both the displayed
string and the anchor.
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro
Run ID: 4e281e12-533c-44be-8845-166a54a3b443
⛔ Files ignored due to path filters (2)
lint/public/logo.svgis excluded by!**/*.svgyarn.lockis excluded by!**/yarn.lock,!**/*.lock
📒 Files selected for processing (48)
docs/en/configure/backup/overview.mdxdocs/en/configure/clusters/managed/cloud-init/network/aws-eks.mdxdocs/en/configure/clusters/managed/cloud-init/network/azure-aks.mdxdocs/en/configure/clusters/managed/cloud-init/network/google-gke.mdxdocs/en/configure/clusters/managed/cloud-init/network/huawei-cce.mdxdocs/en/configure/clusters/managed/cloud-init/storage/aws-eks.mdxdocs/en/configure/clusters/managed/cloud-init/storage/azure-aks.mdxdocs/en/configure/clusters/managed/cloud-init/storage/google-gke.mdxdocs/en/configure/clusters/managed/cloud-init/storage/huawei-cce.mdxdocs/en/configure/clusters/managed/how-to/fetch-kubeconfig.mdxdocs/en/configure/clusters/managed/import/alibaba-ack.mdxdocs/en/configure/clusters/managed/import/aws-eks.mdxdocs/en/configure/clusters/managed/import/azure-aks.mdxdocs/en/configure/clusters/managed/import/gcp-gke.mdxdocs/en/configure/clusters/managed/import/huawei-cce.mdxdocs/en/configure/clusters/managed/import/openshift.mdxdocs/en/configure/clusters/managed/import/standard-kubernetes.mdxdocs/en/configure/clusters/managed/import/tencent-tke.mdxdocs/en/configure/clusters/managed/register.mdxdocs/en/configure/clusters/nodes/overview.mdxdocs/en/configure/clusters/on-premises.mdxdocs/en/configure/networking/functions/configure_alb.mdxdocs/en/configure/networking/functions/configure_domain.mdxdocs/en/configure/networking/functions/configure_gatewayapi_route.mdxdocs/en/configure/networking/functions/configure_subnet.mdxdocs/en/configure/networking/how_to/kube_ovn/multiple_networks.mdxdocs/en/developer/building_application/concepts/custom_application.mdxdocs/en/developer/building_application/create_applications/operator_app.mdxdocs/en/developer/building_application/namespace/resource_quota.mdxdocs/en/developer/building_application/namespace/security_policies.mdxdocs/en/developer/building_application/namespace/update_overcommit.mdxdocs/en/developer/building_application/working_with_helm_charts.mdxdocs/en/developer/s2i/functions/s2i_application_management.mdxdocs/en/extend/cluster_plugin.mdxdocs/en/extend/upload_package.mdxdocs/en/networking/overview.mdxdocs/en/observability/monitor/functions/manage_dashboard.mdxdocs/en/overview/kubernetes-support-matrix.mdxdocs/en/security/users_and_roles/idp/functions/ldap_manage.mdxdocs/en/storage/storagesystem_ceph/concepts/concept.mdxdocs/en/storage/storagesystem_minio/installation.mdxdocs/en/upgrade/overview.mdxdocs/en/virtualization/virtualization/installation.mdxdocs/en/virtualization/virtualization/network/functions/vm_network.mdxdocs/en/virtualization/virtualization/network/how_to/vm_sriov.mdxdocs/en/virtualization/virtualization/virtual_machine/functions/virtual_management.mdxdocs/en/virtualization/virtualization/virtual_machine/how_to/vm_gpust.mdxpackage.json
💤 Files with no reviewable changes (1)
- docs/en/upgrade/overview.mdx
JounQin
force-pushed
the
fix/unmatched-anchors_4.2
branch
from
ab55de5 to
2179eb4
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary by CodeRabbit
Release Notes
Documentation
Changes