fix upgrade version and prepare #80
Conversation
WalkthroughRemoved the legacy 1.3→1.4 upgrade guide and added a new 1.4→1.5 upgrade guide, replacing previous upgrade instructions with updated operator bundle workflow, upgrade steps, and verification commands. Changes
Sequence Diagram(s)(omitted — changes are documentation-only and do not introduce new multi-component control flow) Estimated code review effort🎯 1 (Trivial) | ⏱️ ~2 minutes Possibly related PRs
Suggested reviewers
Poem
🚥 Pre-merge checks | ✅ 2 | ❌ 1❌ Failed checks (1 inconclusive)
✅ Passed checks (2 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. 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}
There was a problem hiding this comment.
Actionable comments posted: 4
🤖 Fix all issues with AI agents
In `@docs/en/upgrade/upgrade-from-previous-version.mdx`:
- Line 62: Fix the grammar in the resource descriptions by replacing "which
named `default`" with either "named `default`" or "which is named `default`" in
the sentence "Check the status field from the `AmlCluster` resource which named
`default`:" and the other occurrence on line 75; update the text to "Check the
status field from the `AmlCluster` resource named `default`:" (or "which is
named `default`") to correct the phrasing.
- Line 68: Change the verification sentence "Should returns `Ready`:" to correct
grammar by removing the extraneous 's' so it reads "Should return `Ready`:" in
the docs content where that exact phrase appears.
- Around line 81-86: Update the documentation text that currently says "Should
returns `InstallSuccessful`" to "Should returns `UpgradeSuccessful`" so it
matches the example output showing `UpgradeSuccessful`; ensure the sentence and
any related occurrences in this section (the line with that phrase and the
example block showing the NAME/DEPLOYED/REASON output) consistently use
`UpgradeSuccessful`.
- Line 42: Update the post-upgrade verification sentence to reference the
correct target version: replace the version token "**v1.4.x**" with "**v1.5.x**"
in the sentence that checks the status of "Alauda AI Essentials" so it reads
that the version is v1.5.x and the status is Running.
🧹 Nitpick comments (1)
docs/en/upgrade/upgrade-from-previous-version.mdx (1)
26-27: Consider removing one empty line.Two consecutive empty lines are present here. One empty line is typically sufficient for section separation.
📜 Review details
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (2)
docs/en/upgrade/upgrade-from-ai-1.3.mdxdocs/en/upgrade/upgrade-from-previous-version.mdx
💤 Files with no reviewable changes (1)
- docs/en/upgrade/upgrade-from-ai-1.3.mdx
🧰 Additional context used
🧠 Learnings (1)
📚 Learning: 2025-12-31T02:30:16.360Z
Learnt from: EdisonSu768
Repo: alauda/aml-docs PR: 73
File: docs/en/monitoring_ops/resource_monitoring/how_to/add_monitor_dashboard.mdx:28-45
Timestamp: 2025-12-31T02:30:16.360Z
Learning: In MDX documentation files (e.g., docs/.../*.mdx), when including PromQL code blocks, use bash as the syntax highlighter fallback because the rspress system does not support PromQL highlighting. Ensure the code blocks specify the language as bash (e.g., ```bash) where PromQL would appear, to maintain readability and avoid broken highlighting.
Applied to files:
docs/en/upgrade/upgrade-from-previous-version.mdx
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)
- GitHub Check: Pipelines as Code CI / doc-pr-build-ai
🔇 Additional comments (4)
docs/en/upgrade/upgrade-from-previous-version.mdx (4)
1-7: LGTM!The front matter and version constants are correctly configured for the 1.4 to 1.5 upgrade path.
8-12: LGTM!The title and info box correctly reference the version constants.
14-24: LGTM!The installation section appropriately references external documentation and includes a clear warning for users performing upgrades.
44-57: LGTM!The operator upgrade section uses a clear table format to show parallel steps for both operators.
✏️ Tip: You can disable this entire section by setting review_details to false in your review settings.
| All components that require upgrading, including **Alauda AI Essentials**, will be upgraded together and cannot be upgraded individually. | ||
| ::: | ||
|
|
||
| After the upgrade is complete, please confirm that the status of **Alauda AI Essentials** in the list is **Running** and the version is **v1.4.x**. |
There was a problem hiding this comment.
Incorrect version in post-upgrade verification.
After upgrading from version 1.4 to 1.5, the verification should confirm the version is v1.5.x, not v1.4.x. This is a critical error in the upgrade documentation that will confuse users during verification.
📝 Proposed fix
-After the upgrade is complete, please confirm that the status of **Alauda AI Essentials** in the list is **Running** and the version is **v1.4.x**.
+After the upgrade is complete, please confirm that the status of **Alauda AI Essentials** in the list is **Running** and the version is **v1.5.x**.📝 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.
| After the upgrade is complete, please confirm that the status of **Alauda AI Essentials** in the list is **Running** and the version is **v1.4.x**. | |
| After the upgrade is complete, please confirm that the status of **Alauda AI Essentials** in the list is **Running** and the version is **v1.5.x**. |
🤖 Prompt for AI Agents
In `@docs/en/upgrade/upgrade-from-previous-version.mdx` at line 42, Update the
post-upgrade verification sentence to reference the correct target version:
replace the version token "**v1.4.x**" with "**v1.5.x**" in the sentence that
checks the status of "Alauda AI Essentials" so it reads that the version is
v1.5.x and the status is Running.
|
|
||
| <Steps> | ||
| ### Alauda AI | ||
| Check the status field from the `AmlCluster` resource which named `default`: |
There was a problem hiding this comment.
Fix grammar in resource descriptions.
The phrasing "which named" is grammatically incorrect. Use "named" or "which is named" instead.
📝 Proposed fix
-Check the status field from the `AmlCluster` resource which named `default`:
+Check the status field from the `AmlCluster` resource named `default`:And for line 75:
-Check the status field from the `KnativeServing` resource which named `default-knative-serving`:
+Check the status field from the `KnativeServing` resource named `default-knative-serving`:Also applies to: 75-75
🤖 Prompt for AI Agents
In `@docs/en/upgrade/upgrade-from-previous-version.mdx` at line 62, Fix the
grammar in the resource descriptions by replacing "which named `default`" with
either "named `default`" or "which is named `default`" in the sentence "Check
the status field from the `AmlCluster` resource which named `default`:" and the
other occurrence on line 75; update the text to "Check the status field from the
`AmlCluster` resource named `default`:" (or "which is named `default`") to
correct the phrasing.
| kubectl get amlcluster default | ||
| ``` | ||
|
|
||
| Should returns `Ready`: |
There was a problem hiding this comment.
Fix grammar in verification instruction.
"Should returns" should be "Should return" (without the 's').
📝 Proposed fix
-Should returns `Ready`:
+Should return `Ready`:📝 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.
| Should returns `Ready`: | |
| Should return `Ready`: |
🤖 Prompt for AI Agents
In `@docs/en/upgrade/upgrade-from-previous-version.mdx` at line 68, Change the
verification sentence "Should returns `Ready`:" to correct grammar by removing
the extraneous 's' so it reads "Should return `Ready`:" in the docs content
where that exact phrase appears.
| Should returns `InstallSuccessful`: | ||
|
|
||
| ``` | ||
| NAME DEPLOYED REASON | ||
| default-knative-serving True UpgradeSuccessful | ||
| ``` |
There was a problem hiding this comment.
Inconsistent expected output value.
The documentation states the command "Should returns InstallSuccessful" (line 81), but the example output shows UpgradeSuccessful (line 85). Since this is an upgrade operation, UpgradeSuccessful appears to be the correct value. The documentation should be updated to match the actual expected output.
📝 Proposed fix
-Should returns `InstallSuccessful`:
+Should return `UpgradeSuccessful`:🤖 Prompt for AI Agents
In `@docs/en/upgrade/upgrade-from-previous-version.mdx` around lines 81 - 86,
Update the documentation text that currently says "Should returns
`InstallSuccessful`" to "Should returns `UpgradeSuccessful`" so it matches the
example output showing `UpgradeSuccessful`; ensure the sentence and any related
occurrences in this section (the line with that phrase and the example block
showing the NAME/DEPLOYED/REASON output) consistently use `UpgradeSuccessful`.
Deploying alauda-ai with
|
| Latest commit: |
11f9099
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://4644ed5d.alauda-ai.pages.dev |
| Branch Preview URL: | https://change-1-4-upgrade.alauda-ai.pages.dev |
Summary by CodeRabbit
✏️ Tip: You can customize this high-level summary in your review settings.