fix: found issues reported by new no-unmatched-anchor rule#604
Open
JounQin wants to merge 1 commit intorelease-4.0from
Open
fix: found issues reported by new no-unmatched-anchor rule#604JounQin wants to merge 1 commit intorelease-4.0from
JounQin wants to merge 1 commit intorelease-4.0from
Conversation
Contributor
WalkthroughThis PR systematically updates documentation files across the project by adding explicit markdown anchors to section headings, redirecting prerequisite links to a centralized Kubernetes support matrix, normalizing whitespace, and updating a project dependency reference. Changes
Estimated code review effort🎯 3 (Moderate) | ⏱️ ~25 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 |
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.
Actionable comments posted: 2
🧹 Nitpick comments (1)
docs/en/configure/clusters/managed/register.mdx (1)
60-60: Optional wording polish for repeated sentence starts.Consider varying the imperative verb here (instead of another “Execute...”) to improve readability across the numbered steps.
🤖 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` at line 60, The sentence at step 4 repeats the imperative "Execute..." which reduces readability; update that line in register.mdx to vary the verb (for example use "Run", "Restart", or "Delete" as appropriate) so it no longer starts with "Execute", while keeping the command text `kubectl delete pod --all -n rook-ceph` unchanged and preserving the step numbering and intent.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@docs/en/storage/storagesystem_ceph/how_to/disaster_recovery/dr_object.mdx`:
- Line 263: The fragment id "uid" is duplicated (already used as "#uid"
earlier), so change the span id in this line to a unique identifier (e.g.,
"uid-secondary" or "secondary-gateway-uid") and update any local links that
target this anchor; locate the span with id="uid" in this file (the current
line) and replace the id value with the new unique id to avoid anchor
collisions.
In `@package.json`:
- Line 14: Replace the preview artifact URL dependency for the package
"@alauda/doom" with a stable registry version: locate the dependency entry that
currently reads "@alauda/doom": "https://pkg.pr.new/@alauda/doom@0f1b2c8" and
change it to a semantic version string published to your registry (e.g. "0.1.2"
or a proper npm/dist-tag like "latest") or remove/replace it with an approved
internal package reference; ensure package.json's dependencies/devDependencies
contain only resolved registry versions and run npm/yarn install to verify the
lockfile updates.
---
Nitpick comments:
In `@docs/en/configure/clusters/managed/register.mdx`:
- Line 60: The sentence at step 4 repeats the imperative "Execute..." which
reduces readability; update that line in register.mdx to vary the verb (for
example use "Run", "Restart", or "Delete" as appropriate) so it no longer starts
with "Execute", while keeping the command text `kubectl delete pod --all -n
rook-ceph` unchanged and preserving the step numbering and intent.
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro
Run ID: 8152e2e7-ff69-4550-be74-294f4652f89a
⛔ Files ignored due to path filters (1)
yarn.lockis excluded by!**/yarn.lock,!**/*.lock
📒 Files selected for processing (47)
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/architecture/understanding_alb.mdxdocs/en/configure/networking/functions/configure_subnet.mdxdocs/en/configure/networking/functions/create_domain.mdxdocs/en/configure/storage/functions/nfs_storageclass.mdxdocs/en/developer/building_application/functions/namespace/resource_quota.mdxdocs/en/developer/building_application/functions/namespace/security_policies.mdxdocs/en/developer/building_application/functions/namespace/update_overcommit.mdxdocs/en/developer/building_application/functions/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/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_ceph/how_to/disaster_recovery/dr_object.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_clone.mdxdocs/en/virtualization/virtualization/virtual_machine/how_to/vm_gpust.mdxpackage.json
💤 Files with no reviewable changes (1)
- docs/en/upgrade/overview.mdx
| ### Configure External Access for Secondary Zone | ||
|
|
||
| 1. Obtain UID of Secondary Gateway \{#uids} | ||
| 1. Obtain UID of Secondary Gateway <span id="uid" /> |
Contributor
There was a problem hiding this comment.
Use a unique fragment ID to avoid anchor collision.
id="uid" is already defined earlier in this file (#uid at Line 112). Duplicate IDs can make fragment links jump to the wrong section.
Suggested fix
-1. Obtain UID of Secondary Gateway <span id="uid" />
+1. Obtain UID of Secondary Gateway <span id="secondary-uid" />📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
Suggested change
| 1. Obtain UID of Secondary Gateway <span id="uid" /> | |
| 1. Obtain UID of Secondary Gateway <span id="secondary-uid" /> |
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@docs/en/storage/storagesystem_ceph/how_to/disaster_recovery/dr_object.mdx` at
line 263, The fragment id "uid" is duplicated (already used as "#uid" earlier),
so change the span id in this line to a unique identifier (e.g., "uid-secondary"
or "secondary-gateway-uid") and update any local links that target this anchor;
locate the span with id="uid" in this file (the current line) and replace the id
value with the new unique id to avoid anchor collisions.
| }, | ||
| "dependencies": { | ||
| "@alauda/doom": "^1.18.2" | ||
| "@alauda/doom": "https://pkg.pr.new/@alauda/doom@0f1b2c8" |
Contributor
There was a problem hiding this comment.
🧩 Analysis chain
🏁 Script executed:
#!/bin/bash
set -euo pipefail
echo "== package.json dependency source =="
rg -n '"@alauda/doom"\s*:' package.json -C 1
echo
echo "== preview URL usage in lockfile =="
rg -n 'pkg\.pr\.new/.+@alauda/doom|@alauda/doom-export@https://pkg\.pr\.new' yarn.lock -C 1Repository: alauda/acp-docs
Length of output: 609
Avoid shipping a preview package URL in release dependencies.
@alauda/doom is pinned to pkg.pr.new, a temporary preview artifact endpoint. This creates reproducibility issues and supply chain risk. Use a stable registry version instead.
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@package.json` at line 14, Replace the preview artifact URL dependency for the
package "@alauda/doom" with a stable registry version: locate the dependency
entry that currently reads "@alauda/doom":
"https://pkg.pr.new/@alauda/doom@0f1b2c8" and change it to a semantic version
string published to your registry (e.g. "0.1.2" or a proper npm/dist-tag like
"latest") or remove/replace it with an approved internal package reference;
ensure package.json's dependencies/devDependencies contain only resolved
registry versions and run npm/yarn install to verify the lockfile updates.
Member
Author
|
/doc-pr-build |
Deploying alauda-container-platform with
|
| Latest commit: |
d15edf5
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://54987012.alauda-container-platform.pages.dev |
| Branch Preview URL: | https://fix-unmatched-anchors-4-0.alauda-container-platform.pages.dev |
JounQin
commented
Mar 20, 2026
|
|
||
| ### Configure External Access for Primary Zone | ||
|
|
||
| 1. Obtain the UID of the ObjectStore \{#uid} |
Member
Author
There was a problem hiding this comment.
Suggested change
| 1. Obtain the UID of the ObjectStore <span id="uid" /> |
| ### Configure External Access for Secondary Zone | ||
|
|
||
| 1. Obtain UID of Secondary Gateway \{#uids} | ||
| 1. Obtain UID of Secondary Gateway <span id="uid" /> |
Member
Author
There was a problem hiding this comment.
Suggested change
| 1. Obtain UID of Secondary Gateway <span id="uid" /> | |
| 1. Obtain UID of Secondary Gateway <span id="uids" /> |
Contributor
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 46 out of 48 changed files in this pull request and generated 3 comments.
💡 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.
The @alauda/doom dependency was switched from a published semver range to a pkg.pr.new URL. This makes installs non-reproducible and typically requires updating yarn.lock; otherwise the repo’s lockfile is out of sync with package.json. Consider bumping to a released @alauda/doom version (or pinning via a normal version) and commit the corresponding yarn.lock update.
Comment on lines
262
to
264
|
|
||
| 1. Obtain UID of Secondary Gateway \{#uids} | ||
| 1. Obtain UID of Secondary Gateway <span id="uid" /> | ||
|
|
There was a problem hiding this comment.
This adds a second "uid" anchor in the same document (there is already a "{#uid}" anchor earlier). Duplicate fragment IDs can make links resolve to the wrong section. Use a unique id here (e.g., secondary-gateway-uid) and update any references accordingly.
Comment on lines
21
to
24
| ## Notes | ||
|
|
||
| * **Kubernetes Version:** | ||
| Kubernetes upgrades are supported only for **On-Premises Clusters**. For **Managed Clusters** (e.g., Amazon EKS, Azure AKS), Kubernetes upgrades must be performed through the respective cloud provider. See [Cluster Type](../configure/clusters/overview.mdx#cluster_type) for more information on the differences between **On-Premises Clusters** and **Managed Clusters**. | ||
|
|
||
| * **Operator:** | ||
| Only Operators with **Source = <Term name="company" />** are listed and can be upgraded via the cluster upgrade feature. All other Operators are managed through the **OLM** component in the Marketplace and are not included in this process. |
There was a problem hiding this comment.
The Kubernetes upgrade note was removed entirely to address an unmatched anchor, which is a documentation regression. Instead of deleting this guidance, consider keeping the content and updating the broken link/anchor (or linking to an existing section in the clusters overview) so readers still get the Kubernetes upgrade constraints for managed vs on-prem clusters.
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
Documentation
Chores