docs: add cp nwc docs#810
Open
yinshuxun wants to merge 1 commit into
Open
Conversation
Contributor
WalkthroughThis pull request consolidates developer documentation for ACP application workflows by establishing a unified "Building Applications" navigation hub, explicitly separating Applications view (project/namespace scoped) from Clusters view (cluster scoped) across workloads, creation, configuration, and namespace operations, with pre-submission checklists and operational review points. ChangesApplication Workflows Documentation
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes Poem
🚥 Pre-merge checks | ✅ 4 | ❌ 1❌ Failed checks (1 inconclusive)
✅ Passed checks (4 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Warning There were issues while running some tools. Please review the errors and either fix the tool's configuration or disable the tool if it's a critical failure. 🔧 ESLint
ESLint skipped: no ESLint configuration detected in root package.json. To enable, add Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
Contributor
There was a problem hiding this comment.
Actionable comments posted: 5
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In
`@docs/en/developer/building_application/application_workloads/statefulset_create.mdx`:
- Line 183: The heading text "Heath Checks" is misspelled; update the heading
string in the document to "Health Checks" (locate the heading line that
currently reads "## Heath Checks" and change it to "## Health Checks") so the
section title is corrected across the documentation.
In `@docs/en/developer/building_application/create_applications/s2i_app.mdx`:
- Around line 30-35: Replace the inconsistent action name "Create from Git" with
the page's established "Create from Code" in the "Applications view" and
"Clusters view" sections (the bullet items mentioning selecting
Cluster/Namespace and starting the Git-based workflow), and update the other
occurrences noted (the repeated mentions around the later block that spans the
same wording) so the document consistently uses "Create from Code" to match the
core procedure.
In `@docs/en/developer/building_application/index.mdx`:
- Line 21: The current navigation entry points both creation and update flows to
create_applications which causes ambiguity; update the documentation so
create_applications only covers application creation (or explicitly split update
types into distinct entries), and route operational updates/maintenance flows to
operation_maintaining (or add a clear “Updates / Maintenance” link) so readers
choose creation vs update unambiguously.
In `@docs/en/developer/building_application/namespace/manage_namespace.mdx`:
- Around line 113-114: In the "update workflow" subsection of
manage_namespace.mdx replace the current line "Use **Actions** to choose
**Update**, **Delete**" so it no longer mentions the destructive Delete action;
change it to only reference Update (e.g., "Use **Actions** to choose
**Update**") and, if needed, move or reference Delete in a separate "delete
namespace" or lifecycle section rather than inside the update guidance to avoid
misdirecting users.
In `@docs/en/developer/building_application/namespace/update_overcommit.mdx`:
- Around line 81-83: The scope sentence about "project context or cluster
context" is inconsistent with the following content that only documents the
Applications path; update the wording in the paragraph that mentions "namespace
governance" so it accurately reflects what's covered (either: add a new "Update
from the Clusters view" subsection that provides the cluster-based steps, or
change the sentence to state that only the Applications path is documented here
and point readers to the cluster-path guidance elsewhere). Make the same
alignment for the following block (lines 83–92) and ensure the section headers
"Update from the Applications view" (and a new "Update from the Clusters view"
if added) are used so readers can find the appropriate path.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro
Run ID: 492cb77e-c6b4-4b65-aa4f-5c761988f6e5
📒 Files selected for processing (34)
docs/en/developer/building_application/application_observability/event.mdxdocs/en/developer/building_application/application_observability/index.mdxdocs/en/developer/building_application/application_observability/log.mdxdocs/en/developer/building_application/application_observability/monitor.mdxdocs/en/developer/building_application/application_workloads/cronjob_create.mdxdocs/en/developer/building_application/application_workloads/deamonset_create.mdxdocs/en/developer/building_application/application_workloads/deployment_create.mdxdocs/en/developer/building_application/application_workloads/index.mdxdocs/en/developer/building_application/application_workloads/job_create.mdxdocs/en/developer/building_application/application_workloads/pod.mdxdocs/en/developer/building_application/application_workloads/statefulset_create.mdxdocs/en/developer/building_application/configuration/add_configmap.mdxdocs/en/developer/building_application/configuration/add_secret.mdxdocs/en/developer/building_application/configuration/index.mdxdocs/en/developer/building_application/create_applications/chart_app.mdxdocs/en/developer/building_application/create_applications/image_app.mdxdocs/en/developer/building_application/create_applications/s2i_app.mdxdocs/en/developer/building_application/create_applications/yaml_app.mdxdocs/en/developer/building_application/index.mdxdocs/en/developer/building_application/namespace/create_namespace.mdxdocs/en/developer/building_application/namespace/import_namespace.mdxdocs/en/developer/building_application/namespace/index.mdxdocs/en/developer/building_application/namespace/manage_namespace.mdxdocs/en/developer/building_application/namespace/remove_namespace.mdxdocs/en/developer/building_application/namespace/update_member.mdxdocs/en/developer/building_application/namespace/update_overcommit.mdxdocs/en/developer/building_application/operation_maintaining/application_upgrade.mdxdocs/en/developer/building_application/operation_maintaining/export.mdxdocs/en/developer/building_application/operation_maintaining/index.mdxdocs/en/developer/building_application/operation_maintaining/status.mdxdocs/en/developer/building_application/operation_maintaining/version.mdxdocs/en/developer/index.mdxdocs/en/developer/overview.mdxdocs/en/ui/web_console/customization.mdx
| - Whether configuration changes could affect data continuity or replica replacement behavior | ||
| - Whether the workload also expects a stable network identity through a related Service | ||
|
|
||
| ## Heath Checks |
Contributor
There was a problem hiding this comment.
Fix heading typo on Line 183 ("Heath" → "Health").
✏️ Proposed fix
-## Heath Checks
+## Health Checks📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
Suggested change
| ## Heath Checks | |
| ## Health Checks |
🧰 Tools
🪛 LanguageTool
[grammar] ~183-~183: Ensure spelling is correct
Context: ... identity through a related Service ## Heath Checks - [Health checks YAML file exam...
(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In
`@docs/en/developer/building_application/application_workloads/statefulset_create.mdx`
at line 183, The heading text "Heath Checks" is misspelled; update the heading
string in the document to "Health Checks" (locate the heading line that
currently reads "## Heath Checks" and change it to "## Health Checks") so the
section title is corrected across the documentation.
Comment on lines
+30
to
+35
| ## Creation entry differences between the Applications and Clusters views | ||
|
|
||
| The new web console can expose Git-based creation from different views. Choose the entry based on whether you are working from project scope or from a concrete cluster. | ||
|
|
||
| - **Applications view**: Start from the current project. Open **Applications** > **Applications**, click **Create from Git**, select the target **Cluster** first, then select the target **Namespace**, and continue with repository, build, deployment, and network configuration. | ||
| - **Clusters view**: Start from a concrete cluster. Open the target cluster first, enter the target namespace, and then navigate to **Applications** or the related build-and-deploy creation entry in that cluster context to start the Git-based workflow. |
Contributor
There was a problem hiding this comment.
Align action naming with the page’s existing “Create from Code” flow.
The new section repeatedly says Create from Git, but the same page’s core procedure still uses Create from Code (Line 22). This can misroute users in the UI.
Suggested wording patch
-- **Applications view**: Start from the current project. Open **Applications** > **Applications**, click **Create from Git**, select the target **Cluster** first, then select the target **Namespace**, and continue with repository, build, deployment, and network configuration.
+- **Applications view**: Start from the current project. Open **Applications** > **Applications**, click **Create from Code** (Git-based), select the target **Cluster** first, then select the target **Namespace**, and continue with repository, build, deployment, and network configuration.
-2. Click **Create from Git**.
+2. Click **Create from Code** (Git-based).Also applies to: 48-53
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In `@docs/en/developer/building_application/create_applications/s2i_app.mdx`
around lines 30 - 35, Replace the inconsistent action name "Create from Git"
with the page's established "Create from Code" in the "Applications view" and
"Clusters view" sections (the bullet items mentioning selecting
Cluster/Namespace and starting the Git-based workflow), and update the other
occurrences noted (the repeated mentions around the later block that spans the
same wording) so the document consistently uses "Create from Code" to match the
core procedure.
|
|
||
| In most cases: | ||
|
|
||
| - Use `create_applications` for application creation and update paths. |
Contributor
There was a problem hiding this comment.
Clarify update workflow ownership to avoid navigation ambiguity.
Line 21 currently routes both creation and update to create_applications, but Line 25 positions operational changes under operation_maintaining. Consider limiting Line 21 to creation only (or explicitly split update types) so readers don’t choose the wrong path.
Suggested edit
-- Use `create_applications` for application creation and update paths.
+- Use `create_applications` for application creation paths.📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
Suggested change
| - Use `create_applications` for application creation and update paths. | |
| - Use `create_applications` for application creation paths. |
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In `@docs/en/developer/building_application/index.mdx` at line 21, The current
navigation entry points both creation and update flows to create_applications
which causes ambiguity; update the documentation so create_applications only
covers application creation (or explicitly split update types into distinct
entries), and route operational updates/maintenance flows to
operation_maintaining (or add a clear “Updates / Maintenance” link) so readers
choose creation vs update unambiguously.
Comment on lines
+81
to
+83
| This setting belongs to namespace governance, so the entry depends on whether you are operating from a project context or a concrete cluster context. | ||
|
|
||
| ### Update from the Applications view |
Contributor
There was a problem hiding this comment.
Align the scope statement with the sections that follow.
The text says entry depends on project context or cluster context, but only the Applications path is documented here. Please either add a Clusters subsection or explicitly state cluster-path guidance is covered elsewhere.
Also applies to: 83-92
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In `@docs/en/developer/building_application/namespace/update_overcommit.mdx`
around lines 81 - 83, The scope sentence about "project context or cluster
context" is inconsistent with the following content that only documents the
Applications path; update the wording in the paragraph that mentions "namespace
governance" so it accurately reflects what's covered (either: add a new "Update
from the Clusters view" subsection that provides the cluster-based steps, or
change the sentence to state that only the Applications path is documented here
and point readers to the cluster-path guidance elsewhere). Make the same
alignment for the following block (lines 83–92) and ensure the section headers
"Update from the Applications view" (and a new "Update from the Clusters view"
if added) are used so readers can find the appropriate path.
Deploying alauda-container-platform with
|
| Latest commit: |
6029f43
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://7d6e64e0.alauda-container-platform.pages.dev |
| Branch Preview URL: | https://docs-cp-nwc-doc-completion.alauda-container-platform.pages.dev |
yinshuxun
force-pushed
the
docs/cp-nwc-doc-completion
branch
from
076d659 to
1baf3ee
Compare
Contributor
There was a problem hiding this comment.
Actionable comments posted: 4
🧹 Nitpick comments (2)
docs/en/developer/building_application/namespace/create_namespace.mdx (2)
119-126: 💤 Low valueConsider streamlining the pre-submission checklist.
The checklist mixes verification items (things to confirm) with explanatory notes (UI flow rationale). Lines 121-122 overlap: line 121 asks to confirm cluster-project association, while line 122 explains the UI sequencing. Consider consolidating or separating verification steps from explanatory context to improve clarity.
♻️ Example streamlined checklist
Before submitting the form, confirm that: -- the target cluster is already associated with the current project -- cluster selection happens before namespace submission because the namespace is created as part of the current project's cluster-scoped governance workflow +- the target cluster is already associated with the current project (cluster selection is required first because the namespace is created within the project's governance scope) - the namespace naming rule matches current project governance expectations - quota, limit range, security policy, labels, and annotations reflect the intended workload baseline - the namespace appears afterward in the current project and is associated with the expected cluster🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@docs/en/developer/building_application/namespace/create_namespace.mdx` around lines 119 - 126, The checklist mixes verification steps with explanatory UI rationale; separate or consolidate them by moving the UI flow explanation ("cluster selection happens before namespace submission because the namespace is created as part of the current project's cluster-scoped governance workflow") into a short explanatory paragraph above or below the checklist, and keep the checklist strictly as verifiable items (e.g., retain bullets "the target cluster is already associated with the current project" and "the namespace naming rule matches..." etc.); remove redundant overlap between the cluster association bullet and the UI sequencing sentence and ensure each bullet is a single, testable confirmation.
107-108: ⚡ Quick winImprove transition clarity to avoid reader confusion.
The phrase "This page mainly describes the legacy console workflow" could confuse readers about whether this page is current or outdated. Since you're adding new console guidance, consider rephrasing to acknowledge that prior sections cover the legacy workflow while this section adds the new console entry points.
📝 Suggested clearer transition
-This page mainly describes the legacy console workflow, but namespace creation in the new web console can start from different views. +The sections above describe the legacy console workflow. The new web console provides additional flexibility by supporting namespace creation from different views depending on your scope.🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@docs/en/developer/building_application/namespace/create_namespace.mdx` around lines 107 - 108, Reword the transitional sentence "This page mainly describes the legacy console workflow" to clearly separate legacy vs. new instructions and signal which sections cover each: keep a short acknowledgement that earlier sections describe the legacy console workflow and then add a clear lead-in that the following subsection documents the new web console entry points (mentioning "new web console" or "new console entry points") so readers know the page contains both legacy guidance and the newly added web console paths.
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@docs/en/developer/building_application/create_applications/yaml_app.mdx`:
- Line 56: Replace the inconsistent phrase "Application-view-specific behavior"
with the standardized wording "Applications view-specific behavior" (matching
the page's use of "Applications view") wherever it appears; specifically update
the string "Application-view-specific behavior" in the sentence that begins "If
your environment exposes YAML creation..." so it reads "review the following
Applications view-specific behavior."
- Around line 44-46: Update the "Applications view" steps to match the main
procedure by changing the action from "click Create from YAML" to the two-step
flow "click Create, then choose Create from YAML" so it aligns with lines that
describe clicking Create first; ensure the phrase "Create from YAML" and the
"Applications view" heading remain intact so reviewers can locate and verify the
change.
In `@docs/en/developer/building_application/namespace/create_namespace.mdx`:
- Around line 127-136: Under the "Create from the Clusters view" section add a
short clarifying sentence that project-level governance features (quota, limit
range, and Pod Security Admission) are not available in this workflow because it
creates the namespace directly in a cluster context outside the current
project's governance scope; note that those governance options are only exposed
when creating a namespace via the "Applications view" since that flow creates
the namespace within the current project's governance boundaries.
In
`@docs/en/developer/building_application/operation_maintaining/application_upgrade.mdx`:
- Line 14: Change the heading/text phrase "Rollout new container images with
tag/patch version control" to use the verb form "Roll out new container images
with tag/patch version control" so the sentence reads correctly; locate the
string "Rollout new container images with tag/patch version control" in
application_upgrade.mdx and replace "Rollout" with "Roll out".
---
Nitpick comments:
In `@docs/en/developer/building_application/namespace/create_namespace.mdx`:
- Around line 119-126: The checklist mixes verification steps with explanatory
UI rationale; separate or consolidate them by moving the UI flow explanation
("cluster selection happens before namespace submission because the namespace is
created as part of the current project's cluster-scoped governance workflow")
into a short explanatory paragraph above or below the checklist, and keep the
checklist strictly as verifiable items (e.g., retain bullets "the target cluster
is already associated with the current project" and "the namespace naming rule
matches..." etc.); remove redundant overlap between the cluster association
bullet and the UI sequencing sentence and ensure each bullet is a single,
testable confirmation.
- Around line 107-108: Reword the transitional sentence "This page mainly
describes the legacy console workflow" to clearly separate legacy vs. new
instructions and signal which sections cover each: keep a short acknowledgement
that earlier sections describe the legacy console workflow and then add a clear
lead-in that the following subsection documents the new web console entry points
(mentioning "new web console" or "new console entry points") so readers know the
page contains both legacy guidance and the newly added web console paths.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro
Run ID: c9978427-2890-4273-80bc-9a878b279436
📒 Files selected for processing (26)
docs/en/developer/building_application/application_observability/event.mdxdocs/en/developer/building_application/application_observability/index.mdxdocs/en/developer/building_application/application_observability/log.mdxdocs/en/developer/building_application/application_workloads/cronjob_create.mdxdocs/en/developer/building_application/application_workloads/deamonset_create.mdxdocs/en/developer/building_application/application_workloads/deployment_create.mdxdocs/en/developer/building_application/application_workloads/index.mdxdocs/en/developer/building_application/application_workloads/statefulset_create.mdxdocs/en/developer/building_application/configuration/add_configmap.mdxdocs/en/developer/building_application/configuration/add_secret.mdxdocs/en/developer/building_application/configuration/index.mdxdocs/en/developer/building_application/create_applications/chart_app.mdxdocs/en/developer/building_application/create_applications/yaml_app.mdxdocs/en/developer/building_application/index.mdxdocs/en/developer/building_application/namespace/create_namespace.mdxdocs/en/developer/building_application/namespace/import_namespace.mdxdocs/en/developer/building_application/namespace/index.mdxdocs/en/developer/building_application/namespace/manage_namespace.mdxdocs/en/developer/building_application/namespace/remove_namespace.mdxdocs/en/developer/building_application/namespace/update_member.mdxdocs/en/developer/building_application/namespace/update_overcommit.mdxdocs/en/developer/building_application/operation_maintaining/application_upgrade.mdxdocs/en/developer/building_application/operation_maintaining/index.mdxdocs/en/developer/building_application/operation_maintaining/status.mdxdocs/en/developer/index.mdxdocs/en/developer/overview.mdx
✅ Files skipped from review due to trivial changes (11)
- docs/en/developer/building_application/operation_maintaining/index.mdx
- docs/en/developer/building_application/application_observability/index.mdx
- docs/en/developer/building_application/application_observability/log.mdx
- docs/en/developer/building_application/application_observability/event.mdx
- docs/en/developer/building_application/configuration/index.mdx
- docs/en/developer/building_application/namespace/update_overcommit.mdx
- docs/en/developer/index.mdx
- docs/en/developer/building_application/namespace/index.mdx
- docs/en/developer/building_application/configuration/add_configmap.mdx
- docs/en/developer/building_application/namespace/remove_namespace.mdx
- docs/en/developer/building_application/configuration/add_secret.mdx
🚧 Files skipped from review as they are similar to previous changes (4)
- docs/en/developer/building_application/namespace/import_namespace.mdx
- docs/en/developer/building_application/operation_maintaining/status.mdx
- docs/en/developer/building_application/namespace/update_member.mdx
- docs/en/developer/building_application/namespace/manage_namespace.mdx
|
|
||
| ## Additional guidance for the Applications view | ||
|
|
||
| If your environment exposes YAML creation in the **Applications** view, use the same YAML creation path and review the following Application-view-specific behavior. |
Contributor
There was a problem hiding this comment.
Use consistent view terminology.
Line 56 uses “Application-view-specific behavior,” while the rest of the page consistently uses “Applications view.” Please standardize wording for consistency.
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In `@docs/en/developer/building_application/create_applications/yaml_app.mdx` at
line 56, Replace the inconsistent phrase "Application-view-specific behavior"
with the standardized wording "Applications view-specific behavior" (matching
the page's use of "Applications view") wherever it appears; specifically update
the string "Application-view-specific behavior" in the sentence that begins "If
your environment exposes YAML creation..." so it reads "review the following
Applications view-specific behavior."
| - **Resource Orchestration** | ||
| - Import existing Kubernetes resources (Deployments/Services/Ingresses) | ||
| - **Image Management** | ||
| - Rollout new container images with tag/patch version control |
Contributor
There was a problem hiding this comment.
Use “Roll out” (verb) instead of “Rollout” here.
Line 14 uses the noun form as a verb, which reads awkwardly in docs.
✏️ Suggested edit
- - Rollout new container images with tag/patch version control
+ - Roll out new container images with tag/patch version control📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
Suggested change
| - Rollout new container images with tag/patch version control | |
| - Roll out new container images with tag/patch version control |
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In
`@docs/en/developer/building_application/operation_maintaining/application_upgrade.mdx`
at line 14, Change the heading/text phrase "Rollout new container images with
tag/patch version control" to use the verb form "Roll out new container images
with tag/patch version control" so the sentence reads correctly; locate the
string "Rollout new container images with tag/patch version control" in
application_upgrade.mdx and replace "Rollout" with "Roll out".
1baf3ee to
545c387
Compare
yinshuxun
force-pushed
the
docs/cp-nwc-doc-completion
branch
from
545c387 to
6029f43
Compare
Contributor
There was a problem hiding this comment.
Actionable comments posted: 1
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (1)
docs/en/developer/building_application/create_applications/yaml_app.mdx (1)
30-30:⚠️ Potential issue | 🟡 Minor | ⚡ Quick winComplete the sentence.
Line 30 is missing a verb. It should read "Log in to Container Platform, and navigate to..." or "Open Container Platform, and navigate to..." to form a complete instruction.
✏️ Suggested fix
-1. **Container Platform**, and navigate to **Application** > **Applications**. +1. Log in to **Container Platform**, and navigate to **Application** > **Applications**.🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@docs/en/developer/building_application/create_applications/yaml_app.mdx` at line 30, Complete the sentence by adding a verb before "Container Platform" in the fragment "Container Platform, and navigate to Application > Applications" — for example change it to "Log in to Container Platform, and navigate to Application > Applications" (or "Open Container Platform...") so the instruction is a full imperative sentence; update the sentence in the document where that fragment appears.
♻️ Duplicate comments (5)
docs/en/developer/building_application/operation_maintaining/application_upgrade.mdx (1)
14-14:⚠️ Potential issue | 🟡 MinorGrammar issue already flagged: Use "Roll out" instead of "Rollout".
This issue was previously identified. "Rollout" is a noun; the verb form "Roll out" is needed here.
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@docs/en/developer/building_application/operation_maintaining/application_upgrade.mdx` at line 14, Change the heading text that currently reads "Rollout new container images with tag/patch version control" to use the correct verb form "Roll out" (i.e., "Roll out new container images with tag/patch version control") so the sentence uses the verb rather than the noun; update the string in the document section containing that phrase in application_upgrade.mdx.docs/en/developer/building_application/create_applications/yaml_app.mdx (3)
56-56:⚠️ Potential issue | 🟡 Minor | ⚡ Quick winUse consistent view terminology.
Line 56 uses "Application-view-specific behavior" (singular, hyphenated), while the rest of the document consistently uses "Applications view" (plural, no hyphen). Please standardize the wording.
📝 Suggested fix
-If your environment exposes YAML creation in the **Applications** view, use the same YAML creation path and review the following Application-view-specific behavior. +If your environment exposes YAML creation in the **Applications** view, use the same YAML creation path and review the following Applications view-specific behavior.🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@docs/en/developer/building_application/create_applications/yaml_app.mdx` at line 56, Replace the phrase "Application-view-specific behavior" with the document's canonical phrasing using "Applications view" (plural, no hyphen), e.g. change "Application-view-specific behavior" to "Applications view specific behavior" so the wording matches the rest of the doc; search for the string "Application-view-specific behavior" and update it to use "Applications view" consistent with other occurrences of "Applications view".
44-44:⚠️ Potential issue | 🟡 Minor | ⚡ Quick winAlign navigation steps with the main procedure.
Line 44 says "click Create from YAML" directly, but the main procedure (lines 32-34) describes clicking Create first, then selecting Create from YAML. This inconsistency may confuse users about the actual navigation path.
🔧 Suggested fix to align with main procedure
-- **Applications view**: Start from the current project. Open **Applications** > **Applications**, click **Create from YAML**, select the target **Cluster** first, review or confirm the target **Namespace** from the YAML content, and then submit the resources. +- **Applications view**: Start from the current project. Open **Applications** > **Applications**, click **Create**, select **Create from YAML**, choose the target **Cluster**, review or confirm the target **Namespace** from the YAML content, and then submit the resources.🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@docs/en/developer/building_application/create_applications/yaml_app.mdx` at line 44, The navigation steps in the Applications view are inconsistent with the main procedure because they skip the intermediate Create action. Update the wording in the YAML application instructions to match the existing flow described elsewhere in the document: in the Applications view, the user should open Applications > Applications, click Create, then choose Create from YAML, before selecting the target Cluster and confirming the Namespace. Use the existing application setup steps as the source of truth and keep the phrasing aligned across the doc.
58-60:⚠️ Potential issue | 🟡 Minor | ⚡ Quick winAlign step 2 with the main procedure navigation.
Line 59 says "Click Create from YAML" directly, but the main procedure (lines 32-34) shows a two-step flow: click Create, then select Create from YAML. For consistency across the document, update this step to match the canonical flow.
🔧 Suggested fix
1. Open the application page in the **Applications** view. -2. Click **Create from YAML**. -3. Select the target **Cluster**. +2. Click **Create**. +3. Select **Create from YAML**. +4. Select the target **Cluster**.(Renumber subsequent steps accordingly: lines 61-64 become steps 5-8)
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@docs/en/developer/building_application/create_applications/yaml_app.mdx` around lines 58 - 60, Update step 2 to follow the canonical two-step flow: change "Click Create from YAML" to "Click Create, then select Create from YAML" so it matches the main procedure; ensure subsequent step numbering is shifted accordingly (so the current steps after 2 are renumbered to continue the sequence). Use the UI labels "Create" and "Create from YAML" to locate the text to edit.docs/en/developer/building_application/application_workloads/statefulset_create.mdx (1)
177-177:⚠️ Potential issue | 🟡 Minor | ⚡ Quick winFix heading typo: "Heath" → "Health".
The heading contains a spelling error.
✏️ Proposed fix
-## Heath Checks +## Health Checks🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@docs/en/developer/building_application/application_workloads/statefulset_create.mdx` at line 177, The heading "## Heath Checks" has a typo; update the markdown heading to "## Health Checks" by replacing the "Heath" string in the heading (look for the heading line containing "## Heath Checks") so the correct spelling "Health" is used.
🧹 Nitpick comments (2)
docs/en/developer/building_application/create_applications/yaml_app.mdx (2)
17-22: ⚡ Quick winAdd context to the YAML snippet.
The snippet shows nested
specfields without indicating the parent resource type. Users may be unclear where to place this configuration. Consider adding a comment or wrapping this in a minimal resource definition (e.g.,Deployment,StatefulSet, orDaemonSet) to show the full context.📝 Example with context
+# Example: Deployment with node selector ```yaml +apiVersion: apps/v1 +kind: Deployment +metadata: + name: example-workload spec: + replicas: 2 + selector: + matchLabels: + app: example + template: + metadata: + labels: + app: example spec: nodeSelector: kubernetes.io/os: linux + containers: + - name: app + image: nginx:alpine🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@docs/en/developer/building_application/create_applications/yaml_app.mdx` around lines 17 - 22, The YAML snippet shows a nested spec.nodeSelector but lacks the parent resource/context; update the snippet to either add an inline comment stating which resource it belongs to or wrap it in a minimal Kubernetes resource (e.g., apiVersion: apps/v1, kind: Deployment) so the nested spec is clearly under template.spec; include the selector/template.metadata.labels and a minimal containers list so readers can see where spec.nodeSelector sits (referencing the spec -> template -> spec nesting and nodeSelector fields in the example).
38-38: ⚡ Quick winGeneralize the resource type reference.
The instruction says "View the corresponding Deployment" but users creating YAML may define StatefulSets, Services, ConfigMaps, or other resources. Consider using generic wording like "View the created resource(s)" or "View the corresponding workload or resource."
📝 Suggested alternatives
-5. View the corresponding **Deployment** on the details page. +5. View the created resource(s) on the details page.Or if you want to be more specific:
-5. View the corresponding **Deployment** on the details page. +5. View the corresponding workload (e.g., **Deployment**, **StatefulSet**) or resource on the details page.🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@docs/en/developer/building_application/create_applications/yaml_app.mdx` at line 38, Replace the specific phrase "View the corresponding **Deployment**" in the step text with a generalized wording that covers other manifest types (e.g., "View the created resource(s)" or "View the corresponding workload or resource") so the instruction applies to Deployments, StatefulSets, Services, ConfigMaps, etc.; update the sentence containing "View the corresponding **Deployment**" in yaml_app.mdx to one of the suggested generic alternatives.
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@docs/en/developer/building_application/application_workloads/index.mdx`:
- Line 25: The link text in index.mdx references a misspelled target file
"./deamonset_create.mdx" — update the link to "./daemonset_create.mdx" in
docs/en/developer/building_application/application_workloads/index.mdx and also
rename the actual file
docs/en/developer/building_application/application_workloads/deamonset_create.mdx
to
docs/en/developer/building_application/application_workloads/daemonset_create.mdx
so the link resolves correctly.
---
Outside diff comments:
In `@docs/en/developer/building_application/create_applications/yaml_app.mdx`:
- Line 30: Complete the sentence by adding a verb before "Container Platform" in
the fragment "Container Platform, and navigate to Application > Applications" —
for example change it to "Log in to Container Platform, and navigate to
Application > Applications" (or "Open Container Platform...") so the instruction
is a full imperative sentence; update the sentence in the document where that
fragment appears.
---
Duplicate comments:
In
`@docs/en/developer/building_application/application_workloads/statefulset_create.mdx`:
- Line 177: The heading "## Heath Checks" has a typo; update the markdown
heading to "## Health Checks" by replacing the "Heath" string in the heading
(look for the heading line containing "## Heath Checks") so the correct spelling
"Health" is used.
In `@docs/en/developer/building_application/create_applications/yaml_app.mdx`:
- Line 56: Replace the phrase "Application-view-specific behavior" with the
document's canonical phrasing using "Applications view" (plural, no hyphen),
e.g. change "Application-view-specific behavior" to "Applications view specific
behavior" so the wording matches the rest of the doc; search for the string
"Application-view-specific behavior" and update it to use "Applications view"
consistent with other occurrences of "Applications view".
- Line 44: The navigation steps in the Applications view are inconsistent with
the main procedure because they skip the intermediate Create action. Update the
wording in the YAML application instructions to match the existing flow
described elsewhere in the document: in the Applications view, the user should
open Applications > Applications, click Create, then choose Create from YAML,
before selecting the target Cluster and confirming the Namespace. Use the
existing application setup steps as the source of truth and keep the phrasing
aligned across the doc.
- Around line 58-60: Update step 2 to follow the canonical two-step flow: change
"Click Create from YAML" to "Click Create, then select Create from YAML" so it
matches the main procedure; ensure subsequent step numbering is shifted
accordingly (so the current steps after 2 are renumbered to continue the
sequence). Use the UI labels "Create" and "Create from YAML" to locate the text
to edit.
In
`@docs/en/developer/building_application/operation_maintaining/application_upgrade.mdx`:
- Line 14: Change the heading text that currently reads "Rollout new container
images with tag/patch version control" to use the correct verb form "Roll out"
(i.e., "Roll out new container images with tag/patch version control") so the
sentence uses the verb rather than the noun; update the string in the document
section containing that phrase in application_upgrade.mdx.
---
Nitpick comments:
In `@docs/en/developer/building_application/create_applications/yaml_app.mdx`:
- Around line 17-22: The YAML snippet shows a nested spec.nodeSelector but lacks
the parent resource/context; update the snippet to either add an inline comment
stating which resource it belongs to or wrap it in a minimal Kubernetes resource
(e.g., apiVersion: apps/v1, kind: Deployment) so the nested spec is clearly
under template.spec; include the selector/template.metadata.labels and a minimal
containers list so readers can see where spec.nodeSelector sits (referencing the
spec -> template -> spec nesting and nodeSelector fields in the example).
- Line 38: Replace the specific phrase "View the corresponding **Deployment**"
in the step text with a generalized wording that covers other manifest types
(e.g., "View the created resource(s)" or "View the corresponding workload or
resource") so the instruction applies to Deployments, StatefulSets, Services,
ConfigMaps, etc.; update the sentence containing "View the corresponding
**Deployment**" in yaml_app.mdx to one of the suggested generic alternatives.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro
Run ID: 4ad52e37-386f-41b7-9a13-8993e25b4526
📒 Files selected for processing (23)
docs/en/developer/building_application/application_workloads/cronjob_create.mdxdocs/en/developer/building_application/application_workloads/deamonset_create.mdxdocs/en/developer/building_application/application_workloads/deployment_create.mdxdocs/en/developer/building_application/application_workloads/index.mdxdocs/en/developer/building_application/application_workloads/statefulset_create.mdxdocs/en/developer/building_application/configuration/add_configmap.mdxdocs/en/developer/building_application/configuration/add_secret.mdxdocs/en/developer/building_application/configuration/index.mdxdocs/en/developer/building_application/create_applications/chart_app.mdxdocs/en/developer/building_application/create_applications/yaml_app.mdxdocs/en/developer/building_application/index.mdxdocs/en/developer/building_application/namespace/create_namespace.mdxdocs/en/developer/building_application/namespace/import_namespace.mdxdocs/en/developer/building_application/namespace/index.mdxdocs/en/developer/building_application/namespace/manage_namespace.mdxdocs/en/developer/building_application/namespace/remove_namespace.mdxdocs/en/developer/building_application/namespace/update_member.mdxdocs/en/developer/building_application/namespace/update_overcommit.mdxdocs/en/developer/building_application/operation_maintaining/application_upgrade.mdxdocs/en/developer/building_application/operation_maintaining/index.mdxdocs/en/developer/building_application/operation_maintaining/status.mdxdocs/en/developer/index.mdxdocs/en/developer/overview.mdx
✅ Files skipped from review due to trivial changes (11)
- docs/en/developer/building_application/namespace/import_namespace.mdx
- docs/en/developer/building_application/create_applications/chart_app.mdx
- docs/en/developer/building_application/namespace/create_namespace.mdx
- docs/en/developer/building_application/namespace/index.mdx
- docs/en/developer/building_application/operation_maintaining/status.mdx
- docs/en/developer/building_application/configuration/add_configmap.mdx
- docs/en/developer/index.mdx
- docs/en/developer/building_application/operation_maintaining/index.mdx
- docs/en/developer/building_application/namespace/update_overcommit.mdx
- docs/en/developer/building_application/namespace/remove_namespace.mdx
- docs/en/developer/building_application/namespace/manage_namespace.mdx
🚧 Files skipped from review as they are similar to previous changes (5)
- docs/en/developer/building_application/namespace/update_member.mdx
- docs/en/developer/building_application/configuration/index.mdx
- docs/en/developer/building_application/configuration/add_secret.mdx
- docs/en/developer/overview.mdx
- docs/en/developer/building_application/application_workloads/cronjob_create.mdx
|
|
||
| - [Deployments](./deployment_create.mdx) | ||
| - [StatefulSets](./statefulset_create.mdx) | ||
| - [DaemonSets](./deamonset_create.mdx) |
Contributor
There was a problem hiding this comment.
Fix filename typo: "deamonset" → "daemonset".
The link points to ./deamonset_create.mdx, but the correct spelling is "daemonset" (daemon + set). The target filename should be daemonset_create.mdx.
📝 Proposed fix
-- [DaemonSets](./deamonset_create.mdx)
+- [DaemonSets](./daemonset_create.mdx)Additionally, rename the actual file from docs/en/developer/building_application/application_workloads/deamonset_create.mdx to docs/en/developer/building_application/application_workloads/daemonset_create.mdx.
📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
Suggested change
| - [DaemonSets](./deamonset_create.mdx) | |
| - [DaemonSets](./daemonset_create.mdx) |
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In `@docs/en/developer/building_application/application_workloads/index.mdx` at
line 25, The link text in index.mdx references a misspelled target file
"./deamonset_create.mdx" — update the link to "./daemonset_create.mdx" in
docs/en/developer/building_application/application_workloads/index.mdx and also
rename the actual file
docs/en/developer/building_application/application_workloads/deamonset_create.mdx
to
docs/en/developer/building_application/application_workloads/daemonset_create.mdx
so the link resolves correctly.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary by CodeRabbit
Release Notes