diff options
Diffstat (limited to 'doc/policy')
-rw-r--r-- | doc/policy/alpha-beta-support.md | 84 | ||||
-rw-r--r-- | doc/policy/maintenance.md | 6 |
2 files changed, 42 insertions, 48 deletions
diff --git a/doc/policy/alpha-beta-support.md b/doc/policy/alpha-beta-support.md index 1c7e9e77751..e142fe9e908 100644 --- a/doc/policy/alpha-beta-support.md +++ b/doc/policy/alpha-beta-support.md @@ -4,68 +4,62 @@ group: Distribution info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Support for Alpha, Beta, Limited Availability, and Generally Available features **(PREMIUM)** +# Support for Experiment, Beta, and Generally Available features **(PREMIUM)** -Some GitLab features are released as Alpha or Beta versions and are +Some GitLab features are released as Experiment or Beta versions and are [not fully supported](https://about.gitlab.com/support/statement-of-support/#alpha-beta-features). All other features are considered to be Generally Available (GA). -## Alpha features +## Experiment -Support is **not** provided for Alpha features and issues with them should be opened in the [GitLab issue tracker](https://gitlab.com/gitlab-org/gitlab/issues). - -Characteristics of Alpha features: +Support is not provided for features listed as "Experimental" or "Alpha" or any similar designation. Issues regarding such features should be opened in the GitLab issue tracker. - Not ready for production use. -- Unstable and can cause performance and stability issues. -- Configuration and dependencies are likely to change. -- Features and functions may be removed. Breaking changes may occur outside of major releases or with less notice than for Beta or Generally Available features. -- Data loss can occur (be that through bugs or updates). -- Documentation reflects the Alpha status. -- Behind flags that are off by default. -- Not announced in release posts. - -## Beta features - -Your Support Contract provides **commercially-reasonable effort** support for Beta features, with the expectation that issues require extra time and assistance from development to troubleshoot. - -### Closed Beta features - -Closed Beta features are available to selected users only. - -- Not ready for production use. -- Unstable and can cause performance and stability issues. -- Configuration and dependencies unlikely to change. -- Features and functions unlikely to change. However, breaking changes may occur outside of major releases or with less notice than for Generally Available features. -- Data loss less likely. -- Behind a feature flag that is off by default and the UI reflects Beta status. -- Documentation reflects Beta status. -- Can be announced in a release post that reflects Beta status. - -### Open Beta features - -- Not ready for production use. -- Unstable and can cause performance and stability issues. +- No support available. +- May be unstable or have performance issues. +- Can be removed at any time. +- Data loss may occur. +- Documentation may not exist or just be in a blog format. +- Behind a feature flag that is on by default and the [UI reflects Experiment status](https://design.gitlab.com/usability/feature-management#highlighting-feature-versions). +- Behind a toggle that is off by default and the [UI reflects Experiment status](https://design.gitlab.com/usability/feature-management#highlighting-feature-versions). +- Feedback issue to engage with team. +- UX not finalized, might be just quick action access. +- Not announced in a release post. + +## Beta + +Commercially-reasonable efforts are made to provide limited support for features designated as "Beta," with the expectation that issues require extra time and assistance from development to troubleshoot. + +- May not be ready for production use and the UI and documentation will reflect this status. +- May be unstable and can cause performance and stability issues. - Configuration and dependencies unlikely to change. - Features and functions unlikely to change. However, breaking changes may occur outside of major releases or with less notice than for Generally Available features. - Data loss not likely. - Support on a commercially-reasonable effort basis. - Documentation reflects Beta status. -- Behind a feature flag that is on by default and the UI reflects Beta status. -- Behind a toggle that is off by default and the UI reflects Beta status. +- UX complete or near completion. +- Behind a feature flag that is on by default and the [UI reflects Beta status](https://design.gitlab.com/usability/feature-management#highlighting-feature-versions). +- Behind a toggle that is off by default and the [UI reflects Beta status](https://design.gitlab.com/usability/feature-management#highlighting-feature-versions). - Can be announced in a release post that reflects Beta status. -## Limited Availability (LA) - -Characteristics of Limited Availability features: - -- Ready for production use by a small set of customers. -- Can be booked by Deal Desk as part of an order. -- Fully documented and [supported](https://about.gitlab.com/support/statement-of-support/#starter-premium-and-ultimate-users). - ## Generally Available (GA) Generally Available features means that they passed the [Production Readiness Review](https://gitlab.com/gitlab-com/gl-infra/readiness/-/blob/master/.gitlab/issue_templates/production_readiness.md) for GitLab.com, and are: - Ready for production use at any scale. - Fully documented and supported. +- UX complete and in line with GitLab design standards. + +## Never internal + +Features are never internal (GitLab team-members) only. +Our [mission is "everyone can contribute"](https://about.gitlab.com/company/mission/), and that is only possible if people outside the company can try a feature. +We will get higher quality (more diverse) feedback if people from different organizations try something. +We've also learned that internal only as a state slows us down more than it speeds us up. +Release the experiment instead of testing internally or waiting for the feature to be in a Beta state. +The experimental features are only shown when people/organizations opt-in to experiments, we are allowed to make mistakes here and literally experiment. + +## All features are in production + +All features that are available on GitLab.com are considered "in production." +Because all Experiment, Beta, and Generally Available features are available on GitLab.com, they are all considered to be in production. diff --git a/doc/policy/maintenance.md b/doc/policy/maintenance.md index fcb6e5c1b20..eed9f006bfa 100644 --- a/doc/policy/maintenance.md +++ b/doc/policy/maintenance.md @@ -110,9 +110,9 @@ The decision on whether backporting a change is performed is done at the discret [current release managers](https://about.gitlab.com/community/release-managers/), based on *all* of the following: -1. Estimated [severity](../development/contributing/issue_workflow.md#severity-labels) of the bug: +1. Estimated [severity](../development/labels/index.md#severity-labels) of the bug: Highest possible impact to users based on the current definition of severity. -1. Estimated [priority](../development/contributing/issue_workflow.md#priority-labels) of the bug: +1. Estimated [priority](../development/labels/index.md#priority-labels) of the bug: Immediate impact on all impacted users based on the above estimated severity. 1. Potentially incurring data loss and/or security breach. 1. Potentially affecting one or more strategic accounts due to a proven inability by the user to upgrade to the current stable version. @@ -122,7 +122,7 @@ the current stable release, and two previous monthly releases. In rare cases a r For instance, if we release `13.2.1` with a fix for a severe bug introduced in `13.0.0`, we could backport the fix to a new `13.0.x`, and `13.1.x` patch release. -Note that [severity](../development/contributing/issue_workflow.md#severity-labels) 3 and lower +Note that [severity](../development/labels/index.md#severity-labels) 3 and lower requests are automatically turned down. To request backporting to more than one stable release for consideration, raise an issue in the |