From a97d027d3c25860cbc349e3e8fd10c0418c469f8 Mon Sep 17 00:00:00 2001 From: EdwardAngert <17991901+EdwardAngert@users.noreply.github.com> Date: Tue, 24 Sep 2024 16:23:27 -0400 Subject: [PATCH 1/7] move and edit SKirby's notes to markdown --- docs/contributing/feature-stages.md | 46 ++++++++++++++++++++++++++--- 1 file changed, 42 insertions(+), 4 deletions(-) diff --git a/docs/contributing/feature-stages.md b/docs/contributing/feature-stages.md index 26eaf3272b47b..9679be25c0483 100644 --- a/docs/contributing/feature-stages.md +++ b/docs/contributing/feature-stages.md @@ -1,6 +1,8 @@ # Feature stages -Some Coder features are released as Alpha or Experimental. +Some Coder features are released in feature stages before they are generally available. + +For more information about a specific feature, please contact _X_. ## Alpha features @@ -11,11 +13,33 @@ changelog. In most cases, features will only stay in alpha for 1 month. We recommend using [GitHub issues](https://github.com/coder/coder/issues) to leave feedback and get support for alpha features. +## Early access (EA) features + +Early access features are neither feature-complete nor stable. +We do not recommend using EA features in production deployments. + +Coder releases EA features behind an “unsafe” experiment, where they’re +accessible but not easy to find. + +### Early access support expectation + +Support for early access features is available through _X_. + ## Experimental features These features are disabled by default, and not recommended for use in -production as they may cause performance or stability issues. In most cases, -features will only stay in experimental for 1-2 weeks of internal testing. +production as they may cause performance or stability issues. +In most cases, experimental features are complete, but require further +internal testing and will only stay in the experimental stage for one or +two weeks. + +Coder may make significant changes to experiments or revert features to a +feature flag at any time. + +If you plan to activate an experimental feature, we suggest that you use +a staging deployment. + +You can opt-out of an experiment after you've enabled it. ```yaml # Enable all experimental features @@ -27,7 +51,11 @@ coder server --experiments=feature1,feature2 # Alternatively, use the `CODER_EXPERIMENTS` environment variable. ``` -## Available experimental features +### Experimental features support expectation + +Support for experimental features is available through _X_. + +### Available experimental features @@ -37,3 +65,13 @@ coder server --experiments=feature1,feature2 | `notifications` | Sends notifications via SMTP and webhooks following certain events. | mainline, stable | + +## Beta + +Beta features are open to the public, but are tagged with a `Beta` label. + +They’re subject to minor changes and may contain bugs, but are generally ready for use. + +### Beta features support expectation + +Support for beta features is available through _X_. From 51d46e26c84908d97052fe2634f60be108c1d2e1 Mon Sep 17 00:00:00 2001 From: EdwardAngert <17991901+EdwardAngert@users.noreply.github.com> Date: Tue, 24 Sep 2024 16:33:01 -0400 Subject: [PATCH 2/7] prettier --- docs/contributing/feature-stages.md | 21 +++++++++++---------- 1 file changed, 11 insertions(+), 10 deletions(-) diff --git a/docs/contributing/feature-stages.md b/docs/contributing/feature-stages.md index 9679be25c0483..ca35da973a7c6 100644 --- a/docs/contributing/feature-stages.md +++ b/docs/contributing/feature-stages.md @@ -1,6 +1,7 @@ # Feature stages -Some Coder features are released in feature stages before they are generally available. +Some Coder features are released in feature stages before they are generally +available. For more information about a specific feature, please contact _X_. @@ -15,8 +16,8 @@ leave feedback and get support for alpha features. ## Early access (EA) features -Early access features are neither feature-complete nor stable. -We do not recommend using EA features in production deployments. +Early access features are neither feature-complete nor stable. We do not +recommend using EA features in production deployments. Coder releases EA features behind an “unsafe” experiment, where they’re accessible but not easy to find. @@ -28,16 +29,15 @@ Support for early access features is available through _X_. ## Experimental features These features are disabled by default, and not recommended for use in -production as they may cause performance or stability issues. -In most cases, experimental features are complete, but require further -internal testing and will only stay in the experimental stage for one or -two weeks. +production as they may cause performance or stability issues. In most cases, +experimental features are complete, but require further internal testing and +will only stay in the experimental stage for one or two weeks. Coder may make significant changes to experiments or revert features to a feature flag at any time. -If you plan to activate an experimental feature, we suggest that you use -a staging deployment. +If you plan to activate an experimental feature, we suggest that you use a +staging deployment. You can opt-out of an experiment after you've enabled it. @@ -70,7 +70,8 @@ Support for experimental features is available through _X_. Beta features are open to the public, but are tagged with a `Beta` label. -They’re subject to minor changes and may contain bugs, but are generally ready for use. +They’re subject to minor changes and may contain bugs, but are generally ready +for use. ### Beta features support expectation From 255fb4185ebe9edb732a72f462988ed544ac5ded Mon Sep 17 00:00:00 2001 From: EdwardAngert <17991901+EdwardAngert@users.noreply.github.com> Date: Tue, 24 Sep 2024 16:47:27 -0400 Subject: [PATCH 3/7] github issues for ea --- docs/contributing/feature-stages.md | 16 +++------------- 1 file changed, 3 insertions(+), 13 deletions(-) diff --git a/docs/contributing/feature-stages.md b/docs/contributing/feature-stages.md index ca35da973a7c6..9929be0c61843 100644 --- a/docs/contributing/feature-stages.md +++ b/docs/contributing/feature-stages.md @@ -3,17 +3,6 @@ Some Coder features are released in feature stages before they are generally available. -For more information about a specific feature, please contact _X_. - -## Alpha features - -Alpha features are enabled in all Coder deployments but the feature is subject -to change, or even be removed. Breaking changes may not be documented in the -changelog. In most cases, features will only stay in alpha for 1 month. - -We recommend using [GitHub issues](https://github.com/coder/coder/issues) to -leave feedback and get support for alpha features. - ## Early access (EA) features Early access features are neither feature-complete nor stable. We do not @@ -24,14 +13,15 @@ accessible but not easy to find. ### Early access support expectation -Support for early access features is available through _X_. +We recommend using [GitHub issues](https://github.com/coder/coder/issues) to +leave feedback and get support for early access features. ## Experimental features These features are disabled by default, and not recommended for use in production as they may cause performance or stability issues. In most cases, experimental features are complete, but require further internal testing and -will only stay in the experimental stage for one or two weeks. +will stay in the experimental stage for one month. Coder may make significant changes to experiments or revert features to a feature flag at any time. From 50221912e003522db3841ef5a1103129da544df2 Mon Sep 17 00:00:00 2001 From: EdwardAngert <17991901+EdwardAngert@users.noreply.github.com> Date: Wed, 25 Sep 2024 04:13:48 +0000 Subject: [PATCH 4/7] ran fmt make --- docs/manifest.json | 9 ++------- 1 file changed, 2 insertions(+), 7 deletions(-) diff --git a/docs/manifest.json b/docs/manifest.json index ffea16703ce07..78aba3fb42ff1 100644 --- a/docs/manifest.json +++ b/docs/manifest.json @@ -1,7 +1,5 @@ { - "versions": [ - "main" - ], + "versions": ["main"], "routes": [ { "title": "About", @@ -410,10 +408,7 @@ "description": "Learn how to use the role based access control against templates", "path": "./admin/rbac.md", "icon_path": "./images/icons/rbac.svg", - "state": [ - "enterprise", - "beta" - ] + "state": ["enterprise", "beta"] }, { "title": "Configuration", From 1dca655adcbce6c507ec15ff3ced906ea1592949 Mon Sep 17 00:00:00 2001 From: EdwardAngert <17991901+EdwardAngert@users.noreply.github.com> Date: Wed, 25 Sep 2024 05:03:53 +0000 Subject: [PATCH 5/7] add GA --- docs/contributing/feature-stages.md | 12 ++++++++---- 1 file changed, 8 insertions(+), 4 deletions(-) diff --git a/docs/contributing/feature-stages.md b/docs/contributing/feature-stages.md index 9929be0c61843..2c65afc847266 100644 --- a/docs/contributing/feature-stages.md +++ b/docs/contributing/feature-stages.md @@ -3,13 +3,13 @@ Some Coder features are released in feature stages before they are generally available. -## Early access (EA) features +## Early access features Early access features are neither feature-complete nor stable. We do not -recommend using EA features in production deployments. +recommend using early access features in production deployments. -Coder releases EA features behind an “unsafe” experiment, where they’re -accessible but not easy to find. +Coder releases early access features behind an “unsafe” experiment, where +they’re accessible but not easy to find. ### Early access support expectation @@ -66,3 +66,7 @@ for use. ### Beta features support expectation Support for beta features is available through _X_. + +## General Availability (GA) + +All other features have been tested, are stable, and are enabled by default. From c25401f5101ba9c8f02716ccc6ab87d509d09e06 Mon Sep 17 00:00:00 2001 From: EdwardAngert <17991901+EdwardAngert@users.noreply.github.com> Date: Wed, 25 Sep 2024 14:33:31 +0000 Subject: [PATCH 6/7] more generalized support copy --- docs/contributing/feature-stages.md | 15 ++------------- 1 file changed, 2 insertions(+), 13 deletions(-) diff --git a/docs/contributing/feature-stages.md b/docs/contributing/feature-stages.md index 2c65afc847266..7e6968557a11a 100644 --- a/docs/contributing/feature-stages.md +++ b/docs/contributing/feature-stages.md @@ -3,6 +3,8 @@ Some Coder features are released in feature stages before they are generally available. +If you encounter an issue with any Coder feature, please submit a [GitHub issues](https://github.com/coder/coder/issues) or join the [Coder Discord](https://discord.gg/coder). + ## Early access features Early access features are neither feature-complete nor stable. We do not @@ -11,11 +13,6 @@ recommend using early access features in production deployments. Coder releases early access features behind an “unsafe” experiment, where they’re accessible but not easy to find. -### Early access support expectation - -We recommend using [GitHub issues](https://github.com/coder/coder/issues) to -leave feedback and get support for early access features. - ## Experimental features These features are disabled by default, and not recommended for use in @@ -41,10 +38,6 @@ coder server --experiments=feature1,feature2 # Alternatively, use the `CODER_EXPERIMENTS` environment variable. ``` -### Experimental features support expectation - -Support for experimental features is available through _X_. - ### Available experimental features @@ -63,10 +56,6 @@ Beta features are open to the public, but are tagged with a `Beta` label. They’re subject to minor changes and may contain bugs, but are generally ready for use. -### Beta features support expectation - -Support for beta features is available through _X_. - ## General Availability (GA) All other features have been tested, are stable, and are enabled by default. From fa88d70c1c60855bb9590d0d1b1f6d63e6625c14 Mon Sep 17 00:00:00 2001 From: EdwardAngert <17991901+EdwardAngert@users.noreply.github.com> Date: Wed, 25 Sep 2024 14:34:58 +0000 Subject: [PATCH 7/7] make fmt --- docs/contributing/feature-stages.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/docs/contributing/feature-stages.md b/docs/contributing/feature-stages.md index 7e6968557a11a..4489c212e25e0 100644 --- a/docs/contributing/feature-stages.md +++ b/docs/contributing/feature-stages.md @@ -3,7 +3,9 @@ Some Coder features are released in feature stages before they are generally available. -If you encounter an issue with any Coder feature, please submit a [GitHub issues](https://github.com/coder/coder/issues) or join the [Coder Discord](https://discord.gg/coder). +If you encounter an issue with any Coder feature, please submit a +[GitHub issues](https://github.com/coder/coder/issues) or join the +[Coder Discord](https://discord.gg/coder). ## Early access features