Skip to content

Comments

Add alpha feature for ceph stretched cluster#562

Open
fanzy618 wants to merge 1 commit intomasterfrom
add-alpha-warning
Open

Add alpha feature for ceph stretched cluster#562
fanzy618 wants to merge 1 commit intomasterfrom
add-alpha-warning

Conversation

@fanzy618
Copy link
Contributor

@fanzy618 fanzy618 commented Feb 20, 2026

Summary by CodeRabbit

  • Documentation

    • Added Alpha Feature Disclaimer to storage documentation highlighting production readiness, SLA, and potential breaking changes.
  • Bug Fixes

    • Corrected formatting issue in storage documentation reference link.

@fanzy618 fanzy618 requested a review from jing2uo February 20, 2026 02:32
@coderabbitai
Copy link
Contributor

coderabbitai bot commented Feb 20, 2026

Walkthrough

Documentation update to a Ceph storage installation guide that adds an Alpha Feature Disclaimer block and corrects trailing formatting at the document's end.

Changes

Cohort / File(s) Summary
Documentation Updates
docs/en/storage/storagesystem_ceph/installation/create_service_extend.mdx
Added Alpha Feature Disclaimer section with warnings about production readiness, SLA, breaking changes, and upgrade considerations. Fixed trailing formatting issue and normalized line ending.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Poem

🐰 A disclaimer block hops into place,
Warning of alpha's untested space,
Formatting fixed with a gentle touch,
Documentation improved, oh so much! ✨

🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title accurately reflects the main change: adding an alpha feature disclaimer to the ceph stretched cluster documentation.
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 add-alpha-warning

Tip

Issue Planner is now in beta. Read the docs and try it out! Share your feedback on Discord.


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.

@fanzy618 fanzy618 requested a review from Muyan0828 February 20, 2026 02:34
Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🧹 Nitpick comments (2)
docs/en/storage/storagesystem_ceph/installation/create_service_extend.mdx (2)

10-18: Use the framework's admonition syntax for visual prominence.

The disclaimer is currently rendered as a plain Markdown blockquote (>). The project uses admonition directives (:::warning, :::info, :::danger) throughout the codebase, which render as styled, color-coded callout boxes. A plain blockquote is less visually prominent and inconsistent with the rest of the documentation. For a critical alpha warning, using :::danger ensures the warning receives appropriate visual emphasis.

♻️ Refactor to use :::danger admonition
-**⚠️ IMPORTANT: Alpha Feature Disclaimer**
->
-> This document describes a feature currently in the **Alpha stage**, provided strictly for early technical validation and evaluation. As the feature provider, we offer no warranties regarding its stability, reliability, or data integrity. By configuring and using this feature, you acknowledge and accept the following technical limitations:
->
-> * **Not for Production Use:** This feature lacks comprehensive system-level validation. Deploying it in production environments carries a high risk of process failure or data corruption.
-> * **No SLA Guarantee:** This feature falls outside standard Service Level Agreements (SLAs). We do not guarantee technical support response times or provide emergency hotfixes.
-> * **Breaking Changes & Deprecation:** API endpoints, configuration schemas, and core processing logic are subject to backwards-incompatible changes in future releases. The feature may also be deprecated entirely without prior notice.
-> * **No Smooth Upgrade Path:** We do not provide upgrade scripts or data migration tools between versions. Upgrading to subsequent versions typically requires completely purging existing resources and performing a fresh deployment. Any resulting loss of state or data is the sole responsibility of the user.
+:::danger Alpha Feature — Not for Production Use
+
+This document describes a feature currently in the **Alpha stage**, provided strictly for early technical validation and evaluation. As the feature provider, we offer no warranties regarding its stability, reliability, or data integrity. By configuring and using this feature, you acknowledge and accept the following technical limitations:
+
+- **Not for Production Use:** This feature lacks comprehensive system-level validation. Deploying it in production environments carries a high risk of process failure or data corruption.
+- **No SLA Guarantee:** This feature falls outside standard Service Level Agreements (SLAs). We do not guarantee technical support response times or provide emergency hotfixes.
+- **Breaking Changes & Deprecation:** API endpoints, configuration schemas, and core processing logic are subject to backwards-incompatible changes in future releases. The feature may also be deprecated entirely without prior notice.
+- **No Smooth Upgrade Path:** We do not provide upgrade scripts or data migration tools between versions. Upgrading to subsequent versions typically requires completely purging existing resources and performing a fresh deployment. Any resulting loss of state or data is the sole responsibility of the user.
+
+:::
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In `@docs/en/storage/storagesystem_ceph/installation/create_service_extend.mdx`
around lines 10 - 18, The current alpha-disclaimer is written as a Markdown
blockquote (the leading "> ..." lines); replace that blockquote with the
framework's admonition directive by wrapping the disclaimer content in an
opening ":::danger" and matching closing ":::". Update the section that begins
with "⚠️ IMPORTANT: Alpha Feature Disclaimer" to use ":::danger" so the entire
list and paragraphs render as a styled danger callout and ensure the admonition
is properly closed.

