fix: found issues reported by new no-unmatched-anchor rule#603
Open
JounQin wants to merge 1 commit intorelease-4.1from
Open
fix: found issues reported by new no-unmatched-anchor rule#603JounQin wants to merge 1 commit intorelease-4.1from
JounQin wants to merge 1 commit intorelease-4.1from
Conversation
Contributor
WalkthroughThe PR standardizes documentation across 40+ files by adding explicit MDX anchor identifiers ( Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes Possibly related PRs
Suggested labels
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 |
Contributor
There was a problem hiding this comment.
Pull request overview
This PR updates the documentation set to comply with a new “no-unmatched-anchor” lint rule by adding/adjusting explicit anchors and fixing several cross-page links so they resolve to valid IDs.
Changes:
- Add explicit, stable heading IDs (
\{#...\}) and a few manual anchor elements (<span id=... />,<a id=...>) to eliminate unmatched anchor violations. - Update multiple doc links to point at the new/normalized anchors (notably the Kubernetes support matrix and ALB networking configuration anchors).
- Update the
@alauda/doomdependency source inpackage.json.
Reviewed changes
Copilot reviewed 49 out of 51 changed files in this pull request and generated 3 comments.
Show a summary per file
| File | Description |
|---|---|
| package.json | Switches @alauda/doom dependency source (currently to a PR-preview URL). |
| docs/en/virtualization/virtualization/virtual_machine/how_to/vm_gpust.mdx | Cleans whitespace and introduces an explicit in-page anchor for pciDeviceSelector. |
| docs/en/virtualization/virtualization/virtual_machine/functions/virtual_management.mdx | Adds explicit heading IDs for sections referenced elsewhere. |
| docs/en/virtualization/virtualization/network/how_to/vm_sriov.mdx | Fixes invalid anchor id (#VF_ID → VF_ID). |
| docs/en/virtualization/virtualization/network/functions/vm_network.mdx | Updates section/link to reference the add-service anchor. |
| docs/en/virtualization/virtualization/installation.mdx | Adds an explicit heading ID for “Creating a HyperConverged Instance”. |
| docs/en/upgrade/overview.mdx | Removes the “Kubernetes Version” note block under Notes. |
| docs/en/storage/storagesystem_minio/installation.mdx | Adds an explicit heading ID for “Storage Pool Overview”. |
| docs/en/storage/storagesystem_ceph/concepts/concept.mdx | Adds explicit heading IDs for core concept sections. |
| docs/en/security/users_and_roles/idp/functions/ldap_manage.mdx | Adds an explicit heading ID for “Add LDAP”. |
| docs/en/overview/kubernetes-support-matrix.mdx | Adds an explicit heading ID for “Version Support Matrix”. |
| docs/en/observability/monitor/install_monitor.mdx | Adds a manual anchor element to support an external link target. |
| docs/en/observability/monitor/functions/manage_dashboard.mdx | Adds heading ID for “Import Dashboard” and renames the “Common Functions and Variables” anchor. |
| docs/en/observability/log/install_log.mdx | Adds a manual anchor element and tweaks the install section heading text. |
| docs/en/extend/upload_package.mdx | Removes trailing spaces / normalizes formatting. |
| docs/en/extend/cluster_plugin.mdx | Adds an explicit heading ID for “Installing via YAML”. |
| docs/en/developer/s2i/functions/s2i_application_management.mdx | Adds an explicit heading ID for “Procedure”. |
| docs/en/developer/building_application/working_with_helm_charts.mdx | Adds an explicit heading ID for “Understanding Helm”. |
| docs/en/developer/building_application/namespace/update_overcommit.mdx | Fixes heading capitalization/wording. |
| docs/en/developer/building_application/namespace/security_policies.mdx | Adds an explicit heading ID for “Namespace Labels”. |
| docs/en/developer/building_application/namespace/resource_quota.mdx | Adds an explicit heading ID for “Other Quotas”. |
| docs/en/developer/building_application/create_applications/operator_app.mdx | Fixes heading wording and adds an explicit heading ID. |
| docs/en/developer/building_application/concepts/custom_application.mdx | Fixes heading wording and whitespace in a YAML schema excerpt. |
| docs/en/configure/networking/functions/multiple_networks.mdx | Adds an explicit heading ID for “Deploying the Multus CNI Plugin”. |
| docs/en/configure/networking/functions/create_domain.mdx | Adds an explicit heading ID for the “Creating Domain…” section. |
| docs/en/configure/networking/functions/configure_subnet.mdx | Adds explicit heading IDs for bridge/VLAN sections. |
| docs/en/configure/networking/functions/configure_alb_rule.mdx | Adds an explicit heading ID for “dslx” and normalizes whitespace. |
| docs/en/configure/clusters/on-premises.mdx | Adds an explicit heading ID for “Node Settings”. |
| docs/en/configure/clusters/nodes/overview.mdx | Fixes a doc link target path for supported OS/kernels. |
| docs/en/configure/clusters/managed/register.mdx | Updates the version requirements link to the support matrix anchor. |
| docs/en/configure/clusters/managed/import/tencent-tke.mdx | Updates the version requirements link to the support matrix anchor. |
| docs/en/configure/clusters/managed/import/standard-kubernetes.mdx | Updates version requirements link, normalizes list formatting, and adds an explicit heading ID for the Containerd fix section. |
| docs/en/configure/clusters/managed/import/openshift.mdx | Updates the version requirements link and normalizes list formatting. |
| docs/en/configure/clusters/managed/import/huawei-cce.mdx | Updates the version requirements link to the support matrix anchor. |
| docs/en/configure/clusters/managed/import/gcp-gke.mdx | Updates the version requirements link to the support matrix anchor. |
| docs/en/configure/clusters/managed/import/azure-aks.mdx | Updates the version requirements link and adds an explicit FAQ heading ID. |
| docs/en/configure/clusters/managed/import/aws-eks.mdx | Updates the version requirements link to the support matrix anchor. |
| docs/en/configure/clusters/managed/import/alibaba-ack.mdx | Updates the version requirements link to the support matrix anchor. |
| docs/en/configure/clusters/managed/how-to/fetch-kubeconfig.mdx | Converts an inline <span id=...> to an escaped heading ID. |
| docs/en/configure/clusters/managed/cloud-init/storage/huawei-cce.mdx | Adds explicit heading IDs for storage class documentation sections. |
| docs/en/configure/clusters/managed/cloud-init/storage/google-gke.mdx | Adds explicit heading IDs for prerequisites/storage class sections. |
| docs/en/configure/clusters/managed/cloud-init/storage/azure-aks.mdx | Adds explicit heading IDs for storage class sections. |
| docs/en/configure/clusters/managed/cloud-init/storage/aws-eks.mdx | Adds an explicit heading ID for storage class parameters section. |
| docs/en/configure/clusters/managed/cloud-init/network/huawei-cce.mdx | Adds an explicit heading ID for “Create Certificate”. |
| docs/en/configure/clusters/managed/cloud-init/network/google-gke.mdx | Adds an explicit heading ID for “Create Certificate”. |
| docs/en/configure/clusters/managed/cloud-init/network/azure-aks.mdx | Adds explicit heading IDs for ingress controller/certificate sections. |
| docs/en/configure/clusters/managed/cloud-init/network/aws-eks.mdx | Adds explicit heading IDs, fixes ALB annotations link anchor, and normalizes whitespace. |
| docs/en/configure/clusters/managed/cloud-init/network/aws-eks-lb.mdx | Updates links to the new anchors and normalizes whitespace. |
| docs/en/configure/backup/recovery/app.mdx | Fixes the hooks documentation link target. |
| docs/en/configure/backup/backups/hooks.mdx | Adds an explicit heading ID for “Backup Hook”. |
Comments suppressed due to low confidence (1)
docs/en/upgrade/overview.mdx:27
- The "Kubernetes Version" note under Notes was removed entirely. If this was done to address an unmatched anchor (
#cluster_type), it would be better to keep the guidance and update the link target (or add a valid anchor on the referenced page) rather than deleting the content, since it changes the meaning of the upgrade overview.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| }, | ||
| "dependencies": { | ||
| "@alauda/doom": "^1.18.2" | ||
| "@alauda/doom": "https://pkg.pr.new/@alauda/doom@0f1b2c8" |
There was a problem hiding this comment.
@alauda/doom is switched from a semver range to a transient pkg.pr.new URL. This makes installs non-reproducible (and potentially unavailable later), complicates caching/offline builds, and increases supply-chain risk. Prefer pinning to a published version (or using a scoped yarn resolutions/temporary CI override) rather than committing a PR-preview URL into dependencies.
Deploying alauda-container-platform with
|
| Latest commit: |
b0a5bc9
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://f8f6b8f8.alauda-container-platform.pages.dev |
| Branch Preview URL: | https://fix-unmatched-anchors-4-1.alauda-container-platform.pages.dev |
Member
Author
|
@coderabbitai review |
Contributor
✅ Actions performedReview triggered.
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
Contributor
There was a problem hiding this comment.
🧹 Nitpick comments (2)
docs/en/developer/building_application/create_applications/operator_app.mdx (1)
11-11: Consider hyphenating "Operator-Backed" for style consistency.The static analysis tool suggests that compound modifiers before nouns should be hyphenated (e.g., "Operator-Backed Application" rather than "Operator Backed Application"). While not a critical issue, this would align with standard English grammar conventions.
✍️ Proposed style improvement
-## Understanding Operator Backed Application {`#understanding-operator-backed-application`} +## Understanding Operator-Backed Application {`#understanding-operator-backed-application`}Note: This change should be applied consistently throughout the documentation if adopted.
🤖 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, Update the heading text "Understanding Operator Backed Application" to hyphenate the compound modifier as "Understanding Operator-Backed Application" (and replace other occurrences of "Operator Backed" with "Operator-Backed" in this document); locate the heading string and any mentions in operator_app.mdx and apply the hyphenation consistently to maintain style consistency.docs/en/configure/clusters/managed/register.mdx (1)
56-60: Consider varying sentence structure for improved readability.Three consecutive sentences begin with "Execute the command", which can make the instructions feel repetitive. Consider restructuring for better flow.
✨ Suggested rewording
-2. Execute the command `systemctl daemon-reload` to reload the configuration. +2. Reload the configuration: `systemctl daemon-reload` -3. Execute the command `systemctl restart containerd` to restart Containerd. +3. Restart Containerd: `systemctl restart containerd` -4. Execute the command `kubectl delete pod --all -n rook-ceph` on the cluster control node to restart all Pods in the rook-ceph namespace to make the configuration effective. +4. On the cluster control node, restart all Pods in the rook-ceph namespace: `kubectl delete pod --all -n rook-ceph`🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@docs/en/configure/clusters/managed/register.mdx` around lines 56 - 60, Reword the three consecutive instruction lines to avoid repeating "Execute the command" by varying sentence openings and using concise imperatives; for example, start one line with "Run systemctl daemon-reload" (for reloading the configuration), another with "Restart Containerd with systemctl restart containerd", and the third with "On the cluster control node, run kubectl delete pod --all -n rook-ceph to restart all Pods in the rook-ceph namespace" so each step references the commands (systemctl daemon-reload, systemctl restart containerd, kubectl delete pod --all -n rook-ceph) but uses different sentence structures for better flow.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Nitpick comments:
In `@docs/en/configure/clusters/managed/register.mdx`:
- Around line 56-60: Reword the three consecutive instruction lines to avoid
repeating "Execute the command" by varying sentence openings and using concise
imperatives; for example, start one line with "Run systemctl daemon-reload" (for
reloading the configuration), another with "Restart Containerd with systemctl
restart containerd", and the third with "On the cluster control node, run
kubectl delete pod --all -n rook-ceph to restart all Pods in the rook-ceph
namespace" so each step references the commands (systemctl daemon-reload,
systemctl restart containerd, kubectl delete pod --all -n rook-ceph) but uses
different sentence structures for better flow.
In `@docs/en/developer/building_application/create_applications/operator_app.mdx`:
- Line 11: Update the heading text "Understanding Operator Backed Application"
to hyphenate the compound modifier as "Understanding Operator-Backed
Application" (and replace other occurrences of "Operator Backed" with
"Operator-Backed" in this document); locate the heading string and any mentions
in operator_app.mdx and apply the hyphenation consistently to maintain style
consistency.
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro
Run ID: 551b2d41-ce0c-4d3a-85f6-3db406fa8e2c
⛔ Files ignored due to path filters (1)
yarn.lockis excluded by!**/yarn.lock,!**/*.lock
📒 Files selected for processing (50)
docs/en/configure/backup/backups/hooks.mdxdocs/en/configure/backup/recovery/app.mdxdocs/en/configure/clusters/managed/cloud-init/network/aws-eks-lb.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_rule.mdxdocs/en/configure/networking/functions/configure_subnet.mdxdocs/en/configure/networking/functions/create_domain.mdxdocs/en/configure/networking/functions/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/observability/log/install_log.mdxdocs/en/observability/monitor/functions/manage_dashboard.mdxdocs/en/observability/monitor/install_monitor.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
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