Conversation
|
Caution Review failedThe pull request is closed. WalkthroughThis update consists of widespread documentation formatting, typographic, and stylistic corrections across numerous markdown files. Changes include standardizing apostrophes, adjusting heading levels, improving code block indentation, cleaning up whitespace, and adding or updating lint directives. No technical content, logic, or procedural instructions were altered, and no code functionality was modified. Changes
Sequence Diagram(s)Not applicable due to the nature of the changes (documentation and formatting only). Possibly related PRs
Suggested reviewers
Poem
📜 Recent review detailsConfiguration used: CodeRabbit UI ⛔ Files ignored due to path filters (1)
📒 Files selected for processing (98)
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. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 7
🔭 Outside diff range comments (2)
docs/en/virtualization/virtualization/image/how_to/vm_iso_windows.mdx (1)
243-249: Broken YAML: malformed secondcontainerDiskentryThe list item introducing the virtio disk lost its colon and indentation, producing invalid YAML and breaking the KubeVirt manifest.
- name: containerdisk - - containerDisk - image: registry.example.cn:60070/3rdparty/vmdisks/win-virtio # Replace the image according to your actual environment - name: virtio + name: containerdisk + - containerDisk: + image: registry.example.cn:60070/3rdparty/vmdisks/win-virtio # Replace the image according to your actual environment + name: virtioValidate the full manifest after the fix; the CI linter should stop flagging it.
docs/en/hardware_accelerator/application_development/trouble_shooting/paddle_native_best.mdx (1)
133-140: Prometheus alert rule won’t parse – use-not•Same issue as above: the leading bullet must be a minus.
- • alert: GPUAllocConflict + - alert: GPUAllocConflict
🧹 Nitpick comments (37)
docs/en/developer/building_application/namespace/update_member.mdx (1)
61-64: “OICD” should be “OIDC”The acronym is misspelled twice (“OICD”). Search-and-replace to avoid confusing readers.
-The platform has added an **OICD** type IDP. +The platform has added an **OIDC** type IDP.docs/en/storage/storagesystem_minio/architecture.mdx (1)
10-24: Heading colons are unnecessaryColons in headings add visual noise and are inconsistent with most other docs. Consider dropping them.
-## Core Components: +## Core Components -## Deployment Architecture: +## Deployment Architecture -## Multi-Pool Expansion: +## Multi-Pool Expansion -## Conclusion: +## Conclusiondocs/en/developer/oam_applications/concepts/cue.mdx (1)
25-25: Tighten wording around “in conjunction with”
The phrase is slightly verbose. Consider the lighter alternative below.- | **a: \*1 \| int** | `*` specifies the default value of the variable, and in conjunction with `\|`, defines an int type variable a with a default value of 1. | + | **a: \*1 \| int** | `*` specifies the variable’s default; together with `\|`, it defines an int variable `a` whose default value is 1. |docs/en/security/users_and_roles/idp/trouble_shooting/delete_user.mdx (2)
45-47: Indent width inside the ordered list is off by two spacesFor consistency with other code blocks under ordered lists, shift left two spaces:
- ```bash - kubectl get users ... - ``` + ```bash + kubectl get users ... + ```
51-53: Same indentation nitpick as aboveSee previous diff; apply to both script snippets.
docs/en/hardware_accelerator/overview/intro.mdx (3)
24-25: Grammar – clarify wording of dynamic slicing- - **Dynamic Slicing**: Split GPUs to support multi progress used one physical gpu + - **Dynamic Slicing**: Split GPUs so multiple processes can share a single physical GPU
50-51: Minor capitalisation“hardware” isn’t a proper noun here.
- - **Microservice Orchestration**: Co-locate multiple GPU microservices on shared Hardware + - **Microservice Orchestration**: Co-locate multiple GPU microservices on shared hardware
88-88: Typo and clarity- - support only cuda less then 12.4 + - Supports only CUDA versions earlier than 12.4docs/en/developer/building_application/create_applications/cli.mdx (1)
22-30: Fix typo in Step 1
Contianer➜Container-1. **Contianer Platform**, click the terminal icon in the lower-right corner. +1. **Container Platform** – click the terminal icon in the lower-right corner.docs/en/upgrade/upgrade_global_cluster.mdx (1)
74-80: Insert missing space after periodThe sentence merges two clauses:
cluster**.If inconsistencies→cluster**. If inconsistencies-...primary global cluster**.If inconsistencies are detected, **contact technical support** before proceeding. +...primary global cluster**. If inconsistencies are detected, **contact technical support** before proceeding.docs/en/configure/networking/functions/configure_service.mdx (1)
60-65: Rephrase to avoid repetitive sentence startThree successive sentences begin with “You/You're”. Streamline the second bullet:
-You're using StatefulSets where each Pod must have a stable DNS name. +StatefulSets require each Pod to have a stable DNS name.docs/en/developer/building_application/operation_maintaining/application_rollouts/install_argo_rollouts.mdx (1)
29-31: Unify wording & placeholders for better consistency
- The action word “Create” is bold in step 3 but italic in step 5. Pick one style to avoid visual noise.
- Two different placeholders are used:
<image registry address>(YAML) vs<image repository address>(note line 60). Use a single, self-explanatory placeholder everywhere.-3. Click **Create** button … +3. Click _Create_ button … - the `<image repository address>` should be replaced by the registry address + the `<image registry address>` should be replaced by the registry addressAlso applies to: 60-62
docs/en/storage/storagesystem_topolvm/how_to/backup_and_restore.mdx (1)
45-71: Example schedule fires once every 100 years
@every 876000h≈ 100 years; readers may think it’s a typo. If the intention is “disable periodic backup”, add a short comment to state that explicitly or pick a more obvious sentinel (e.g.@onceif supported).docs/en/observability/log/functions/log.mdx (1)
105-135: Minor Markdown quirk onlyIndenting fenced blocks by three spaces is valid but uncommon; most editors won’t recognise it as a code fence for syntax highlighting. Consider left-aligning the triple back-ticks.
docs/en/virtualization/virtualization/virtual_machine/how_to/create-template.mdx (1)
17-19: Avoid repetitive bullet phrasingAll three bullets begin with “Install …”. Re-phrasing improves rhythm and avoids the LanguageTool warning.
- - Install cloud-init. - - Install the `qemu-guest-agent`. - - Install any required software. + - Install [cloud-init](https://cloud-init.io/). + - Add the `qemu-guest-agent`. + - Install any additional software your image needs.docs/en/configure/machine_config/managing.mdx (1)
33-35:base64 -w0is GNU-specific
-w0(disable line-wrap) is not available on macOS/BusyBox.
Portable alternative:base64 chrony.conf | tr -d '\n'Consider mentioning this to prevent confusion on non-GNU systems.
docs/en/virtualization/virtualization/virtual_machine/how_to/vm_usb_passthrough.mdx (1)
40-46: Minor wording tweak for clarityConsider pluralising identifier to match “vendor and product identifiers”.
-The vendor and product identifiers of a USB device can be obtained using the `lsusb` command. +The vendor and product identifiers of a USB device can be obtained with the `lsusb` command.docs/en/ui/cli_tools/index.mdx (1)
107-139: Heavy inline styles reduce maintainabilityThe parameter table now embeds large chunks of inline CSS. Moving these rules to a shared
.mdx/CSS module keeps content clean and avoids impossible diffs when only wording changes.docs/en/storage/storagesystem_ceph/how_to/disaster_recovery/dr_object.mdx (1)
5-5: Minor typos – quick polish suggested
- Line 5: “Object Storagge” → “Object Storage”.
- Line 259: “secndary Gateway” → “secondary Gateway”.
- Line 341: “Obtaine External address” → “Obtain External address”.
Purely cosmetic, but worth correcting for professionalism.
Also applies to: 259-259, 341-341
docs/en/appservice/unified-om/inspection-mgt/functions/create_inspection_task.mdx (1)
61-61: Minor wording nitpick“Click
Create Tasksbutton” reads plural, yet the UI usually labels the control “Create Task”.
If the actual button text is singular, consider:-3. Click `Create Tasks` button +3. Click the `Create Task` buttondocs/en/virtualization/virtualization/network/how_to/vm_sriov.mdx (2)
108-130: Possible typo in samplelsmodoutput
irqbypass … vfio_pcis missing the trailing “i” (vfio_pci).
Small, but readers may assume the module name isvfio_pc.-irqbypass 13503 2 kvm, vfio_pc +irqbypass 13503 2 kvm, vfio_pci
240-250: Eight nearly-identical bind commands – consider loopingfor addr in 0000:05:{10.1,10.3,10.5,10.7,11.1,11.3,11.5,11.7}; do python3 dpdk-devbind.py -b vfio-pci "$addr" doneKeeps docs shorter and less error-prone.
docs/en/developer/building_application/application_workloads/container.mdx (2)
37-45: Admonition keyword likely invalid
:::Notesis non-standard; Docusaurus & most MDX plugins expect lower-case singular keywords (:::note,:::info,:::tip, etc.). Rendering may break.-:::Notes +:::note
169-169: Fix typo “Contianer” → “Container”- **EXEC** > **_Contianer Name_**. + **EXEC** > **_Container Name_**.docs/en/observability/monitor/functions/manage_alert.mdx (2)
66-76: Capitalise “Alert Level” for consistencyEverywhere else, section headers and proper-noun parameters start with a capital letter.
Consider:-| alert Level +| Alert Level
80-85: Same capitalization issue in Event-alert tableApply the same change here to keep docs uniform.
-| alert Level +| Alert Leveldocs/en/gitops/argocd_troubleshooting.mdx (2)
68-70: Remove duplicated paragraphThe two consecutive sentences convey the same information.
-Check if cluster secret has `argocd.argoproj.io/secret-type: cluster` label. If secret has the label but the cluster is still not visible then make sure it might be a permission issue. Try to list clusters using `admin` user (e.g. `argocd login --username admin && argocd cluster list`).
123-124: Typo — “namesapce” → “namespace”-kubectl delete secret argocd-redis -n <argocd namesapce> +kubectl delete secret argocd-redis -n <argocd namespace>docs/en/gitops/functions/create_argocd_application/create_applicationset_via_platform.mdx (1)
46-48: Minor wording tweak for “Custom Values”Current phrasing is slightly terse.
-| **Custom Values** | **Source File Type** is **Helm**, you can select a custom Helm Values file +| **Custom Values** | When **Source File Type** is **Helm**, you can select an alternative `values.yaml` (custom Helm values file)docs/en/developer/building_application/application_workloads/deployment_create.mdx (1)
141-145: Escape|inside table cellsSome markdown renderers break when the pipe isn’t HTML-escaped.
-| **Subnet** | Assign IPs from a predefined subnet pool. If unspecified, uses the namespace's default subnet. | +| **Subnet** | Assign IPs from a predefined subnet pool. If unspecified, uses the namespace|s default subnet. |Repeat for other cells that embed
|.docs/en/observability/monitor/functions/manage_dashboard.mdx (2)
181-187: Typo: “YMAL” → “YAML”-| **YMAL** | Opens the actual CR resource code of the dashboard stored in the Kubernetes cluster. You can modify all content in the dashboard by editing parameters in the YAML. | +| **YAML** | Opens the actual CR resource code of the dashboard stored in the Kubernetes cluster. You can modify all content in the dashboard by editing parameters in the YAML. |
195-208: Spelling & consistency pass needed for the panel listLines contain “Pannel” (should be “Panel”) and “horiazontal” (should be “horizontal”). Fix while doing the global replacement.
-| **4** | Horizontal Bar Chart | Similar to the bar chart but uses horizontal rectangular bars to represent data. | When there are many data dimensions, horizontal bar charts can better utilize spatial layout and improve readability. |docs/en/developer/building_application/application_workloads/statefulset_create.mdx (1)
125-129: Table will overflow on narrow screensThe very long “Volume Claim Templates” cell renders as one giant line in some MDX viewers. Consider adding manual
<br/>breaks or splitting the list into sub-bullet points to preserve readability on docs site.docs/en/observability/monitor/functions/manage_metrics.mdx (1)
45-47: Token & URL placeholders should use consistent angle-bracket syntaxOther docs use
<your-token>(lower-case, hyphen). Consider normalising to avoid reader confusion and search-replace errors in docs.docs/en/observability/monitor/functions/manage_blackbox.mdx (3)
38-43: Table column width exceeds GitHub previewRow 40’s cell is ~500 chars; Markdown renderers without word-wrap will overflow. Consider moving examples to bullet list under the table.
109-119: ConfigMap snippet: keep YAML comments alignedTiny nit – comments on lines 111-118 are mis-aligned two spaces compared to rest of file; not critical but breaks doom-lint
indentationrule occasionally.
144-171: Large embedded manifest – maybe reference gistThe full Probe example is valuable, but bloats the doc. A trimmed version focusing on the diff from default, with a “See full example” link, would keep docs concise.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
⛔ Files ignored due to path filters (1)
yarn.lockis excluded by!**/yarn.lock,!**/*.lock
📒 Files selected for processing (83)
.cspell/abbreviations.txt(1 hunks)docs/en/appservice/overview/architecture.mdx(1 hunks)docs/en/appservice/unified-om/inspection-mgt/functions/create_inspection_task.mdx(2 hunks)docs/en/appservice/unified-om/inspection-mgt/functions/run_inspection_task.mdx(1 hunks)docs/en/appservice/unified-om/inspection-mgt/functions/update_inspection_task.mdx(1 hunks)docs/en/appservice/unified-om/intro.mdx(1 hunks)docs/en/configure/machine_config/managing.mdx(1 hunks)docs/en/configure/machine_config/node_disruption.mdx(1 hunks)docs/en/configure/networking/architecture/understanding_alb.mdx(1 hunks)docs/en/configure/networking/concepts/network_communications.mdx(1 hunks)docs/en/configure/networking/functions/configure_ingress.mdx(2 hunks)docs/en/configure/networking/functions/configure_network_policy.mdx(1 hunks)docs/en/configure/networking/functions/configure_service.mdx(5 hunks)docs/en/configure/networking/how_to/create_loadbalancer.mdx(2 hunks)docs/en/configure/networking/how_to/decide_performance_selection.mdx(5 hunks)docs/en/configure/networking/how_to/proxy_ipv6_traffic_to_ipv4_pod.mdx(1 hunks)docs/en/configure/networking/how_to/underlay_overlay_st.mdx(1 hunks)docs/en/configure/networking/how_to/use_oauth_proxy_with_alb.mdx(1 hunks)docs/en/configure/storage/concepts/key_concepts.mdx(3 hunks)docs/en/configure/storage/concepts/pv.mdx(2 hunks)docs/en/configure/storage/how_to/third_mask.mdx(1 hunks)docs/en/configure/storage/trouble_shooting/recovery_pvc_expansion.mdx(2 hunks)docs/en/developer/building_application/application_observability/log.mdx(2 hunks)docs/en/developer/building_application/application_workloads/container.mdx(8 hunks)docs/en/developer/building_application/application_workloads/deamonset_create.mdx(8 hunks)docs/en/developer/building_application/application_workloads/deployment_create.mdx(5 hunks)docs/en/developer/building_application/application_workloads/job_create.mdx(2 hunks)docs/en/developer/building_application/application_workloads/pod.mdx(3 hunks)docs/en/developer/building_application/application_workloads/statefulset_create.mdx(7 hunks)docs/en/developer/building_application/concepts/understanding_parameters.mdx(1 hunks)docs/en/developer/building_application/configuration/add_configmap.mdx(1 hunks)docs/en/developer/building_application/create_applications/cli.mdx(2 hunks)docs/en/developer/building_application/create_applications/yaml_app.mdx(2 hunks)docs/en/developer/building_application/namespace/remove_namespace.mdx(1 hunks)docs/en/developer/building_application/namespace/resource_quota.mdx(3 hunks)docs/en/developer/building_application/namespace/update_member.mdx(2 hunks)docs/en/developer/building_application/namespace/update_overcommit.mdx(1 hunks)docs/en/developer/building_application/operation_maintaining/add_cronhpa.mdx(3 hunks)docs/en/developer/building_application/operation_maintaining/add_hpa.mdx(2 hunks)docs/en/developer/building_application/operation_maintaining/add_vpa.mdx(2 hunks)docs/en/developer/building_application/operation_maintaining/application_rollouts/bluegreen_deployment.mdx(6 hunks)docs/en/developer/building_application/operation_maintaining/application_rollouts/canary_deployment.mdx(7 hunks)docs/en/developer/building_application/operation_maintaining/application_rollouts/install_argo_rollouts.mdx(1 hunks)docs/en/developer/building_application/operation_maintaining/healthcheck.mdx(4 hunks)docs/en/developer/building_application/working_with_helm_charts.mdx(5 hunks)docs/en/developer/oam_applications/concepts/cue.mdx(1 hunks)docs/en/developer/operator/functions/example_function.mdx(1 hunks)docs/en/developer/s2i/intro.mdx(2 hunks)docs/en/extend/operator.mdx(1 hunks)docs/en/gitops/argocd_troubleshooting.mdx(6 hunks)docs/en/gitops/concept/argocd_concept_info/concept_argocd_tool.mdx(1 hunks)docs/en/gitops/functions/create_argocd_application/create_application_via_platform.mdx(5 hunks)docs/en/gitops/functions/create_argocd_application/create_applicationset_via_platform.mdx(4 hunks)docs/en/hardware_accelerator/application_development/trouble_shooting/gpu_computer_less_shooting.mdx(7 hunks)docs/en/hardware_accelerator/application_development/trouble_shooting/paddle_native_best.mdx(5 hunks)docs/en/hardware_accelerator/overview/intro.mdx(2 hunks)docs/en/install/prepare/download.mdx(1 hunks)docs/en/install/prepare/node_preprocessing.mdx(1 hunks)docs/en/observability/inspection/intro.mdx(0 hunks)docs/en/observability/log/functions/log.mdx(3 hunks)docs/en/observability/monitor/functions/manage_alert.mdx(7 hunks)docs/en/observability/monitor/functions/manage_blackbox.mdx(6 hunks)docs/en/observability/monitor/functions/manage_dashboard.mdx(3 hunks)docs/en/observability/monitor/functions/manage_metrics.mdx(3 hunks)docs/en/observability/monitor/how_to/restore_prometheus.mdx(3 hunks)docs/en/overview/release_notes.mdx(2 hunks)docs/en/security/users_and_roles/idp/functions/oidc_manage.mdx(4 hunks)docs/en/security/users_and_roles/idp/trouble_shooting/delete_user.mdx(3 hunks)docs/en/storage/storagesystem_ceph/how_to/disaster_recovery/dr_filesystem.mdx(5 hunks)docs/en/storage/storagesystem_ceph/how_to/disaster_recovery/dr_object.mdx(11 hunks)docs/en/storage/storagesystem_ceph/intro.mdx(1 hunks)docs/en/storage/storagesystem_minio/architecture.mdx(1 hunks)docs/en/storage/storagesystem_minio/functions/monitor.mdx(1 hunks)docs/en/storage/storagesystem_topolvm/how_to/backup_and_restore.mdx(1 hunks)docs/en/ui/cli_tools/index.mdx(8 hunks)docs/en/upgrade/upgrade_global_cluster.mdx(6 hunks)docs/en/virtualization/virtualization/image/how_to/vm_iso_linux.mdx(1 hunks)docs/en/virtualization/virtualization/image/how_to/vm_iso_windows.mdx(1 hunks)docs/en/virtualization/virtualization/network/how_to/vm_sriov.mdx(13 hunks)docs/en/virtualization/virtualization/virtual_machine/how_to/create-template.mdx(3 hunks)docs/en/virtualization/virtualization/virtual_machine/how_to/vm_clone.mdx(1 hunks)docs/en/virtualization/virtualization/virtual_machine/how_to/vm_usb_passthrough.mdx(5 hunks)package.json(1 hunks)
💤 Files with no reviewable changes (1)
- docs/en/observability/inspection/intro.mdx
🧰 Additional context used
🧠 Learnings (2)
docs/en/virtualization/virtualization/virtual_machine/how_to/vm_clone.mdx (1)
Learnt from: fanzy618
PR: alauda/acp-docs#10
File: docs/en/virtualization/virtualization/virtual_machine/how_to/vm_clone.mdx:52-54
Timestamp: 2025-06-26T06:40:06.969Z
Learning: VirtualMachineClone resources in KubeVirt have a Ready condition in their status that gets set to "True" when the clone operation succeeds, allowing kubectl wait --for condition=Ready to work correctly.
docs/en/virtualization/virtualization/virtual_machine/how_to/create-template.mdx (1)
Learnt from: fanzy618
PR: alauda/acp-docs#10
File: docs/en/virtualization/virtualization/virtual_machine/how_to/vm_clone.mdx:52-54
Timestamp: 2025-06-26T06:40:06.969Z
Learning: VirtualMachineClone resources in KubeVirt have a Ready condition in their status that gets set to "True" when the clone operation succeeds, allowing kubectl wait --for condition=Ready to work correctly.
🪛 LanguageTool
docs/en/storage/storagesystem_minio/architecture.mdx
[style] ~14-~14: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...O's site replication functionality. - MinIO Pool: The core component of MinIO, re...
(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
docs/en/developer/oam_applications/concepts/cue.mdx
[style] ~25-~25: ‘in conjunction with’ might be wordy. Consider a shorter alternative.
Context: ... the default value of the variable, and in conjunction with \|, defines an int type variable a wi...
(EN_WORDINESS_PREMIUM_IN_CONJUNCTION_WITH)
docs/en/developer/building_application/create_applications/cli.mdx
[grammar] ~24-~24: Ensure spelling is correct
Context: ... switch is enabled. ## Procedure 1. Contianer Platform, click the terminal icon in ...
(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)
docs/en/virtualization/virtualization/virtual_machine/how_to/create-template.mdx
[style] ~19-~19: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: .../). - Install the qemu-guest-agent. - Install any required software. Once installati...
(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
docs/en/configure/networking/functions/configure_service.mdx
[style] ~64-~64: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...ses like Cassandra or StatefulSets). - You're using StatefulSets where each Pod mu...
(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
docs/en/observability/monitor/functions/manage_dashboard.mdx
[grammar] ~62-~62: Ensure spelling is correct
Context: ...rence as metric parameters in the added pannels, which can also be used as filters on t...
(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)
[grammar] ~86-~86: Ensure spelling is correct
Context: ...variable in the query expression of the pannels to view the data corresponding to the v...
(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)
[grammar] ~185-~185: Ensure spelling is correct
Context: ...the current dashboard; you can edit the pannels as needed and save it as a new dashboar...
(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)
[grammar] ~189-~189: Ensure spelling is correct
Context: ... | ## Manage Pannels {#pannel} The platform provides various visualiz...
(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)
[grammar] ~191-~191: Ensure spelling is correct
Context: ...his chapter will mainly introduce these pannel types, configuration options, and usage...
(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)
[grammar] ~207-~207: Ensure spelling is correct
Context: ...presenting textual information, such as pannel descriptions and troubleshooting explan...
(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)
[grammar] ~209-~209: Ensure spelling is correct
Context: ... | ### Pannel Configuration Description #### General...
(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)
[grammar] ~217-~217: Ensure spelling is correct
Context: ...r real-time data when hovering over the pannels and support selected sorting. ...
(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)
[grammar] ~218-~218: Ensure spelling is correct
Context: ... Configure the threshold switch for the pannels; when enabled, the threshold will be sh...
(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)
[grammar] ~218-~218: Ensure spelling is correct
Context: ...will be shown in selected colors in the pannels, allowing for threshold sizing. ...
(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)
[grammar] ~222-~222: Ensure spelling is correct
Context: ... | #### Special Parameters for Pannels | Pannel Type | Parameter ...
(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)
docs/en/hardware_accelerator/application_development/trouble_shooting/paddle_native_best.mdx
[uncategorized] ~84-~84: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...-name> -- env | grep FLAGS ``` #### Bare Metal Deployment 1. Set environment variable...
(EN_COMPOUND_ADJECTIVE_INTERNAL)
🔇 Additional comments (79)
.cspell/abbreviations.txt (1)
1-1: Addition of “CICD” is appropriateIncluding this common acronym will reduce false-positive spelling alerts. Looks good to me.
package.json (1)
16-16: Confirm compatibility & regenerate lockfile after bumping@alauda/doomto 1.10.2Patch-level bumps are usually safe, but
doomis your build toolchain, so even minor breaking changes can surface at build time (e.g., altered CLI flags, stricter lint rules).
- Run
yarn install --immutable(or equivalent) to update the lockfile.- Execute
yarn lint && yarn build && yarn devlocally or in CI to ensure no unexpected failures.No code changes required—just double-check before merging.
docs/en/virtualization/virtualization/image/how_to/vm_iso_linux.mdx (1)
354-357: Consistent EOF newline – good catchAdding a trailing newline satisfies POSIX tooling and keeps markdown-lint happy.
docs/en/configure/networking/how_to/underlay_overlay_st.mdx (1)
10-14: Heading level promotion aligns hierarchyBumping “Procedure” from
###to##matches the surrounding structure and improves ToC generation.docs/en/install/prepare/node_preprocessing.mdx (1)
84-88: Correct heading depthChanging “Appendix” from level-1 to level-2 avoids multiple top-level headings in a single document—nice cleanup.
docs/en/configure/networking/concepts/network_communications.mdx (1)
32-35: Standard ASCII apostrophe – no functional impactStraight apostrophes prevent encoding glitches in some renderers; change looks good.
docs/en/configure/storage/how_to/third_mask.mdx (1)
1-5: Typographic apostrophe normalizationSwitching to a straight quote maintains consistency with the lint rules applied across the repo.
docs/en/appservice/overview/architecture.mdx (1)
10-10: Consistent ASCII apostrophe – looks goodCurly apostrophe replaced with straight ASCII to align with lint rules and ensure encoding consistency. No further action needed.
docs/en/configure/networking/functions/configure_network_policy.mdx (1)
22-22: Typographic fix acknowledgedStandardizing “don’t” → “don't” removes smart-quotes and keeps the docs lint-clean. Change is safe.
docs/en/configure/storage/trouble_shooting/recovery_pvc_expansion.mdx (2)
5-5: Heading level promoted – check inbound links
### Procedure→## Procedureimproves section hierarchy, but verify that any existing deep links (#procedure) still resolve after the slug re-calculation GitHub/Gatsby performs.
19-23: Additional Tips heading aligned – goodPromoting the heading and trimming trailing space keeps the document structure uniform. No issues spotted.
docs/en/gitops/concept/argocd_concept_info/concept_argocd_tool.mdx (2)
19-22: Whitespace cleanup in bullet listRemoval of dangling spaces is correct and silences lint. Content unaffected.
25-29: Example command re-wrapped – fineMinor whitespace tweaks inside explanatory paragraph and code block; nothing functional changed.
docs/en/extend/operator.mdx (1)
55-55: Straight apostrophe appliedCurly apostrophe replaced in user-facing text; consistent with linting guidelines. Looks good.
docs/en/developer/building_application/namespace/update_member.mdx (2)
13-13: Typo fixes look goodStraight-apostrophe replacement improves consistency with the rest of the docs.
Also applies to: 19-19
81-82: Trailing-space removal 👍No content change, just cleaner formatting.
docs/en/configure/machine_config/node_disruption.mdx (1)
12-12: Apostrophe standardisation LGTMNothing else affected.
docs/en/developer/operator/functions/example_function.mdx (1)
48-48: Minor punctuation fix acceptedStraight apostrophe is consistent with house style.
docs/en/configure/networking/architecture/understanding_alb.mdx (1)
312-313: Lint-ignore directive is fineSuppressing the split-list warning keeps the long YAML intact.
docs/en/storage/storagesystem_ceph/how_to/disaster_recovery/dr_filesystem.mdx (1)
51-53: Formatting cleanup LGTM
The switch to consistently-indented “Parameters” blocks improves readability without altering content.docs/en/overview/release_notes.mdx (2)
47-48: Straight apostrophes ✔️
Standardising punctuation (“platform's”, etc.) removes smart-quote lint noise.
58-59: Minor wording check
No issues spotted – the sentence still reads naturally after the apostrophe change.docs/en/install/prepare/download.mdx (1)
12-13: Heading-level promotion looks safe
Promoting these sections to H2 improves document hierarchy. Internal MDX anchors rely on the text, not the level, so existing links remain valid.Also applies to: 20-21, 28-29
docs/en/storage/storagesystem_ceph/intro.mdx (1)
42-44: Punctuation fix acknowledged
The ASCII apostrophe avoids rendering issues; no semantic impact.docs/en/storage/storagesystem_minio/functions/monitor.mdx (1)
3-50: Formatting clean-up looks goodWhitespace and apostrophe normalization only—no content impact.
Nice incremental polish.docs/en/configure/networking/how_to/proxy_ipv6_traffic_to_ipv4_pod.mdx (1)
12-22: Heading promotion is sane—just verify nav outlineBumping from
###→##matches the usual “title # / section ##” hierarchy.
Confirm there isn’t a higher-level##already, or sidebar ordering may shift.docs/en/developer/building_application/create_applications/yaml_app.mdx (1)
40-41: Lint-ignore comment inserted correctlyMDX comment syntax is valid and placed outside the fenced block—no build impact.
docs/en/developer/building_application/configuration/add_configmap.mdx (1)
60-61: Typographic apostrophe fixedGood catch; punctuation now consistent with ASCII apostrophes.
docs/en/developer/building_application/namespace/resource_quota.mdx (3)
20-20: Straight apostrophe swap looks good.
Typographic fix only—no further action required.
32-34: Consistent apostrophe usage is appreciated.
The clarification reads better and avoids mixed punctuation styles.
63-63: CLI example updated consistently.
No functional impact; formatting is now uniform.docs/en/developer/building_application/application_observability/log.mdx (3)
27-27: Lower-case “k” improves unit consistency.
Minor style tweak acknowledged.
37-37: Trailing-space removal is fine.
Keeps markdown diff clean.
40-40: Callout terminator retained correctly.
No issues spotted.docs/en/virtualization/virtualization/virtual_machine/how_to/vm_clone.mdx (1)
13-13: Typographic apostrophe fixed.
Content unchanged—looks good.docs/en/developer/building_application/namespace/remove_namespace.mdx (4)
10-10: Added spacing improves readability.
No semantic changes.
18-18: Section header spacing aligned.
Document structure now clearer.
21-24: Converted note into callout block—nice upgrade.
Helps visually emphasise the limitation without altering meaning.
28-28: Final newline keeps file POSIX-compliant.
Nothing else to add.docs/en/developer/building_application/namespace/update_overcommit.mdx (1)
72-72: Apostrophe corrections accepted.
Table reads cleanly and avoids smart-quote inconsistencies.docs/en/configure/storage/concepts/pv.mdx (2)
9-9: Heading level promotion looks goodConsistency with the rest of the docs is improved; no further action required.
21-21: Second-level heading change confirmedSame remark as above—change is correct and harmless.
docs/en/developer/building_application/concepts/understanding_parameters.mdx (2)
25-25: Added blank line improves readabilityThis prevents the list from being glued to the preceding paragraph.
30-31: Verify MDX lint-ignore comment syntax
{/* lint ignore code-block-split-list */}is valid MDX syntax, but some MD renderers choke on JSX-style comments. Double-check the docs build output just in case.docs/en/security/users_and_roles/idp/functions/oidc_manage.mdx (2)
65-66: Lint-ignore directive inserted correctlyNo functional impact; keeps the linter quiet around the long YAML block.
100-118: YAML indentation validated—no issues detected.
Ran a YAML validation on the OIDC connector snippet (lines 100–118) and confirmed it parses without errors.docs/en/security/users_and_roles/idp/trouble_shooting/delete_user.mdx (2)
17-20: Extra blank line aids list separationNothing else to flag.
35-37: Example block separation LGTMThe added space keeps the example visually distinct.
docs/en/developer/s2i/intro.mdx (1)
15-15: Apostrophe normalization looks goodThe straight apostrophe replacement improves consistency without altering meaning.
docs/en/configure/networking/how_to/decide_performance_selection.mdx (1)
10-49: Heading-level promotion is correctElevating the subsections to level-2 improves hierarchy and matches surrounding docs.
docs/en/hardware_accelerator/application_development/trouble_shooting/gpu_computer_less_shooting.mdx (1)
34-40: Looks good – only formatting touchedNo factual or technical changes introduced; the compute-capability figures remain correct.
Also applies to: 88-90
docs/en/configure/networking/how_to/create_loadbalancer.mdx (1)
145-147: Verify that MDX-style lint-ignore comments are honouredThe comments are written as
{/* lint ignore … */}.
If your markdown pipeline expects the standard HTML form<!-- lint disable … -->, these will be silently ignored and the CI lint step will still fail. Double-check the linter’s docs.Also applies to: 332-333
docs/en/developer/building_application/working_with_helm_charts.mdx (1)
42-50: Heading-level promotion looks goodUp-levelling these headings improves document hierarchy without breaking existing anchor links. No further action needed.
docs/en/configure/networking/functions/configure_ingress.mdx (1)
99-103: Admonition nesting may break rendering
:::infois indented inside a numbered list item. Some MDX renderers treat this as plain code and the admonition disappears. Out-dent the block or wrap the whole list item in an admonition instead.docs/en/developer/building_application/operation_maintaining/add_cronhpa.mdx (1)
35-53: YAML example reads well — no blockersThe schedules, quoting style, and call-out annotations all look good.
Nothing else to flag here.docs/en/developer/building_application/operation_maintaining/add_vpa.mdx (1)
58-75: All good – YAML & call-outs render correctlyThe example is syntactically sound and the explanatory call-out block is clear.
docs/en/appservice/unified-om/intro.mdx (1)
9-9: Typographic fix appreciatedStraight apostrophe standardises punctuation; no further action needed.
docs/en/appservice/unified-om/inspection-mgt/functions/create_inspection_task.mdx (1)
19-19: Consistent CLI snippet style – looks good.Removing the leading
$aligns this page with the rest of the docs and avoids copy-paste surprises.docs/en/appservice/unified-om/inspection-mgt/functions/update_inspection_task.mdx (1)
16-22: Typo fix & prompt cleanup – SGTM•
labelattribute spelling corrected.
• Leading$dropped from the example command.Both are clear improvements.
docs/en/appservice/unified-om/inspection-mgt/functions/run_inspection_task.mdx (1)
32-32: Prompt symbol removed – good consistencyDocs now copy-paste without the extra
$.docs/en/developer/building_application/operation_maintaining/application_rollouts/canary_deployment.mdx (4)
26-26: Straight apostrophe – no content changeTypography normalized. ✅
354-376: CLI examples:$removedGood; keeps copy-paste clean.
391-400: Same here – consistent style maintained
431-445: Promote / get rollout commands cleaned upLooks fine.
docs/en/virtualization/virtualization/network/how_to/vm_sriov.mdx (4)
12-16: Table header alignment fixedPipe/colon alignment now renders correctly. 👍
52-60: Removed$beforedmidecode– goodKeeps shell blocks copy-paste-ready.
373-376:kubectl getprompt cleaned – looks good
398-404: Good removal of$– copy-paste friendlydocs/en/observability/monitor/how_to/restore_prometheus.mdx (1)
14-18: Consistent YAML & shell-block indentation looks goodIndentation of YAML and shell snippets is now consistent with the rest of the docs, improving copy-paste reliability and MDX rendering.
Also applies to: 42-44, 56-66, 71-73, 79-88, 90-90
docs/en/developer/building_application/application_workloads/deamonset_create.mdx (1)
15-26: Formatting touch-ups LGTMBullet alignment, fenced-code indentation and table reflow read well and don’t change semantics.
Also applies to: 62-84, 92-95, 120-134, 150-159, 168-176, 184-192
docs/en/developer/building_application/operation_maintaining/application_rollouts/bluegreen_deployment.mdx (1)
29-29: Shell prompt symbols dropped – niceRemoving leading
$keeps commands copy-friendly; heading and status block tweaks are harmless.Also applies to: 225-226, 295-301, 330-337
docs/en/developer/building_application/application_workloads/job_create.mdx (1)
12-12: Job manifest & CLI snippets now consistently indentedThe YAML comments and fenced bash blocks are clearer and align with style elsewhere.
Also applies to: 30-41, 46-53, 56-64, 68-70
docs/en/gitops/functions/create_argocd_application/create_application_via_platform.mdx (1)
36-45: Table re-alignment looks goodVisual alignment &
<br/>usage render correctly in common MD viewers – no functional or semantic issues detected.docs/en/developer/building_application/application_workloads/statefulset_create.mdx (3)
15-23: Formatting tweaks look correct, but keep emphasis style consistent project-wideYou swapped asterisks → underscores for italic text. That is fine, yet other docs still rely on the old style. Before merging, confirm that the docs renderer / MDX pipeline treats both identically and that we are not mixing emphasis conventions in the same repo.
44-62: Double-checkserviceName↔ Service metadata.nameThe YAML comment says this headless Service is responsible for pod identity, but
serviceName: 'nginx'will only work if the Service block below keepsmetadata.name: nginx(case-sensitive).
From the snippet that follows (lines 72-86) that seems to be true—good. Just flagging this because a previous typo here silently breaks DNS.
157-165: CLI block fenced correctly – nice catchIndentation now aligns with surrounding bullets, fixing previous lint warning.
docs/en/observability/monitor/functions/manage_metrics.mdx (2)
51-64: Great addition of pretty-printed JSON sampleThe multiline fence plus syntax hint improve legibility; no further issues.
92-118: Verify[!code callout]tags render correctly in MDXSome MDX setups strip or mis-render these custom callout hints. If our site uses remark-directive this is fine; otherwise the raw text will leak. Please preview before merging.
docs/en/observability/monitor/functions/manage_blackbox.mdx (1)
129-130: Good catch replacing smart quotes incurlStraight quotes avoid shell copy-paste issues. 👍
docs/en/developer/building_application/operation_maintaining/add_hpa.mdx
Show resolved
Hide resolved
docs/en/developer/building_application/operation_maintaining/healthcheck.mdx
Outdated
Show resolved
Hide resolved
docs/en/hardware_accelerator/application_development/trouble_shooting/paddle_native_best.mdx
Show resolved
Hide resolved
docs/en/developer/building_application/application_workloads/pod.mdx
Outdated
Show resolved
Hide resolved
JounQin
force-pushed
the
fix/lint
branch
3 times, most recently
from
f65a8f6 to
b6f43cf
Compare
There was a problem hiding this comment.
Actionable comments posted: 1
🔭 Outside diff range comments (1)
docs/en/hardware_accelerator/application_development/trouble_shooting/paddle_native_best.mdx (1)
133-140: Prometheus rule block uses•bullet – also invalid YAMLSame problem as above: replace the dingbat with
-and fix indentation.- • alert: GPUAllocConflict + - alert: GPUAllocConflictMake sure subsequent keys (
expr,labels,annotations) are indented two spaces under the new hyphen.
♻️ Duplicate comments (1)
docs/en/hardware_accelerator/application_development/trouble_shooting/paddle_native_best.mdx (1)
59-70: YAML snippet still uses decorative bullet characters (◦,▪) – invalid YAMLThis exact issue was raised in a previous review and hasn’t been addressed.
YAML parsers will choke on these Unicode dingbats; use a hyphen (-) instead.- ◦ name: paddle-container - env: - ▪ name: FLAGS_allocator_strategy - value: "naive_best_fit" + - name: paddle-container + env: + - name: FLAGS_allocator_strategy + value: "naive_best_fit"
🧹 Nitpick comments (14)
docs/en/developer/oam_applications/concepts/cue.mdx (1)
25-25: Minor wording nitpick – simplify “in conjunction with”.The phrase is a bit verbose. Consider tightening the sentence for clarity:
-| `*` specifies the default value of the variable, and in conjunction with `\|`, defines an int type variable a with a default value of 1. +| `*` sets the variable’s default value, and together with `\|`, defines an int variable `a` whose default is `1`.docs/en/storage/storagesystem_minio/architecture.mdx (1)
10-10: Nitpick: drop the trailing colons in headings for cleaner anchors.Many Markdown engines (including Docusaurus & GitHub) treat the full heading text when generating a URL slug, so a trailing colon ends up in the anchor (e.g.,
#core-components:). Removing the colon keeps anchors predictable and avoids ugly%3Aencodings in links.-## Core Components: +## Core ComponentsApply the same to the other three headings.
Also applies to: 16-16, 20-20, 24-24
docs/en/virtualization/virtualization/virtual_machine/how_to/create-template.mdx (2)
17-19: Avoid repetitive sentence starts for smoother reading
Three consecutive bullets begin with “Install …”. Consider collapsing them or varying the wording to remove the mechanical repetition.- - Install [cloud-init](https://cloud-init.io/). - - Install the `qemu-guest-agent`. - - Install any required software. + - Install [cloud-init](https://cloud-init.io/). + - Add the `qemu-guest-agent`. + - Install any other required software.
40-50: Enhance the CLI snippet to output just the names
kubectl get volumesnapshotsprints a wide table that still requires manual copy-pasting. Filtering directly to the resource names makes the step copy-friendly and less error-prone.- kubectl get volumesnapshots -n <NAMESPACE> + kubectl get volumesnapshots -n <NAMESPACE> \ + -o jsonpath='{.items[*].metadata.name}'docs/en/developer/building_application/create_applications/cli.mdx (2)
22-26: Fix typo in step 1
Contianer→Container. The typo slipped into the rendered UI and search indices.-1. **Contianer Platform**, click the terminal icon in the lower-right corner. +1. **Container Platform**, click the terminal icon in the lower-right corner.
30-32: Align placeholder style with earlier example
Line 31 uses${CURRENT_NAMESPACE}while later examples (103-107) use{CURRENT_NAMESPACE}. Pick one convention (ideally${PLACEHOLDER}to match shell-variable syntax) to avoid confusing readers.docs/en/developer/building_application/create_applications/image_app.mdx (2)
58-60: Prefer Markdown heading anchors over raw HTML tags
<a id="schuconf" />works but is inconsistent with the new{#anchor}style adopted above. Consider:-<a id="schuconf" /> ### Node Affinity Rules {#schuconf}Keeps the document uniform and removes raw HTML.
140-142: Spelling in linked path
deamonset_create.mdxis still miss-spelled; should bedaemonset_create.mdx. Even though the link itself wasn’t edited in this patch, it’s in the same changed block – worth correcting now to avoid broken docs.-../application_workloads/deamonset_create.mdx +../application_workloads/daemonset_create.mdxdocs/en/developer/building_application/namespace/create_namespace.mdx (2)
65-70: Prefer simple string literal forrowSpanto improve readabilityUsing a JSX expression (
rowSpan={2}) is technically valid in MDX, but a plain string attribute is clearer and avoids an unnecessary expression.-<td rowSpan={2}><b>Storage Resource Quota</b></td> +<td rowSpan="2"><b>Storage Resource Quota</b></td>
97-98: Remove redundant word “specific”The phrase “specific details” is tautological.
-7. (Optional) Configure **Pod Security Admission**; please refer to [Pod Security Admission](./security_policies.mdx) for specific details. +7. (Optional) Configure **Pod Security Admission**; please refer to [Pod Security Admission](./security_policies.mdx) for details.docs/en/configure/networking/functions/configure_service.mdx (4)
64-64: Deduplicate sentence openers in bullet listThree successive bullets start with “You…”, which LanguageTool rightfully flags. A quick re-wording preserves meaning and improves flow:
- - You're using StatefulSets where each Pod must have a stable DNS name. + - For StatefulSets, each Pod must have a stable DNS name.
103-103: Typo in heading
Cluste→Cluster.-## Example: Accessing an Application Within the Cluste +## Example: Accessing an Application Within the Cluster
286-286: Typo: “Servce” → “Service”-## Example: ExternalName type of Servce +## Example: ExternalName type of Service
142-158: Add one extra space to indent code blocks under numbered itemsWithin ordered lists, GitHub-flavoured Markdown requires fenced code blocks to be indented four spaces (one tab) relative to the list marker. The current examples use only three spaces, which can render as plain text in some parsers.
Please update every shell/YAML code fence in the following ranges by adding one leading space:
- docs/en/configure/networking/functions/configure_service.mdx: lines 142–158
- docs/en/configure/networking/functions/configure_service.mdx: lines 202–216
- docs/en/configure/networking/functions/configure_service.mdx: lines 261–280
- docs/en/configure/networking/functions/configure_service.mdx: lines 301–315
Example diff:
- ```shell + ```shell
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
⛔ Files ignored due to path filters (1)
yarn.lockis excluded by!**/yarn.lock,!**/*.lock
📒 Files selected for processing (95)
.cspell/abbreviations.txt(1 hunks)docs/en/appservice/overview/architecture.mdx(1 hunks)docs/en/appservice/unified-om/inspection-mgt/functions/create_inspection_task.mdx(2 hunks)docs/en/appservice/unified-om/inspection-mgt/functions/run_inspection_task.mdx(1 hunks)docs/en/appservice/unified-om/inspection-mgt/functions/update_inspection_task.mdx(1 hunks)docs/en/appservice/unified-om/intro.mdx(1 hunks)docs/en/configure/machine_config/managing.mdx(1 hunks)docs/en/configure/machine_config/node_disruption.mdx(1 hunks)docs/en/configure/networking/architecture/understanding_alb.mdx(1 hunks)docs/en/configure/networking/concepts/network_communications.mdx(1 hunks)docs/en/configure/networking/functions/configure_ingress.mdx(2 hunks)docs/en/configure/networking/functions/configure_network_policy.mdx(1 hunks)docs/en/configure/networking/functions/configure_service.mdx(5 hunks)docs/en/configure/networking/how_to/create_loadbalancer.mdx(2 hunks)docs/en/configure/networking/how_to/decide_performance_selection.mdx(5 hunks)docs/en/configure/networking/how_to/proxy_ipv6_traffic_to_ipv4_pod.mdx(1 hunks)docs/en/configure/networking/how_to/underlay_overlay_st.mdx(1 hunks)docs/en/configure/networking/how_to/use_oauth_proxy_with_alb.mdx(1 hunks)docs/en/configure/storage/concepts/key_concepts.mdx(3 hunks)docs/en/configure/storage/concepts/pv.mdx(2 hunks)docs/en/configure/storage/how_to/third_mask.mdx(1 hunks)docs/en/configure/storage/trouble_shooting/recovery_pvc_expansion.mdx(2 hunks)docs/en/developer/building_application/application_observability/log.mdx(2 hunks)docs/en/developer/building_application/application_workloads/container.mdx(8 hunks)docs/en/developer/building_application/application_workloads/deamonset_create.mdx(8 hunks)docs/en/developer/building_application/application_workloads/deployment_create.mdx(6 hunks)docs/en/developer/building_application/application_workloads/job_create.mdx(2 hunks)docs/en/developer/building_application/application_workloads/pod.mdx(4 hunks)docs/en/developer/building_application/application_workloads/statefulset_create.mdx(7 hunks)docs/en/developer/building_application/concepts/application_type.mdx(1 hunks)docs/en/developer/building_application/concepts/understanding_parameters.mdx(1 hunks)docs/en/developer/building_application/configuration/add_configmap.mdx(1 hunks)docs/en/developer/building_application/create_applications/cli.mdx(2 hunks)docs/en/developer/building_application/create_applications/image_app.mdx(4 hunks)docs/en/developer/building_application/create_applications/operator_app.mdx(3 hunks)docs/en/developer/building_application/create_applications/s2i_app.mdx(1 hunks)docs/en/developer/building_application/create_applications/yaml_app.mdx(2 hunks)docs/en/developer/building_application/namespace/create_namespace.mdx(3 hunks)docs/en/developer/building_application/namespace/manage_namespace.mdx(3 hunks)docs/en/developer/building_application/namespace/remove_namespace.mdx(1 hunks)docs/en/developer/building_application/namespace/resource_quota.mdx(4 hunks)docs/en/developer/building_application/namespace/security_policies.mdx(1 hunks)docs/en/developer/building_application/namespace/update_member.mdx(2 hunks)docs/en/developer/building_application/namespace/update_overcommit.mdx(1 hunks)docs/en/developer/building_application/operation_maintaining/add_cronhpa.mdx(3 hunks)docs/en/developer/building_application/operation_maintaining/add_hpa.mdx(2 hunks)docs/en/developer/building_application/operation_maintaining/add_vpa.mdx(2 hunks)docs/en/developer/building_application/operation_maintaining/application_rollouts/bluegreen_deployment.mdx(6 hunks)docs/en/developer/building_application/operation_maintaining/application_rollouts/canary_deployment.mdx(7 hunks)docs/en/developer/building_application/operation_maintaining/application_rollouts/install_argo_rollouts.mdx(1 hunks)docs/en/developer/building_application/operation_maintaining/healthcheck.mdx(4 hunks)docs/en/developer/building_application/working_with_helm_charts.mdx(5 hunks)docs/en/developer/oam_applications/concepts/cue.mdx(1 hunks)docs/en/developer/operator/functions/example_function.mdx(1 hunks)docs/en/developer/s2i/functions/s2i_application_management.mdx(0 hunks)docs/en/developer/s2i/intro.mdx(2 hunks)docs/en/extend/operator.mdx(1 hunks)docs/en/gitops/argocd_troubleshooting.mdx(6 hunks)docs/en/gitops/concept/alauda_gitops_concept_info/alauda_gitops_concept_argocd.mdx(1 hunks)docs/en/gitops/concept/argocd_concept_info/concept_argocd_tool.mdx(1 hunks)docs/en/gitops/concept/gitops_concept_infro.mdx(1 hunks)docs/en/gitops/functions/create_argocd_application/create_application_via_platform.mdx(4 hunks)docs/en/gitops/functions/create_argocd_application/create_applicationset_via_platform.mdx(4 hunks)docs/en/gitops/how_to/argocd_info.mdx(1 hunks)docs/en/hardware_accelerator/application_development/trouble_shooting/gpu_computer_less_shooting.mdx(7 hunks)docs/en/hardware_accelerator/application_development/trouble_shooting/paddle_native_best.mdx(5 hunks)docs/en/hardware_accelerator/overview/intro.mdx(2 hunks)docs/en/install/prepare/download.mdx(1 hunks)docs/en/install/prepare/node_preprocessing.mdx(1 hunks)docs/en/observability/inspection/intro.mdx(0 hunks)docs/en/observability/log/functions/log.mdx(3 hunks)docs/en/observability/monitor/functions/manage_alert.mdx(7 hunks)docs/en/observability/monitor/functions/manage_blackbox.mdx(6 hunks)docs/en/observability/monitor/functions/manage_dashboard.mdx(3 hunks)docs/en/observability/monitor/functions/manage_metrics.mdx(3 hunks)docs/en/observability/monitor/how_to/restore_prometheus.mdx(3 hunks)docs/en/overview/release_notes.mdx(2 hunks)docs/en/security/users_and_roles/idp/functions/oidc_manage.mdx(4 hunks)docs/en/security/users_and_roles/idp/trouble_shooting/delete_user.mdx(3 hunks)docs/en/storage/storagesystem_ceph/how_to/disaster_recovery/dr_block.mdx(16 hunks)docs/en/storage/storagesystem_ceph/how_to/disaster_recovery/dr_filesystem.mdx(5 hunks)docs/en/storage/storagesystem_ceph/how_to/disaster_recovery/dr_object.mdx(11 hunks)docs/en/storage/storagesystem_ceph/intro.mdx(1 hunks)docs/en/storage/storagesystem_minio/architecture.mdx(1 hunks)docs/en/storage/storagesystem_minio/functions/monitor.mdx(1 hunks)docs/en/storage/storagesystem_topolvm/how_to/backup_and_restore.mdx(1 hunks)docs/en/ui/cli_tools/index.mdx(8 hunks)docs/en/upgrade/upgrade_global_cluster.mdx(6 hunks)docs/en/virtualization/virtualization/image/how_to/vm_iso_linux.mdx(1 hunks)docs/en/virtualization/virtualization/image/how_to/vm_iso_windows.mdx(1 hunks)docs/en/virtualization/virtualization/network/how_to/vm_sriov.mdx(13 hunks)docs/en/virtualization/virtualization/virtual_machine/how_to/create-template.mdx(3 hunks)docs/en/virtualization/virtualization/virtual_machine/how_to/vm_clone.mdx(1 hunks)docs/en/virtualization/virtualization/virtual_machine/how_to/vm_usb_passthrough.mdx(5 hunks)package.json(1 hunks)
💤 Files with no reviewable changes (2)
- docs/en/developer/s2i/functions/s2i_application_management.mdx
- docs/en/observability/inspection/intro.mdx
✅ Files skipped from review due to trivial changes (50)
- docs/en/developer/building_application/create_applications/s2i_app.mdx
- docs/en/appservice/unified-om/intro.mdx
- docs/en/gitops/concept/alauda_gitops_concept_info/alauda_gitops_concept_argocd.mdx
- docs/en/gitops/concept/argocd_concept_info/concept_argocd_tool.mdx
- docs/en/storage/storagesystem_minio/functions/monitor.mdx
- docs/en/appservice/unified-om/inspection-mgt/functions/run_inspection_task.mdx
- docs/en/configure/networking/concepts/network_communications.mdx
- docs/en/extend/operator.mdx
- docs/en/configure/machine_config/node_disruption.mdx
- docs/en/configure/networking/functions/configure_network_policy.mdx
- docs/en/developer/operator/functions/example_function.mdx
- docs/en/storage/storagesystem_ceph/how_to/disaster_recovery/dr_filesystem.mdx
- docs/en/observability/monitor/how_to/restore_prometheus.mdx
- docs/en/developer/building_application/concepts/application_type.mdx
- docs/en/configure/storage/how_to/third_mask.mdx
- docs/en/developer/building_application/namespace/manage_namespace.mdx
- docs/en/developer/building_application/create_applications/operator_app.mdx
- docs/en/gitops/concept/gitops_concept_infro.mdx
- docs/en/gitops/how_to/argocd_info.mdx
- docs/en/configure/networking/functions/configure_ingress.mdx
- docs/en/configure/storage/concepts/pv.mdx
- docs/en/developer/building_application/namespace/remove_namespace.mdx
- docs/en/configure/networking/architecture/understanding_alb.mdx
- docs/en/virtualization/virtualization/virtual_machine/how_to/vm_clone.mdx
- docs/en/developer/building_application/application_workloads/deamonset_create.mdx
- docs/en/developer/building_application/application_workloads/container.mdx
- docs/en/observability/log/functions/log.mdx
- docs/en/storage/storagesystem_ceph/how_to/disaster_recovery/dr_block.mdx
- docs/en/gitops/functions/create_argocd_application/create_application_via_platform.mdx
- docs/en/ui/cli_tools/index.mdx
- docs/en/developer/building_application/namespace/security_policies.mdx
- docs/en/developer/building_application/application_workloads/pod.mdx
- docs/en/developer/building_application/operation_maintaining/add_hpa.mdx
- docs/en/gitops/argocd_troubleshooting.mdx
- docs/en/virtualization/virtualization/virtual_machine/how_to/vm_usb_passthrough.mdx
- docs/en/configure/storage/concepts/key_concepts.mdx
- docs/en/developer/building_application/operation_maintaining/application_rollouts/canary_deployment.mdx
- docs/en/configure/networking/how_to/create_loadbalancer.mdx
- docs/en/developer/building_application/operation_maintaining/add_cronhpa.mdx
- docs/en/storage/storagesystem_ceph/how_to/disaster_recovery/dr_object.mdx
- docs/en/configure/networking/how_to/use_oauth_proxy_with_alb.mdx
- docs/en/developer/building_application/operation_maintaining/add_vpa.mdx
- docs/en/appservice/unified-om/inspection-mgt/functions/update_inspection_task.mdx
- docs/en/developer/building_application/operation_maintaining/healthcheck.mdx
- docs/en/developer/building_application/application_workloads/deployment_create.mdx
- docs/en/observability/monitor/functions/manage_dashboard.mdx
- docs/en/developer/building_application/namespace/resource_quota.mdx
- docs/en/observability/monitor/functions/manage_metrics.mdx
- docs/en/developer/building_application/working_with_helm_charts.mdx
- docs/en/virtualization/virtualization/network/how_to/vm_sriov.mdx
🚧 Files skipped from review as they are similar to previous changes (35)
- .cspell/abbreviations.txt
- docs/en/virtualization/virtualization/image/how_to/vm_iso_linux.mdx
- docs/en/developer/building_application/configuration/add_configmap.mdx
- docs/en/appservice/overview/architecture.mdx
- docs/en/hardware_accelerator/overview/intro.mdx
- docs/en/overview/release_notes.mdx
- docs/en/developer/building_application/concepts/understanding_parameters.mdx
- docs/en/configure/networking/how_to/underlay_overlay_st.mdx
- package.json
- docs/en/install/prepare/download.mdx
- docs/en/appservice/unified-om/inspection-mgt/functions/create_inspection_task.mdx
- docs/en/storage/storagesystem_topolvm/how_to/backup_and_restore.mdx
- docs/en/storage/storagesystem_ceph/intro.mdx
- docs/en/developer/building_application/operation_maintaining/application_rollouts/install_argo_rollouts.mdx
- docs/en/developer/building_application/namespace/update_member.mdx
- docs/en/developer/building_application/create_applications/yaml_app.mdx
- docs/en/security/users_and_roles/idp/functions/oidc_manage.mdx
- docs/en/virtualization/virtualization/image/how_to/vm_iso_windows.mdx
- docs/en/configure/networking/how_to/proxy_ipv6_traffic_to_ipv4_pod.mdx
- docs/en/developer/building_application/namespace/update_overcommit.mdx
- docs/en/configure/storage/trouble_shooting/recovery_pvc_expansion.mdx
- docs/en/security/users_and_roles/idp/trouble_shooting/delete_user.mdx
- docs/en/upgrade/upgrade_global_cluster.mdx
- docs/en/install/prepare/node_preprocessing.mdx
- docs/en/developer/building_application/application_workloads/job_create.mdx
- docs/en/configure/networking/how_to/decide_performance_selection.mdx
- docs/en/developer/building_application/application_observability/log.mdx
- docs/en/configure/machine_config/managing.mdx
- docs/en/hardware_accelerator/application_development/trouble_shooting/gpu_computer_less_shooting.mdx
- docs/en/observability/monitor/functions/manage_alert.mdx
- docs/en/developer/building_application/operation_maintaining/application_rollouts/bluegreen_deployment.mdx
- docs/en/developer/s2i/intro.mdx
- docs/en/developer/building_application/application_workloads/statefulset_create.mdx
- docs/en/observability/monitor/functions/manage_blackbox.mdx
- docs/en/gitops/functions/create_argocd_application/create_applicationset_via_platform.mdx
🧰 Additional context used
🧠 Learnings (1)
docs/en/virtualization/virtualization/virtual_machine/how_to/create-template.mdx (1)
Learnt from: fanzy618
PR: alauda/acp-docs#10
File: docs/en/virtualization/virtualization/virtual_machine/how_to/vm_clone.mdx:52-54
Timestamp: 2025-06-26T06:40:06.969Z
Learning: VirtualMachineClone resources in KubeVirt have a Ready condition in their status that gets set to "True" when the clone operation succeeds, allowing kubectl wait --for condition=Ready to work correctly.
🪛 LanguageTool
docs/en/configure/networking/functions/configure_service.mdx
[style] ~64-~64: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...ses like Cassandra or StatefulSets). - You're using StatefulSets where each Pod mu...
(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
docs/en/developer/building_application/create_applications/cli.mdx
[grammar] ~24-~24: Ensure spelling is correct
Context: ... switch is enabled. ## Procedure 1. Contianer Platform, click the terminal icon in ...
(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)
docs/en/developer/building_application/namespace/create_namespace.mdx
[style] ~97-~97: This phrase is redundant. Consider writing “details”.
Context: ...Admission](./security_policies.mdx) for specific details. 8. (Optional) In the **More Configur...
(SPECIFIC_DETAILS)
docs/en/developer/oam_applications/concepts/cue.mdx
[style] ~25-~25: ‘in conjunction with’ might be wordy. Consider a shorter alternative.
Context: ... the default value of the variable, and in conjunction with \|, defines an int type variable a wi...
(EN_WORDINESS_PREMIUM_IN_CONJUNCTION_WITH)
docs/en/hardware_accelerator/application_development/trouble_shooting/paddle_native_best.mdx
[uncategorized] ~84-~84: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...-name> -- env | grep FLAGS ``` #### Bare Metal Deployment 1. Set environment variable...
(EN_COMPOUND_ADJECTIVE_INTERNAL)
docs/en/storage/storagesystem_minio/architecture.mdx
[style] ~14-~14: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...O's site replication functionality. - MinIO Pool: The core component of MinIO, re...
(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
docs/en/virtualization/virtualization/virtual_machine/how_to/create-template.mdx
[style] ~19-~19: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: .../). - Install the qemu-guest-agent. - Install any required software. Once installati...
(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
🔇 Additional comments (6)
docs/en/developer/oam_applications/concepts/cue.mdx (1)
25-25: Escaping the pipe improves table rendering—good catch.The
\|escape prevents Markdown from prematurely splitting the cell.docs/en/storage/storagesystem_minio/architecture.mdx (1)
10-24: Heading level upgrade improves structural consistency – looks good.Switching these section titles from
###to##aligns with the rest of the documentation hierarchy and removes an unnecessary nesting level.docs/en/virtualization/virtualization/virtual_machine/how_to/create-template.mdx (2)
7-9: Bulleted prerequisite list looks good
The added bullets make the prerequisites explicit and easy to skim.
91-92: Good emphasis on the default namespace & mutability
The bullet clarifies defaults while reminding users they can override them at VM-creation time.docs/en/developer/building_application/create_applications/image_app.mdx (1)
66-76: Indentation may break table rendering inside list
GitHub-style Markdown requires the pipe (|) of a table to be aligned under the list item prefix (two spaces after-). The current three-space indent (' |') can render as code block text in some parsers.Example fix (Kube-OVN table):
- | **Parameters** | **Description** | + | **Parameters** | **Description** |Please preview the page with the MDX renderer before merging.
docs/en/developer/building_application/namespace/create_namespace.mdx (1)
86-90: Verify anchor slug#otherquotasThe link points to
resource_quota.mdx#otherquotas, but most Markdown engines will generate#other-quotasfrom a heading “Other Quotas”.Please double-check the actual ID in
resource_quota.mdx; mismatched anchors break in-page navigation.
docs/en/developer/building_application/create_applications/image_app.mdx
Show resolved
Hide resolved
There was a problem hiding this comment.
Actionable comments posted: 1
♻️ Duplicate comments (2)
docs/en/hardware_accelerator/application_development/trouble_shooting/paddle_native_best.mdx (1)
133-140: Replace decorative bullet with a proper YAML list marker
• alert: GPUAllocConflictis still invalid YAML – the•dingbat is not recognized as a list indicator. Kubernetes-/Prometheus-related snippets are often copy-pasted; leaving this as-is will break CI pipelines or user copy-paste attempts.-• alert: GPUAllocConflict + - alert: GPUAllocConflictdocs/en/observability/monitor/functions/manage_dashboard.mdx (1)
116-146: Many “Pannel” typos persist in this sectionEven after the bulk rename, this chunk still contains:
- Section heading “Add Pannels”
- Anchor
{#add_pannel}- UI labels Add Pannel, Pannel Preview, Pannel Settings, etc.
-### Add Pannels {#add_pannel} +### Add Panels {#add_panel} -1. Click **Add Pannel**, ... +1. Click **Add Panel**, ...Please sweep the whole document (including anchors and cross-references) for
pannel/Panneland update them topanel/Panelto avoid broken links and inconsistent UI copy.
🧹 Nitpick comments (19)
docs/en/developer/oam_applications/concepts/cue.mdx (1)
25-25: Minor wording simplification
The phrase “and in conjunction with\|” is a bit verbose; consider trimming to “and, with\|, defines …”.docs/en/storage/storagesystem_minio/architecture.mdx (3)
10-15: Heading level promotion is fine; bullet wording can be tightenedThe new H2 is consistent with the rest of the docs.
Static-analysis flagged the repetitive “MinIO …” sentence openings. Trimming the brand prefix keeps the bullets concise without losing clarity:- **MinIO Operator**: Manages the deployment and upgrade of MinIO clusters. - **MinIO Peer**: Configures and manages MinIO's site replication functionality. - **MinIO Pool**: The core component of MinIO, responsible for handling object storage requests. Each pool corresponds to a StatefulSet and provides storage resources. + **Operator**: Manages the deployment and upgrade of MinIO clusters. + **Peer**: Configures and manages MinIO’s site-replication functionality. + **Pool**: Handles object-storage requests. Each pool maps to a StatefulSet and exposes storage resources.
16-19: Drop the trailing colon in the heading for cleaner anchorsSome Markdown engines include the colon when generating an ID, producing an awkward slug (
deployment-architecture:). Removing the colon avoids that edge-case and matches common style elsewhere in the docs.-## Deployment Architecture: +## Deployment Architecture
24-26: Colon consistencySame note as above: consider dropping the colon for uniform heading formatting.
-## Conclusion: +## Conclusiondocs/en/virtualization/virtualization/virtual_machine/how_to/create-template.mdx (4)
17-19: Consolidate repetitive “Install …” bullets for smoother readingThree successive bullets begin with “Install”, which triggers the linter and feels repetitive. Merging them into a single “Install” parent bullet with nested items keeps the imperative style while avoiding duplication.
- - Install [cloud-init](https://cloud-init.io/). - - Install the `qemu-guest-agent`. - - Install any required software. + - Install the following inside the guest OS: + - [cloud-init](https://cloud-init.io/) + - `qemu-guest-agent` + - Any additional software required by the template
40-42: Indent sub-steps to ensure Markdown renders correctlyThe two sub-bullets under “Via Web Console” are flush with the paragraph, which can break list rendering in some Markdown engines. Indent them by two spaces so they are recognised as children of the parent bullet.
-**Via Web Console:** - - Navigate to **Storage** > **Volume Snapshots**. - - Find and record the full snapshot resource name under "Data Source." +**Via Web Console:** + - Navigate to **Storage** > **Volume Snapshots**. + - Record the full snapshot resource name under **Data Source**.
44-50: Align “kubectl” section with the Web-Console sectionFor consistency with the previous bullet, indent the kubectl block as a child of “Using kubectl:” and tighten the follow-up sentence.
-**Using kubectl:** - - ```shell - kubectl get volumesnapshots -n <NAMESPACE> - ``` - - Record the complete snapshot resource name from the output. +**Using kubectl:** + ```shell + kubectl get volumesnapshots -n <NAMESPACE> + ``` + Record the snapshot’s full resource name from the output.
91-92: Capitalize list entries under “Important” for consistencyThe bullets under Important start with lowercase verbs, whereas earlier lists use sentence-case. Capitalising them keeps style uniform.
- - Ensure the namespace is `kube-public`. - - These disk-related parameters can be modified during VM creation but providing defaults simplifies the process. + - Ensure the namespace is `kube-public`. + - These disk-related parameters can be modified during VM creation, but providing defaults simplifies the process.docs/en/configure/networking/functions/configure_service.mdx (1)
142-158: Double-check fenced-code indentation – some blocks are indented three spacesMost list-nested fenced blocks were re-indented to three leading spaces.
GitHub-flavored Markdown tolerates this, but other MDX/remark parsers expect four spaces (or none) to treat the block as part of the list item. A mismatch can cause the code fence to terminate the list or render outside it.If the target site uses a strict MDX pipeline, bump the indent to four spaces:
- ```shell + ```shell kubectl apply -f access-internal-demo.yaml - ``` + ```Apply the same adjustment to every affected block (142-144, 149-150, 155-158, 202-204, 208-210, 214-216, 261-263, 267-269, 272-274, 278-280, 301-303, 307-309, 313-315) to guarantee consistent rendering.
Also applies to: 202-210, 214-216, 261-280, 301-309, 313-315
docs/en/observability/monitor/functions/manage_dashboard.mdx (3)
15-18: Replace Chinese list separators with English commas for consistencyThe bullet that enumerates supported panel types uses the Chinese
、punctuation mark instead of a comma. This is inconsistent with the rest of the English-language document and hurts searchability.- Supported panel types include: trend、step line chart、bar chart、horizontal bar chart、bar gauge chart、gauge chart、table、stat chart、XY chart、pie chart、text. + Supported panel types include: trend, step line chart, bar chart, horizontal bar chart, bar gauge chart, gauge chart, table, stat chart, XY chart, pie chart, and text.
157-165: Group-related bullet still refers to “Pannel”The repeat-group explanation still states “current pannels”. Replace with “current panels” to stay consistent.
No diff provided; simple one-word change in two places.
181-187: Fix “YMAL” → “YAML” in the operations tableSmall but visible typo in the operation name.
-| **YMAL** | Opens the actual CR resource code ... +| **YAML** | Opens the actual CR resource code ...docs/en/developer/building_application/namespace/create_namespace.mdx (7)
24-30: Clarify prefix requirement with an explicit exampleReaders might not immediately understand the expected format for the mandatory prefix. Adding a short example (e.g.,
project-a-dev) right after the description would remove any ambiguity.-| **Namespace** | The namespace name must include a mandatory prefix, which is the project name. | +| **Namespace** | The namespace name must include a mandatory project-name prefix (e.g., `my-project-foo`). |
38-48: Consider converting the GPU math into a compact formulaThe vGPU↔pGPU and MiB↔unit conversions are crystal-clear, but a terse formula (e.g., “
pGPU = vGPU ÷ 100”) would make quick mental checks even easier for readers skimming the docs.
53-94:rowSpanvsrowspan—prefer lowercase for raw HTML tablesAlthough MDX/JSX accepts
rowSpan, the file mixes raw Markdown with raw HTML.
Using the canonical lowercase attribute keeps the snippet valid outside a JSX pipeline (e.g., when rendered by GitHub ormarkdownlintpreviews).-<td rowSpan={2}><b>Storage Resource Quota</b></td> +<td rowspan="2"><b>Storage Resource Quota</b></td>(Apply to all similar cells.)
95-102: Drop the redundant word “specific”LanguageTool correctly flags “for specific details”. “for details” is leaner.
-(Optional) Configure **Pod Security Admission**; please refer to [Pod Security Admission](./security_policies.mdx) for specific details. +(Optional) Configure **Pod Security Admission**; please refer to [Pod Security Admission](./security_policies.mdx) for details.
107-118: Minor YAML style consistencyThe comment uses “Option,” which reads oddly; “Optional” matches earlier language.
- pod-security.kubernetes.io/audit: baseline # Option, to ensure security, it is recommended to choose the baseline or restricted mode. + pod-security.kubernetes.io/audit: baseline # Optional: choose baseline or restricted for better security.
120-133: Quote all scalar values or none—avoid mixing
limits.memory(20Gi) is unquoted while neighbouring numeric scalars are quoted. Pick one convention to prevent future YAML-lint warnings.- limits.cpu: '20' - limits.memory: 20Gi - pods: '500' - requests.cpu: '2' - requests.memory: 2Gi + limits.cpu: '20' + limits.memory: '20Gi' + pods: '500' + requests.cpu: '2' + requests.memory: '2Gi'
167-168: Shell example: quote compositehardvalues for safer copy-pasteWithout quotes, some shells mangle the comma-separated list (
--hard=limits.cpu=20,limits.memory=20Gi,…). Wrapping in single quotes avoids expansion and aligns with upstream docs.-kubectl create resourcequota example-resourcequota --namespace=example --hard=limits.cpu=20,limits.memory=20Gi,pods=500 +kubectl create resourcequota example-resourcequota --namespace=example --hard='limits.cpu=20,limits.memory=20Gi,pods=500'
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
⛔ Files ignored due to path filters (1)
yarn.lockis excluded by!**/yarn.lock,!**/*.lock
📒 Files selected for processing (96)
.cspell/abbreviations.txt(1 hunks)docs/en/appservice/overview/architecture.mdx(1 hunks)docs/en/appservice/unified-om/inspection-mgt/functions/create_inspection_task.mdx(2 hunks)docs/en/appservice/unified-om/inspection-mgt/functions/run_inspection_task.mdx(1 hunks)docs/en/appservice/unified-om/inspection-mgt/functions/update_inspection_task.mdx(1 hunks)docs/en/appservice/unified-om/intro.mdx(1 hunks)docs/en/configure/machine_config/managing.mdx(1 hunks)docs/en/configure/machine_config/node_disruption.mdx(1 hunks)docs/en/configure/networking/architecture/understanding_alb.mdx(1 hunks)docs/en/configure/networking/concepts/network_communications.mdx(1 hunks)docs/en/configure/networking/functions/configure_ingress.mdx(2 hunks)docs/en/configure/networking/functions/configure_network_policy.mdx(1 hunks)docs/en/configure/networking/functions/configure_service.mdx(5 hunks)docs/en/configure/networking/how_to/create_loadbalancer.mdx(2 hunks)docs/en/configure/networking/how_to/decide_performance_selection.mdx(5 hunks)docs/en/configure/networking/how_to/proxy_ipv6_traffic_to_ipv4_pod.mdx(1 hunks)docs/en/configure/networking/how_to/underlay_overlay_st.mdx(1 hunks)docs/en/configure/networking/how_to/use_oauth_proxy_with_alb.mdx(1 hunks)docs/en/configure/storage/concepts/key_concepts.mdx(3 hunks)docs/en/configure/storage/concepts/pv.mdx(2 hunks)docs/en/configure/storage/how_to/third_mask.mdx(1 hunks)docs/en/configure/storage/trouble_shooting/recovery_pvc_expansion.mdx(2 hunks)docs/en/developer/building_application/application_observability/log.mdx(2 hunks)docs/en/developer/building_application/application_workloads/container.mdx(8 hunks)docs/en/developer/building_application/application_workloads/deamonset_create.mdx(8 hunks)docs/en/developer/building_application/application_workloads/deployment_create.mdx(6 hunks)docs/en/developer/building_application/application_workloads/job_create.mdx(2 hunks)docs/en/developer/building_application/application_workloads/pod.mdx(4 hunks)docs/en/developer/building_application/application_workloads/statefulset_create.mdx(7 hunks)docs/en/developer/building_application/concepts/application_type.mdx(1 hunks)docs/en/developer/building_application/concepts/understanding_parameters.mdx(1 hunks)docs/en/developer/building_application/configuration/add_configmap.mdx(1 hunks)docs/en/developer/building_application/create_applications/cli.mdx(2 hunks)docs/en/developer/building_application/create_applications/image_app.mdx(4 hunks)docs/en/developer/building_application/create_applications/operator_app.mdx(3 hunks)docs/en/developer/building_application/create_applications/s2i_app.mdx(1 hunks)docs/en/developer/building_application/create_applications/yaml_app.mdx(2 hunks)docs/en/developer/building_application/namespace/create_namespace.mdx(3 hunks)docs/en/developer/building_application/namespace/manage_namespace.mdx(3 hunks)docs/en/developer/building_application/namespace/remove_namespace.mdx(1 hunks)docs/en/developer/building_application/namespace/resource_quota.mdx(4 hunks)docs/en/developer/building_application/namespace/security_policies.mdx(1 hunks)docs/en/developer/building_application/namespace/update_member.mdx(2 hunks)docs/en/developer/building_application/namespace/update_overcommit.mdx(1 hunks)docs/en/developer/building_application/operation_maintaining/add_cronhpa.mdx(3 hunks)docs/en/developer/building_application/operation_maintaining/add_hpa.mdx(2 hunks)docs/en/developer/building_application/operation_maintaining/add_vpa.mdx(2 hunks)docs/en/developer/building_application/operation_maintaining/application_rollouts/bluegreen_deployment.mdx(6 hunks)docs/en/developer/building_application/operation_maintaining/application_rollouts/canary_deployment.mdx(7 hunks)docs/en/developer/building_application/operation_maintaining/application_rollouts/install_argo_rollouts.mdx(1 hunks)docs/en/developer/building_application/operation_maintaining/healthcheck.mdx(4 hunks)docs/en/developer/building_application/working_with_helm_charts.mdx(5 hunks)docs/en/developer/oam_applications/concepts/cue.mdx(1 hunks)docs/en/developer/operator/functions/example_function.mdx(1 hunks)docs/en/developer/s2i/functions/s2i_application_management.mdx(0 hunks)docs/en/developer/s2i/intro.mdx(2 hunks)docs/en/extend/operator.mdx(1 hunks)docs/en/gitops/argocd_troubleshooting.mdx(6 hunks)docs/en/gitops/concept/alauda_gitops_concept_info/alauda_gitops_concept_argocd.mdx(1 hunks)docs/en/gitops/concept/argocd_concept_info/concept_argocd_tool.mdx(1 hunks)docs/en/gitops/concept/gitops_concept_infro.mdx(1 hunks)docs/en/gitops/functions/create_argocd_application/create_application_via_platform.mdx(4 hunks)docs/en/gitops/functions/create_argocd_application/create_applicationset_via_platform.mdx(4 hunks)docs/en/gitops/how_to/argocd_info.mdx(1 hunks)docs/en/hardware_accelerator/application_development/trouble_shooting/gpu_computer_less_shooting.mdx(7 hunks)docs/en/hardware_accelerator/application_development/trouble_shooting/paddle_native_best.mdx(5 hunks)docs/en/hardware_accelerator/overview/intro.mdx(2 hunks)docs/en/install/prepare/download.mdx(1 hunks)docs/en/install/prepare/node_preprocessing.mdx(1 hunks)docs/en/observability/inspection/intro.mdx(0 hunks)docs/en/observability/log/functions/log.mdx(3 hunks)docs/en/observability/monitor/concept.mdx(1 hunks)docs/en/observability/monitor/functions/manage_alert.mdx(7 hunks)docs/en/observability/monitor/functions/manage_blackbox.mdx(6 hunks)docs/en/observability/monitor/functions/manage_dashboard.mdx(5 hunks)docs/en/observability/monitor/functions/manage_metrics.mdx(3 hunks)docs/en/observability/monitor/how_to/restore_prometheus.mdx(3 hunks)docs/en/overview/release_notes.mdx(2 hunks)docs/en/security/users_and_roles/idp/functions/oidc_manage.mdx(4 hunks)docs/en/security/users_and_roles/idp/trouble_shooting/delete_user.mdx(3 hunks)docs/en/storage/storagesystem_ceph/how_to/disaster_recovery/dr_block.mdx(16 hunks)docs/en/storage/storagesystem_ceph/how_to/disaster_recovery/dr_filesystem.mdx(5 hunks)docs/en/storage/storagesystem_ceph/how_to/disaster_recovery/dr_object.mdx(11 hunks)docs/en/storage/storagesystem_ceph/intro.mdx(1 hunks)docs/en/storage/storagesystem_minio/architecture.mdx(1 hunks)docs/en/storage/storagesystem_minio/functions/monitor.mdx(1 hunks)docs/en/storage/storagesystem_topolvm/how_to/backup_and_restore.mdx(1 hunks)docs/en/ui/cli_tools/index.mdx(8 hunks)docs/en/upgrade/upgrade_global_cluster.mdx(6 hunks)docs/en/virtualization/virtualization/image/how_to/vm_iso_linux.mdx(1 hunks)docs/en/virtualization/virtualization/image/how_to/vm_iso_windows.mdx(1 hunks)docs/en/virtualization/virtualization/network/how_to/vm_sriov.mdx(13 hunks)docs/en/virtualization/virtualization/virtual_machine/how_to/create-template.mdx(3 hunks)docs/en/virtualization/virtualization/virtual_machine/how_to/vm_clone.mdx(1 hunks)docs/en/virtualization/virtualization/virtual_machine/how_to/vm_usb_passthrough.mdx(5 hunks)package.json(1 hunks)
💤 Files with no reviewable changes (2)
- docs/en/observability/inspection/intro.mdx
- docs/en/developer/s2i/functions/s2i_application_management.mdx
✅ Files skipped from review due to trivial changes (33)
- docs/en/appservice/unified-om/intro.mdx
- docs/en/configure/networking/concepts/network_communications.mdx
- docs/en/gitops/concept/argocd_concept_info/concept_argocd_tool.mdx
- docs/en/configure/machine_config/node_disruption.mdx
- docs/en/observability/monitor/concept.mdx
- docs/en/extend/operator.mdx
- docs/en/appservice/unified-om/inspection-mgt/functions/run_inspection_task.mdx
- docs/en/configure/networking/functions/configure_network_policy.mdx
- docs/en/developer/building_application/operation_maintaining/application_rollouts/install_argo_rollouts.mdx
- docs/en/gitops/concept/alauda_gitops_concept_info/alauda_gitops_concept_argocd.mdx
- docs/en/virtualization/virtualization/virtual_machine/how_to/vm_clone.mdx
- docs/en/configure/storage/concepts/pv.mdx
- docs/en/storage/storagesystem_topolvm/how_to/backup_and_restore.mdx
- docs/en/gitops/concept/gitops_concept_infro.mdx
- docs/en/developer/building_application/application_workloads/deamonset_create.mdx
- docs/en/storage/storagesystem_ceph/how_to/disaster_recovery/dr_block.mdx
- docs/en/developer/building_application/application_observability/log.mdx
- docs/en/developer/building_application/operation_maintaining/add_cronhpa.mdx
- docs/en/virtualization/virtualization/network/how_to/vm_sriov.mdx
- docs/en/observability/log/functions/log.mdx
- docs/en/configure/storage/concepts/key_concepts.mdx
- docs/en/configure/storage/how_to/third_mask.mdx
- docs/en/developer/building_application/operation_maintaining/healthcheck.mdx
- docs/en/developer/building_application/operation_maintaining/add_vpa.mdx
- docs/en/developer/building_application/create_applications/cli.mdx
- docs/en/developer/building_application/operation_maintaining/add_hpa.mdx
- docs/en/observability/monitor/functions/manage_metrics.mdx
- docs/en/configure/networking/functions/configure_ingress.mdx
- docs/en/storage/storagesystem_ceph/how_to/disaster_recovery/dr_object.mdx
- docs/en/gitops/functions/create_argocd_application/create_application_via_platform.mdx
- docs/en/developer/building_application/application_workloads/pod.mdx
- docs/en/configure/networking/how_to/use_oauth_proxy_with_alb.mdx
- docs/en/appservice/unified-om/inspection-mgt/functions/update_inspection_task.mdx
🚧 Files skipped from review as they are similar to previous changes (54)
- .cspell/abbreviations.txt
- docs/en/configure/networking/architecture/understanding_alb.mdx
- docs/en/developer/building_application/create_applications/s2i_app.mdx
- docs/en/configure/storage/trouble_shooting/recovery_pvc_expansion.mdx
- docs/en/appservice/unified-om/inspection-mgt/functions/create_inspection_task.mdx
- docs/en/appservice/overview/architecture.mdx
- docs/en/install/prepare/node_preprocessing.mdx
- docs/en/virtualization/virtualization/image/how_to/vm_iso_linux.mdx
- docs/en/developer/building_application/namespace/manage_namespace.mdx
- package.json
- docs/en/developer/building_application/namespace/update_member.mdx
- docs/en/install/prepare/download.mdx
- docs/en/configure/networking/how_to/underlay_overlay_st.mdx
- docs/en/configure/networking/how_to/decide_performance_selection.mdx
- docs/en/overview/release_notes.mdx
- docs/en/observability/monitor/how_to/restore_prometheus.mdx
- docs/en/developer/building_application/create_applications/yaml_app.mdx
- docs/en/storage/storagesystem_ceph/intro.mdx
- docs/en/storage/storagesystem_minio/functions/monitor.mdx
- docs/en/developer/building_application/configuration/add_configmap.mdx
- docs/en/developer/operator/functions/example_function.mdx
- docs/en/gitops/how_to/argocd_info.mdx
- docs/en/virtualization/virtualization/image/how_to/vm_iso_windows.mdx
- docs/en/storage/storagesystem_ceph/how_to/disaster_recovery/dr_filesystem.mdx
- docs/en/developer/building_application/concepts/understanding_parameters.mdx
- docs/en/developer/building_application/namespace/update_overcommit.mdx
- docs/en/security/users_and_roles/idp/functions/oidc_manage.mdx
- docs/en/configure/networking/how_to/proxy_ipv6_traffic_to_ipv4_pod.mdx
- docs/en/hardware_accelerator/overview/intro.mdx
- docs/en/developer/building_application/namespace/remove_namespace.mdx
- docs/en/configure/machine_config/managing.mdx
- docs/en/developer/building_application/namespace/resource_quota.mdx
- docs/en/developer/building_application/application_workloads/job_create.mdx
- docs/en/upgrade/upgrade_global_cluster.mdx
- docs/en/observability/monitor/functions/manage_alert.mdx
- docs/en/gitops/functions/create_argocd_application/create_applicationset_via_platform.mdx
- docs/en/developer/building_application/concepts/application_type.mdx
- docs/en/developer/building_application/operation_maintaining/application_rollouts/bluegreen_deployment.mdx
- docs/en/security/users_and_roles/idp/trouble_shooting/delete_user.mdx
- docs/en/developer/building_application/create_applications/image_app.mdx
- docs/en/developer/building_application/operation_maintaining/application_rollouts/canary_deployment.mdx
- docs/en/gitops/argocd_troubleshooting.mdx
- docs/en/developer/building_application/create_applications/operator_app.mdx
- docs/en/hardware_accelerator/application_development/trouble_shooting/gpu_computer_less_shooting.mdx
- docs/en/developer/building_application/namespace/security_policies.mdx
- docs/en/configure/networking/how_to/create_loadbalancer.mdx
- docs/en/ui/cli_tools/index.mdx
- docs/en/virtualization/virtualization/virtual_machine/how_to/vm_usb_passthrough.mdx
- docs/en/developer/building_application/application_workloads/container.mdx
- docs/en/developer/building_application/working_with_helm_charts.mdx
- docs/en/developer/building_application/application_workloads/statefulset_create.mdx
- docs/en/observability/monitor/functions/manage_blackbox.mdx
- docs/en/developer/s2i/intro.mdx
- docs/en/developer/building_application/application_workloads/deployment_create.mdx
🧰 Additional context used
🧠 Learnings (1)
docs/en/virtualization/virtualization/virtual_machine/how_to/create-template.mdx (1)
Learnt from: fanzy618
PR: alauda/acp-docs#10
File: docs/en/virtualization/virtualization/virtual_machine/how_to/vm_clone.mdx:52-54
Timestamp: 2025-06-26T06:40:06.969Z
Learning: VirtualMachineClone resources in KubeVirt have a Ready condition in their status that gets set to "True" when the clone operation succeeds, allowing kubectl wait --for condition=Ready to work correctly.
🪛 LanguageTool
docs/en/configure/networking/functions/configure_service.mdx
[style] ~64-~64: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...ses like Cassandra or StatefulSets). - You're using StatefulSets where each Pod mu...
(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
docs/en/developer/building_application/namespace/create_namespace.mdx
[style] ~97-~97: This phrase is redundant. Consider writing “details”.
Context: ...Admission](./security_policies.mdx) for specific details. 8. (Optional) In the **More Configur...
(SPECIFIC_DETAILS)
docs/en/developer/oam_applications/concepts/cue.mdx
[style] ~25-~25: ‘in conjunction with’ might be wordy. Consider a shorter alternative.
Context: ... the default value of the variable, and in conjunction with \|, defines an int type variable a wi...
(EN_WORDINESS_PREMIUM_IN_CONJUNCTION_WITH)
docs/en/hardware_accelerator/application_development/trouble_shooting/paddle_native_best.mdx
[uncategorized] ~84-~84: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...-name> -- env | grep FLAGS ``` #### Bare Metal Deployment 1. Set environment variable...
(EN_COMPOUND_ADJECTIVE_INTERNAL)
docs/en/observability/monitor/functions/manage_dashboard.mdx
[style] ~144-~144: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...rearrange the order of the panels. - Click the Edit button to modify the panel...
(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
[style] ~145-~145: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...tton to modify the panel settings. - Click the Delete button to delete the pan...
(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
[style] ~146-~146: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...lete** button to delete the panel. - Click the Copy button to copy the panel. ...
(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
docs/en/storage/storagesystem_minio/architecture.mdx
[style] ~14-~14: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...O's site replication functionality. - MinIO Pool: The core component of MinIO, re...
(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
docs/en/virtualization/virtualization/virtual_machine/how_to/create-template.mdx
[style] ~19-~19: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: .../). - Install the qemu-guest-agent. - Install any required software. Once installati...
(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
🔇 Additional comments (5)
docs/en/developer/oam_applications/concepts/cue.mdx (1)
25-25: Escaping the pipe improves table rendering – good catch!
This change prevents Markdown from prematurely splitting the cell, ensuring thea: *1 \| intexample renders correctly.docs/en/storage/storagesystem_minio/architecture.mdx (1)
20-23: LGTM – level promotion aligns with the new hierarchyNothing else to flag here; the content and anchor remain intact.
docs/en/configure/networking/functions/configure_service.mdx (1)
64-65: Typographic fix looks goodThe contraction change from “You’re” to “You're” resolves the apostrophe style inconsistency noted by
doom lint.docs/en/observability/monitor/functions/manage_dashboard.mdx (1)
57-64: Table still mentions “panels” but surrounding text left some “pannel” typosGreat that the description column now uses the correct spelling “panels”.
However, multiple occurrences of the old spelling remain further down the file (see §§ Add Pannels, Manage Pannels, YAML snippet, etc.). Consider running a global search-and-replace to eradicate the leftover “pannel”/“pannels”.docs/en/developer/building_application/namespace/create_namespace.mdx (1)
49-52: 👍 Clear default-quota behaviourThe added explanation removes any guess-work for users. No further action required.
|
@coderabbitai full review |
✅ Actions performedFull review triggered. |
|
@coderabbitai Haven't finished? |
|
Tip For best results, initiate chat on the files or code changes. @JounQin The full review has actually been completed! The comprehensive walkthrough and summary you see above covers all 98 files in this PR. This includes: ✅ Completed Review Analysis:
The review shows this is a well-executed documentation maintenance PR focused on formatting consistency and lint compliance. All changes are cosmetic improvements that don't affect functionality. If you were expecting detailed file-by-file comments, this type of widespread formatting cleanup typically gets a consolidated review rather than individual file comments, since the changes follow consistent patterns across all files. Is there a specific aspect of the changes you'd like me to focus on or any particular files you'd like me to examine more closely? |
✅ Actions performedFull review triggered. |
2 participants
Summary by CodeRabbit
Documentation
Chores