10-18: Use a :::danger admonition instead of a plain blockquote for this critical disclaimer.

The alpha feature warning is currently rendered as a plain Markdown blockquote, which lacks visual prominence. The project already uses the @alauda/doom framework with active admonition support. Converting this to :::danger will render it as a visually distinct, color-coded callout that better conveys the critical nature of the warning and reduces the risk of users overlooking it.

♻️ Proposed refactor
-> **⚠️ IMPORTANT: Alpha Feature Disclaimer**
-> 
-> This document describes a feature currently in the **Alpha stage**, provided strictly for early technical validation and evaluation. As the feature provider, we offer no warranties regarding its stability, reliability, or data integrity. By configuring and using this feature, you acknowledge and accept the following technical limitations:
-> 
-> * **Not for Production Use:** This feature lacks comprehensive system-level validation. Deploying it in production environments carries a high risk of process failure or data corruption.
-> * **No SLA Guarantee:** This feature falls outside standard Service Level Agreements (SLAs). We do not guarantee technical support response times or provide emergency hotfixes.
-> * **Breaking Changes & Deprecation:** API endpoints, configuration schemas, and core processing logic are subject to backwards-incompatible changes in future releases. The feature may also be deprecated entirely without prior notice.
-> * **No Smooth Upgrade Path:** We do not provide upgrade scripts or data migration tools between versions. Upgrading to subsequent versions typically requires completely purging existing resources and performing a fresh deployment. Any resulting loss of state or data is the sole responsibility of the user.
+:::danger Alpha Feature — Not for Production Use
+
+This document describes a feature currently in the **Alpha stage**, provided strictly for early technical validation and evaluation. As the feature provider, we offer no warranties regarding its stability, reliability, or data integrity. By configuring and using this feature, you acknowledge and accept the following technical limitations:
+
+- **Not for Production Use:** This feature lacks comprehensive system-level validation. Deploying it in production environments carries a high risk of process failure or data corruption.
+- **No SLA Guarantee:** This feature falls outside standard Service Level Agreements (SLAs). We do not guarantee technical support response times or provide emergency hotfixes.
+- **Breaking Changes & Deprecation:** API endpoints, configuration schemas, and core processing logic are subject to backwards-incompatible changes in future releases. The feature may also be deprecated entirely without prior notice.
+- **No Smooth Upgrade Path:** We do not provide upgrade scripts or data migration tools between versions. Upgrading to subsequent versions typically requires completely purging existing resources and performing a fresh deployment. Any resulting loss of state or data is the sole responsibility of the user.
+
+:::
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In `@docs/en/storage/storagesystem_ceph/installation/create_service_extend.mdx`
around lines 10 - 18, Replace the plain Markdown blockquote that begins with "⚠️
IMPORTANT: Alpha Feature Disclaimer" with a Doom admonition by wrapping the same
content (title line and the following bullet list) inside an :::danger block and
a matching closing :::, preserving all text and bullets exactly; ensure the
admonition header remains the same so it renders as the critical callout in the
`@alauda/doom` framework and verify there are no leftover blockquote markers.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.

Nitpick comments:
In `@docs/en/storage/storagesystem_ceph/installation/create_service_extend.mdx`:
- Around line 10-18: The current alpha-disclaimer is written as a Markdown
blockquote (the leading "> ..." lines); replace that blockquote with the
framework's admonition directive by wrapping the disclaimer content in an
opening ":::danger" and matching closing ":::". Update the section that begins
with "⚠️ IMPORTANT: Alpha Feature Disclaimer" to use ":::danger" so the entire
list and paragraphs render as a styled danger callout and ensure the admonition
is properly closed.
- Around line 10-18: Replace the plain Markdown blockquote that begins with "⚠️
IMPORTANT: Alpha Feature Disclaimer" with a Doom admonition by wrapping the same
content (title line and the following bullet list) inside an :::danger block and
a matching closing :::, preserving all text and bullets exactly; ensure the
admonition header remains the same so it renders as the critical callout in the
`@alauda/doom` framework and verify there are no leftover blockquote markers.

@cloudflare-workers-and-pages
Copy link

Deploying alauda-container-platform with  Cloudflare Pages  Cloudflare Pages

Latest commit: 77b14e8
Status: ✅  Deploy successful!
Preview URL: https://b71b4460.alauda-container-platform.pages.dev
Branch Preview URL: https://add-alpha-warning.alauda-container-platform.pages.dev

View logs

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants