Add feature staging guidelines#1881
Conversation
Signed-off-by: Waleed Malik <ahmedwaleedmalik@gmail.com>
|
[APPROVALNOTIFIER] This PR is NOT APPROVED This pull-request has been approved by: The full list of commands accepted by this bot can be found here. DetailsNeeds approval from an approver in each of these files:Approvers can indicate their approval by writing |
|
|
||
| - 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. |
There was a problem hiding this comment.
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.
|
This is stale and unfortunately needs to be re-done. |
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.