Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix: use experimental for alpha features #3436

Merged
merged 1 commit into from
Jan 8, 2025

Conversation

derekbit
Copy link
Member

@derekbit derekbit commented Jan 8, 2025

Which issue(s) this PR fixes:

Issue longhorn/longhorn#9794

What this PR does / why we need it:

Experimental: An early stage "Preview," these features truly are experiments and might never reach GA.

Special notes for your reviewer:

Additional documentation or context

Experimental: An early stage "Preview," these features truly are
experiments and might never reach GA.

Longhorn 9794

Signed-off-by: Derek Su <derek.su@suse.com>
Copy link

coderabbitai bot commented Jan 8, 2025

Walkthrough

The pull request modifies the description of the V2 Data Engine feature in the types/setting.go file. The change involves updating the classification of the feature from "Preview Feature" to "Experimental Feature", aligning with a more standard terminology for feature maturity stages. This modification is part of an effort to improve documentation clarity and consistency in describing non-GA (Generally Available) features.

Changes

File Change Summary
types/setting.go Updated SettingCategoryV2DataEngine constant description from "v2 data engine (Preview Feature)" to "v2 data engine (Experimental Feature)"

Assessment against linked issues

Objective Addressed Explanation
Use "experimental" for alpha features [#9794]
Use "preview" for beta features [#9794]
Improve documentation clarity

The changes directly address the objectives outlined in issue #9794 by updating the terminology to more accurately reflect the feature's maturity stage. The modification aligns with the recommended practice of using "experimental" for alpha features and provides clearer documentation.


📜 Recent review details

Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between d17b4ee and 484bf5b.

📒 Files selected for processing (1)
  • types/setting.go (2 hunks)
✅ Files skipped from review due to trivial changes (1)
  • types/setting.go
⏰ Context from checks skipped due to timeout of 90000ms (2)
  • GitHub Check: Build binaries
  • GitHub Check: Summary

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR. (Beta)
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

@derekbit derekbit requested a review from innobead January 8, 2025 05:36
@derekbit derekbit changed the title fix: use experimental for alpha features fix: use experimental for alpha features Jan 8, 2025
@innobead innobead merged commit e11c082 into longhorn:master Jan 8, 2025
11 checks passed
@derekbit
Copy link
Member Author

derekbit commented Jan 8, 2025

@mergify backport v1.8.x

Copy link

mergify bot commented Jan 8, 2025

backport v1.8.x

✅ Backports have been created

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