fix upgrade version and prepare by fyuan1316 · Pull Request #80 · alauda/aml-docs

fyuan1316 · 2026-01-15T10:21:10Z

Summary by CodeRabbit

Documentation
- Removed the legacy upgrade guide covering the transition from the older 1.3 line, including prior upgrade steps and verification instructions.
- Added a new, user-facing upgrade guide for moving from 1.4 to 1.5 with clear step-by-step procedures, installation notes, operator upgrade flow, and post-upgrade verification steps.

_{✏️ Tip: You can customize this high-level summary in your review settings.}

coderabbitai · 2026-01-15T10:21:24Z

Walkthrough

Removed 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

Cohort / File(s)	Summary
Removed legacy upgrade guide `docs/en/upgrade/upgrade-from-ai-1.3.mdx`	Deleted full 1.3→1.4 upgrade documentation (incl. Helm/patch scripts, operator upgrade steps, and verification commands).
Added new upgrade guide `docs/en/upgrade/upgrade-from-previous-version.mdx`	Added 1.4→1.5 upgrade doc (+87 lines) with `prevVersion="1.4"` and `curVer="1.5"`, operator bundle download/upload flow, stepwise upgrade instructions for Essentials and operators, and kubectl-based verification steps.

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

fix/AI-22813 master #45: Modifies the same upgrade-from-ai-1.3.mdx file whose content is deleted in this PR.
AI-None improve 1.4 install #26: Previously edited/enriched upgrade-from-ai-1.3.mdx, directly overlapping with the removed content.
AI-22446 Make knative optional #22: Restructures installation/upgrade docs and touches operator packaging/upgrading content relevant to the new guide.

Suggested reviewers

zhaomingkun1030
typhoonzero

Poem

🐰 The docs have moved, old paths now past,
From 1.3's guide, to 1.5 at last!
New bundles hop in tidy rows,
Operators wake as progress grows,
A rabbit cheers — the upgrade's fast! 🎉

🚥 Pre-merge checks | ✅ 2 | ❌ 1

❌ Failed checks (1 inconclusive)

Check name	Status	Explanation	Resolution
Title check	❓ Inconclusive	The title 'fix upgrade version and prepare' is vague and generic, failing to clearly convey the specific changes made (deletion of 1.3 upgrade guide and addition of 1.4-1.5 upgrade documentation).	Use a more descriptive title such as 'Replace 1.3 upgrade guide with 1.4 to 1.5 upgrade documentation' to clearly communicate the primary changes.

✅ Passed checks (2 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

_{✏️ 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.

❤️ Share

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

coderabbitai

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

📥 Commits

Reviewing files that changed from the base of the PR and between 614b584 and 2899676.

📒 Files selected for processing (2)

docs/en/upgrade/upgrade-from-ai-1.3.mdx
docs/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.}

docs/en/upgrade/upgrade-from-previous-version.mdx

cloudflare-workers-and-pages · 2026-01-15T10:25:21Z

Deploying alauda-ai with Cloudflare Pages

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

View logs

liuwei-2622 · 2026-01-28T02:33:34Z

/test-pass

fix upgrade version and prepare

2899676

coderabbitai bot reviewed Jan 15, 2026

View reviewed changes

Fix version

11f9099

fyuan1316 merged commit 54e080d into master Jan 28, 2026
3 checks passed

This was referenced Feb 2, 2026

Rls 1.5/fix upgrade version #92

Merged

chore: add upgrade workbench AI-23623 #94

Merged

This was referenced Feb 26, 2026

Upgrade ai 1.5 to 2.0 #115

Merged

chore: remove finetuning #118

Merged

coderabbitai bot mentioned this pull request Apr 10, 2026

add troubleshooting for upgrading #181

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

fix upgrade version and prepare#80

fix upgrade version and prepare#80
fyuan1316 merged 2 commits intomasterfrom
change-1.4-upgrade

fyuan1316 commented Jan 15, 2026 •

edited by coderabbitai bot

Loading

Uh oh!

coderabbitai bot commented Jan 15, 2026 •

edited

Loading

Uh oh!

coderabbitai bot left a comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

cloudflare-workers-and-pages bot commented Jan 15, 2026 •

edited

Loading

Uh oh!

liuwei-2622 commented Jan 28, 2026

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Conversation

fyuan1316 commented Jan 15, 2026 • edited by coderabbitai bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary by CodeRabbit

Uh oh!

coderabbitai bot commented Jan 15, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Walkthrough

Changes

Sequence Diagram(s)

Estimated code review effort

Possibly related PRs

Suggested reviewers

Poem

Uh oh!

coderabbitai bot left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

cloudflare-workers-and-pages bot commented Jan 15, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Deploying alauda-ai with Cloudflare Pages

Uh oh!

liuwei-2622 commented Jan 28, 2026

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

fyuan1316 commented Jan 15, 2026 •

edited by coderabbitai bot

Loading

coderabbitai bot commented Jan 15, 2026 •

edited

Loading

cloudflare-workers-and-pages bot commented Jan 15, 2026 •

edited

Loading