chore: add upgrade workbench AI-23623 by EdisonSu768 · Pull Request #94 · alauda/aml-docs

EdisonSu768 · 2026-02-05T07:07:26Z

Summary by CodeRabbit

Documentation
- Expanded upgrade guide with new sections covering cluster plugin upgrades and enabling fine-tuning/training features.
- Added detailed step-by-step workflows and verification checks for Alauda AI components.
- Improved organization and formatting for enhanced readability.

coderabbitai · 2026-02-05T07:07:43Z

Walkthrough

This PR updates documentation for the Alauda AI upgrade process. It converts quote styles in version constants from double to single quotes and substantially expands the upgrade guide with new sections covering cluster plugins, fine-tuning features, and verification steps.

Changes

Cohort / File(s)	Summary
Documentation Update `docs/en/upgrade/upgrade-from-previous-version.mdx`	Expanded upgrade guide with new sections for upgrading cluster plugins, enabling fine-tuning/training features, and verification procedures. Updated exported version constants (`prevVersion`, `curVer`) from double-quoted to single-quoted strings. Added informational callouts, YAML examples, and CLI verification steps.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~12 minutes

Possibly related PRs

fix upgrade version and prepare #80 — Directly modifies the same upgrade documentation file and version constants (prevVersion and curVer).

Suggested reviewers

zhaomingkun1030
typhoonzero

Poem

🐰 A rabbit's tale of upgrade guides so bright,
New sections bloom like clover in the light,
With quotes now single, and features newly told,
Our documentation grows, more helpful and bold! ✨

🚥 Pre-merge checks | ✅ 2 | ❌ 1

❌ Failed checks (1 inconclusive)

Check name	Status	Explanation	Resolution
Title check	❓ Inconclusive	The title references 'add upgrade workbench' but the changes are substantial documentation updates to an upgrade guide with new sections on cluster plugins and fine-tuning features, not primarily about adding a workbench component.	Clarify whether the title should reflect the main documentation updates (e.g., 'docs: expand upgrade guide with cluster plugins and fine-tuning steps') or if 'add upgrade workbench' accurately describes the primary objective.

✅ 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.}

✨ Finishing touches

🧪 Generate unit tests (beta)

Create PR with unit tests
Post copyable unit tests in a comment
Commit unit tests in branch feat/update-workbench

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: 3

🤖 Fix all issues with AI agents

