Skip to content

Add feature staging guidelines #1881

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

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

ahmedwaleedmalik
Copy link
Member

@ahmedwaleedmalik ahmedwaleedmalik commented Jun 2, 2025

Due to the recent back-and-forth that we had regarding how a feature should be "marked" as alpha/beta/experimental, i'm resorting to formally documenting the feature stage guidelines to ensure that when we mark a feature alpha or beta all the required components(docs,UI,APIs, etc) also explicitly mark and document them as "alpha/beta".

IMO this document is not introducing anything new, it's just formalising what we have always been following at Kubermatic with "experimental" features.

@ahmedwaleedmalik ahmedwaleedmalik self-assigned this Jun 2, 2025
@kubermatic-bot kubermatic-bot added dco-signoff: yes Denotes that all commits in the pull request have the valid DCO signoff message. size/M Denotes a PR that changes 30-99 lines, ignoring generated files. labels Jun 2, 2025
@kubermatic-bot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by:
Once this PR has been reviewed and has the lgtm label, please ask for approval from ahmedwaleedmalik. For more information see the Code Review Process.

The full list of commands accepted by this bot can be found here.

Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment


- The following components should explicitly be marked as alpha/beta:
- APIs/CRDs: Dedicated CRDs including fields in API and CRD that are introduced for this feature.
- UI: All the views/fields that are used to interact with the feature.
Copy link
Contributor

Choose a reason for hiding this comment

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

Newly introduced features in general should rather always have a switch in the admin panel which turns them fully off and on (besides the feature gate).

Therefore, if the platform admin decides to turn a feature on, it's enough to have these marks for the platform admin, as from that point, it's their responsibility to let their custumers / users use these features. Marking features throughout all the user personas of KKP could be confusing to the end users in several cases.

The possibility to turn a feature on and off by the Platform Admin of KKP should solve this issue, and the Platform Admin should always be 100% aware if a feature is in Beta.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
dco-signoff: yes Denotes that all commits in the pull request have the valid DCO signoff message. size/M Denotes a PR that changes 30-99 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants