Add Gen AI installations #97
Conversation
WalkthroughAdds three new documentation pages: an installation and upgrade guide for Alauda AI Generative and two pages for Alauda Build of LeaderWorkerSet (index and install), covering prerequisites, installation/upload/upgrade steps, configuration parameters, and verification commands. Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 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. ✨ Finishing touches🧪 Generate unit tests (beta)
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/installation/ai-generative.mdx`:
- Line 19: The table row uses the ExternalSiteLink component with
children="install_envoy_gateway_operator", which renders a literal internal
identifier; update the children prop on that ExternalSiteLink instance to a
human-readable label like "Install Envoy Gateway Operator" (i.e., replace
children="install_envoy_gateway_operator" with children="Install Envoy Gateway
Operator") so the link text is user-facing and readable in the table.
- Around line 40-42: Replace the incorrect phrase "Consumer Support" with
"Customer Support" in the text block containing "`Alauda AI Generative` cluster
plugin can be retrieved from Customer Portal." to match the earlier "Customer
Portal" wording; locate the exact string "Consumer Support" in the
ai-generative.mdx content and update it to "Customer Support" for consistency.
- Around line 96-97: Add the missing verification command after the "4. Verify
result. You can see the status of "Installed" in the UI or you can check the pod
status:" sentence in docs/en/installation/ai-generative.mdx by inserting a
concise kubectl example (e.g., a kubectl get pods command filtered for the
ai-generative pod or namespace) so readers can run a concrete command to verify
pods; place it immediately below the existing sentence near the "Verify result"
step and mirror the style used in docs/en/lws/install.mdx for consistency.
In `@docs/en/lws/install.mdx`:
- Around line 11-14: Update the inconsistent terminology in the docs snippet:
replace the phrase "Consumer Support" with "Customer Support" so it matches
"Customer Portal" (referencing the text "Alauda Build of LeaderWorkerSet" and
the two phrases "Customer Portal" and "Consumer Support") and ensure both
occurrences use "Customer Support" for consistency.
🧹 Nitpick comments (4)
docs/en/lws/install.mdx (2)
19-19: Missing trailing period.📝 Proposed fix
-For more information on uploading the cluster plugin, please refer to <ExternalSiteLink name="acp" href="ui/cli_tools/index.html#uploading-cluster-plugins" children="Uploading Cluster Plugins" /> +For more information on uploading the cluster plugin, please refer to <ExternalSiteLink name="acp" href="ui/cli_tools/index.html#uploading-cluster-plugins" children="Uploading Cluster Plugins" />.
33-36: Upgrade section lacks a verification step.The install section (Line 28–31) includes verification via UI status and
kubectlcommand, but the upgrade section has no equivalent. Consider adding a similar verification step for consistency.docs/en/installation/ai-generative.mdx (2)
82-82: Minor formatting: missing space before parenthesis.📝 Proposed fix
-### GIE(gateway-api-inference-extension) Configuration +### GIE (gateway-api-inference-extension) Configuration
98-101: Upgrade section lacks a verification step, same as inlws/install.mdx.Consider adding a verification step after the upgrade instructions for consistency with the install workflow.
|
|
||
| | Dependency | Type | Description | | ||
| |------------|------|-------------| | ||
| | Alauda build of Envoy Gateway <ExternalSiteLink name="acp" href="/networking/operators/envoy_gateway_operator.mdx" children="install_envoy_gateway_operator" /> | Operator | Provides the underlying gateway functionality for AI services | |
There was a problem hiding this comment.
children text looks like an internal identifier, not user-facing link text.
children="install_envoy_gateway_operator" renders as literal snake_case text. This should be human-readable, e.g., "Install Envoy Gateway Operator".
📝 Proposed fix
-| Alauda build of Envoy Gateway <ExternalSiteLink name="acp" href="/networking/operators/envoy_gateway_operator.mdx" children="install_envoy_gateway_operator" /> | Operator | Provides the underlying gateway functionality for AI services |
+| Alauda build of Envoy Gateway <ExternalSiteLink name="acp" href="/networking/operators/envoy_gateway_operator.mdx" children="Install Envoy Gateway Operator" /> | Operator | Provides the underlying gateway functionality for AI services |🤖 Prompt for AI Agents
In `@docs/en/installation/ai-generative.mdx` at line 19, The table row uses the
ExternalSiteLink component with children="install_envoy_gateway_operator", which
renders a literal internal identifier; update the children prop on that
ExternalSiteLink instance to a human-readable label like "Install Envoy Gateway
Operator" (i.e., replace children="install_envoy_gateway_operator" with
children="Install Envoy Gateway Operator") so the link text is user-facing and
readable in the table.
| `Alauda AI Generative` cluster plugin can be retrieved from Customer Portal. | ||
|
|
||
| Please contact Consumer Support for more information. |
There was a problem hiding this comment.
Same "Consumer Support" typo as in lws/install.mdx.
Should be "Customer Support" for consistency with "Customer Portal" on the previous line.
📝 Proposed fix
-Please contact Consumer Support for more information.
+Please contact Customer Support for more information.📝 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.
| `Alauda AI Generative` cluster plugin can be retrieved from Customer Portal. | |
| Please contact Consumer Support for more information. | |
| `Alauda AI Generative` cluster plugin can be retrieved from Customer Portal. | |
| Please contact Customer Support for more information. |
🤖 Prompt for AI Agents
In `@docs/en/installation/ai-generative.mdx` around lines 40 - 42, Replace the
incorrect phrase "Consumer Support" with "Customer Support" in the text block
containing "`Alauda AI Generative` cluster plugin can be retrieved from Customer
Portal." to match the earlier "Customer Portal" wording; locate the exact string
"Consumer Support" in the ai-generative.mdx content and update it to "Customer
Support" for consistency.
| `Alauda Build of LeaderWorkerSet` cluster plugin can be retrieved from Customer Portal. | ||
|
|
||
| Please contact Consumer Support for more information. | ||
|
|
There was a problem hiding this comment.
Inconsistent terminology: "Customer Portal" vs. "Consumer Support".
Line 11 refers to "Customer Portal" but Line 13 says "Consumer Support." This is likely a typo — should be "Customer Support" for consistency.
📝 Proposed fix
-Please contact Consumer Support for more information.
+Please contact Customer Support for more information.📝 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.
| `Alauda Build of LeaderWorkerSet` cluster plugin can be retrieved from Customer Portal. | |
| Please contact Consumer Support for more information. | |
| `Alauda Build of LeaderWorkerSet` cluster plugin can be retrieved from Customer Portal. | |
| Please contact Customer Support for more information. | |
🤖 Prompt for AI Agents
In `@docs/en/lws/install.mdx` around lines 11 - 14, Update the inconsistent
terminology in the docs snippet: replace the phrase "Consumer Support" with
"Customer Support" so it matches "Customer Portal" (referencing the text "Alauda
Build of LeaderWorkerSet" and the two phrases "Customer Portal" and "Consumer
Support") and ensure both occurrences use "Customer Support" for consistency.
Deploying alauda-ai with
|
| Latest commit: |
a021117
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://5243265c.alauda-ai.pages.dev |
| Branch Preview URL: | https://add-gen-ai-docs.alauda-ai.pages.dev |
fyuan1316
force-pushed
the
add-gen-ai-docs
branch
from
243ded5 to
4446da4
Compare
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Fix all issues with AI agents
In `@docs/en/installation/ai-generative.mdx`:
- Around line 98-101: Under the "Upgrading Alauda AI Generative" section, reword
step 1 to a clearer phrase (e.g., "Upload the new package version of the Alauda
AI Generative plugin to ACP") and rename "package of" to "package" or "package
version"; keep step 2 but adjust wording to be concise and consistent with the
install section; then add a verification step (similar to the install step 4)
that instructs the user to confirm the upgrade completed by checking the plugin
version/status in Administrator -> Clusters -> Target Cluster -> Functional
Components (or verifying the deployed pod/app version), and include what success
looks like (updated version listed and no error messages).
🧹 Nitpick comments (1)
docs/en/installation/ai-generative.mdx (1)
86-86: Hardcoded versionv0.5.1may become stale.Consider whether this version reference should be parameterized or accompanied by a note to check for the latest bundled version, so the doc doesn't silently go out of date.
| ## Upgrading Alauda AI Generative | ||
|
|
||
| 1. Upload the new version for package of **Alauda AI Generative** plugin to ACP. | ||
| 2. Go to the `Administrator` -> `Clusters` -> `Target Cluster` -> `Functional Components` page, then click the `Upgrade` button, and you will see the `Alauda AI Generative` can be upgraded. |
There was a problem hiding this comment.
Awkward phrasing and incomplete upgrade section.
Line 100: "Upload the new version for package of" reads awkwardly. Also, the upgrade section lacks a verification step (unlike the install section which has step 4).
📝 Proposed fix
## Upgrading Alauda AI Generative
-1. Upload the new version for package of **Alauda AI Generative** plugin to ACP.
+1. Upload the new version of the **Alauda AI Generative** plugin package to ACP.
2. Go to the `Administrator` -> `Clusters` -> `Target Cluster` -> `Functional Components` page, then click the `Upgrade` button, and you will see the `Alauda AI Generative` can be upgraded.
+3. After the upgrade completes, verify that the status shows "Installed" in the UI.📝 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.
| ## Upgrading Alauda AI Generative | |
| 1. Upload the new version for package of **Alauda AI Generative** plugin to ACP. | |
| 2. Go to the `Administrator` -> `Clusters` -> `Target Cluster` -> `Functional Components` page, then click the `Upgrade` button, and you will see the `Alauda AI Generative` can be upgraded. | |
| ## Upgrading Alauda AI Generative | |
| 1. Upload the new version of the **Alauda AI Generative** plugin package to ACP. | |
| 2. Go to the `Administrator` -> `Clusters` -> `Target Cluster` -> `Functional Components` page, then click the `Upgrade` button, and you will see the `Alauda AI Generative` can be upgraded. | |
| 3. After the upgrade completes, verify that the status shows "Installed" in the UI. |
🤖 Prompt for AI Agents
In `@docs/en/installation/ai-generative.mdx` around lines 98 - 101, Under the
"Upgrading Alauda AI Generative" section, reword step 1 to a clearer phrase
(e.g., "Upload the new package version of the Alauda AI Generative plugin to
ACP") and rename "package of" to "package" or "package version"; keep step 2 but
adjust wording to be concise and consistent with the install section; then add a
verification step (similar to the install step 4) that instructs the user to
confirm the upgrade completed by checking the plugin version/status in
Administrator -> Clusters -> Target Cluster -> Functional Components (or
verifying the deployed pod/app version), and include what success looks like
(updated version listed and no error messages).
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Fix all issues with AI agents
In `@docs/en/installation/ai-generative.mdx`:
- Line 52: Add a trailing period to the sentence that references the
ExternalSiteLink component: update the line containing the ExternalSiteLink
(name="acp" href="ui/cli_tools/index.html#uploading-cluster-plugins"
children="Uploading Cluster Plugins") so the sentence ends with a period after
the component.
|
|
||
| ## Uploading the Cluster Plugin | ||
|
|
||
| For more information on uploading the cluster plugin, please refer to <ExternalSiteLink name="acp" href="ui/cli_tools/index.html#uploading-cluster-plugins" children="Uploading Cluster Plugins" /> |
There was a problem hiding this comment.
Missing trailing period.
The sentence referencing the external link ends without punctuation.
📝 Proposed fix
-For more information on uploading the cluster plugin, please refer to <ExternalSiteLink name="acp" href="ui/cli_tools/index.html#uploading-cluster-plugins" children="Uploading Cluster Plugins" />
+For more information on uploading the cluster plugin, please refer to <ExternalSiteLink name="acp" href="ui/cli_tools/index.html#uploading-cluster-plugins" children="Uploading Cluster Plugins" />.📝 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.
| For more information on uploading the cluster plugin, please refer to <ExternalSiteLink name="acp" href="ui/cli_tools/index.html#uploading-cluster-plugins" children="Uploading Cluster Plugins" /> | |
| For more information on uploading the cluster plugin, please refer to <ExternalSiteLink name="acp" href="ui/cli_tools/index.html#uploading-cluster-plugins" children="Uploading Cluster Plugins" />. |
🤖 Prompt for AI Agents
In `@docs/en/installation/ai-generative.mdx` at line 52, Add a trailing period to
the sentence that references the ExternalSiteLink component: update the line
containing the ExternalSiteLink (name="acp"
href="ui/cli_tools/index.html#uploading-cluster-plugins" children="Uploading
Cluster Plugins") so the sentence ends with a period after the component.
2 participants
kserve-gen-ai
lws
Summary by CodeRabbit