In `@docs/en/upgrade/upgrade-from-previous-version.mdx`:
- Around line 133-138: The closing admonition marker for the MDX note block (the
`:::` that follows the list mentioning Volcano and MLflow) is indented and may
not close the block correctly; remove any leading spaces so the closing `:::`
starts at the beginning of the line (no indentation) to properly terminate the
`:::note` block.
- Around line 127-131: The text inside the Callouts component has awkward
mid-sentence breaks; update the content of the <Callouts> block so each numbered
item is a single continuous line or use a proper ordered list (e.g., "1. When
set to `true`, the **Training** item appears in the left navigation menu." on
its own line and "2. When set to `true`, the **Fine-Tuning** item appears in the
left navigation menu." on the next line) to remove the "menu. 2." break and
improve readability.
- Around line 96-98: The documentation currently uses two different tab names
("Functional Components" and "Features") — check the actual UI to confirm the
correct tab label and make them consistent; update the text in
upgrade-from-previous-version.mdx to use the verified tab name in both places
(replace the "Functional Components" mention or the "Features" mention
accordingly) and ensure any surrounding context (e.g., "cluster details page" or
"Features tab of the cluster details page") matches the UI wording exactly.

coderabbitai · 2026-02-05T07:10:20Z

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

+:::info
+Once the new version is uploaded and recognized by the platform, the **Upgrade** button will become available for each plugin on the **Features** tab of the cluster details page.
+:::


⚠️ Potential issue | 🟡 Minor

Potential inconsistency in tab name reference.

Line 89 refers to the "Functional Components tab" but line 97 mentions the "Features tab". Please verify these are the correct tab names or if they should be consistent.

Suggested fix if they should be the same

:::info -Once the new version is uploaded and recognized by the platform, the **Upgrade** button will become available for each plugin on the **Features** tab of the cluster details page. +Once the new version is uploaded and recognized by the platform, the **Upgrade** button will become available for each plugin on the **Functional Components** tab of the cluster details page. :::

📝 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

:::info

Once the new version is uploaded and recognized by the platform, the **Upgrade** button will become available for each plugin on the **Features** tab of the cluster details page.

:::

:::info

Once the new version is uploaded and recognized by the platform, the **Upgrade** button will become available for each plugin on the **Functional Components** tab of the cluster details page.

:::

🤖 Prompt for AI Agents

In `@docs/en/upgrade/upgrade-from-previous-version.mdx` around lines 96 - 98, The documentation currently uses two different tab names ("Functional Components" and "Features") — check the actual UI to confirm the correct tab label and make them consistent; update the text in upgrade-from-previous-version.mdx to use the verified tab name in both places (replace the "Functional Components" mention or the "Features" mention accordingly) and ensure any surrounding context (e.g., "cluster details page" or "Features tab of the cluster details page") matches the UI wording exactly.

coderabbitai · 2026-02-05T07:10:20Z

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

+<Callouts>
+  1. When set to `true`, the **Training** item appears in the left navigation
+  menu. 2. When set to `true`, the **Fine-Tuning** item appears in the left
+  navigation menu.
+</Callouts>


⚠️ Potential issue | 🟡 Minor

Awkward line breaks in Callouts content.

The numbered items inside the <Callouts> component have line breaks in the middle of sentences, making them hard to read. The text "menu. 2." on line 129 shows where item 1 ends and item 2 begins mid-line.

Suggested formatting fix

<Callouts> - 1. When set to `true`, the **Training** item appears in the left navigation - menu. 2. When set to `true`, the **Fine-Tuning** item appears in the left - navigation menu. + 1. When set to `true`, the **Training** item appears in the left navigation menu. + 2. When set to `true`, the **Fine-Tuning** item appears in the left navigation menu. </Callouts>

📝 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

<Callouts>

1. When set to `true`, the **Training** item appears in the left navigation

menu. 2. When set to `true`, the **Fine-Tuning** item appears in the left

navigation menu.

</Callouts>

<Callouts>

1. When set to `true`, the **Training** item appears in the left navigation menu.

2. When set to `true`, the **Fine-Tuning** item appears in the left navigation menu.

</Callouts>

🤖 Prompt for AI Agents

In `@docs/en/upgrade/upgrade-from-previous-version.mdx` around lines 127 - 131, The text inside the Callouts component has awkward mid-sentence breaks; update the content of the <Callouts> block so each numbered item is a single continuous line or use a proper ordered list (e.g., "1. When set to `true`, the **Training** item appears in the left navigation menu." on its own line and "2. When set to `true`, the **Fine-Tuning** item appears in the left navigation menu." on the next line) to remove the "menu. 2." break and improve readability.

coderabbitai · 2026-02-05T07:10:20Z

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

+:::note
+After enabling these features, ensure that the required cluster plugins are installed:
+
+- **Volcano** cluster plugin for training job scheduling
+- **MLflow** cluster plugin for training experiment monitoring (requires PostgreSQL)
+  :::


⚠️ Potential issue | 🟡 Minor

Note block closing marker may be incorrectly indented.

The ::: closing marker on line 138 appears to be indented (preceded by spaces). In MDX, the closing fence should typically start at the beginning of the line to properly close the admonition block. This could cause rendering issues.

Suggested fix

:::note After enabling these features, ensure that the required cluster plugins are installed: - **Volcano** cluster plugin for training job scheduling - **MLflow** cluster plugin for training experiment monitoring (requires PostgreSQL) - ::: +:::

📝 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

:::note

After enabling these features, ensure that the required cluster plugins are installed:

- **Volcano** cluster plugin for training job scheduling

- **MLflow** cluster plugin for training experiment monitoring (requires PostgreSQL)

:::

:::note

After enabling these features, ensure that the required cluster plugins are installed:

- **Volcano** cluster plugin for training job scheduling

- **MLflow** cluster plugin for training experiment monitoring (requires PostgreSQL)

:::

🤖 Prompt for AI Agents

In `@docs/en/upgrade/upgrade-from-previous-version.mdx` around lines 133 - 138, The closing admonition marker for the MDX note block (the `:::` that follows the list mentioning Volcano and MLflow) is indented and may not close the block correctly; remove any leading spaces so the closing `:::` starts at the beginning of the line (no indentation) to properly terminate the `:::note` block.

cloudflare-workers-and-pages · 2026-02-05T07:12:22Z

Deploying alauda-ai with Cloudflare Pages

Latest commit:	`cb2f710`
Status:	✅ Deploy successful!
Preview URL:	https://7633a55e.alauda-ai.pages.dev
Branch Preview URL:	https://feat-update-workbench.alauda-ai.pages.dev

View logs

chore: add upgrade workbench AI-23623

cb2f710

coderabbitai bot reviewed Feb 5, 2026

View reviewed changes

EdisonSu768 merged commit f70fa52 into master Feb 9, 2026
3 checks passed

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

chore: add upgrade workbench AI-23623#94

chore: add upgrade workbench AI-23623#94
EdisonSu768 merged 1 commit intomasterfrom
feat/update-workbench

EdisonSu768 commented Feb 5, 2026 •

edited by coderabbitai bot

Loading

Uh oh!

coderabbitai bot commented Feb 5, 2026 •

edited

Loading

Uh oh!

coderabbitai bot left a comment

Uh oh!

coderabbitai bot Feb 5, 2026

Uh oh!

coderabbitai bot Feb 5, 2026

Uh oh!

coderabbitai bot Feb 5, 2026

Uh oh!

cloudflare-workers-and-pages bot commented Feb 5, 2026

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant

Conversation

EdisonSu768 commented Feb 5, 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 Feb 5, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Walkthrough

Changes

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!

coderabbitai bot Feb 5, 2026

Choose a reason for hiding this comment

Uh oh!

coderabbitai bot Feb 5, 2026

Choose a reason for hiding this comment

Uh oh!

coderabbitai bot Feb 5, 2026

Choose a reason for hiding this comment

Uh oh!

cloudflare-workers-and-pages bot commented Feb 5, 2026

Deploying alauda-ai with Cloudflare Pages

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant

EdisonSu768 commented Feb 5, 2026 •

edited by coderabbitai bot

Loading

coderabbitai bot commented Feb 5, 2026 •

edited

Loading