From 098ada0cc344265596fb6ae1b5f854a54a532c54 Mon Sep 17 00:00:00 2001 From: EdwardAngert <17991901+EdwardAngert@users.noreply.github.com> Date: Wed, 26 Feb 2025 17:03:28 +0000 Subject: [PATCH 01/10] edit early access stage --- docs/contributing/feature-stages.md | 26 +++++++++++++------------- 1 file changed, 13 insertions(+), 13 deletions(-) diff --git a/docs/contributing/feature-stages.md b/docs/contributing/feature-stages.md index 97b8b020a4559..682db8ac14d89 100644 --- a/docs/contributing/feature-stages.md +++ b/docs/contributing/feature-stages.md @@ -9,37 +9,37 @@ If you encounter an issue with any Coder feature, please submit a ## Early access features +- **Stable**: No +- **Production-ready**: No +- **Support**: GitHub issues + Early access features are neither feature-complete nor stable. We do not 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. - -## Experimental features - -These features are disabled by default, and not recommended for use in +They 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 stay in the experimental stage for one month. +early access features are complete, but require further internal testing and +will stay in the early access stage for at least one month. -Coder may make significant changes to experiments or revert features to a -feature flag at any time. +Coder may make significant changes or revert features to a feature flag at any time. -If you plan to activate an experimental feature, we suggest that you use a +If you plan to activate an early access 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 +# Enable all early access features coder server --experiments=* -# Enable multiple experimental features +# Enable multiple early access features coder server --experiments=feature1,feature2 # Alternatively, use the `CODER_EXPERIMENTS` environment variable. ``` +You can opt-out of a feature after you've enabled it. + ### Available experimental features From 4ec822fe0b9f5df4eb87ffd11bf26941de23f51e Mon Sep 17 00:00:00 2001 From: EdwardAngert <17991901+EdwardAngert@users.noreply.github.com> Date: Wed, 26 Feb 2025 17:46:46 +0000 Subject: [PATCH 02/10] copy edit EA --- docs/contributing/feature-stages.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/contributing/feature-stages.md b/docs/contributing/feature-stages.md index 682db8ac14d89..08be38c8ec9d9 100644 --- a/docs/contributing/feature-stages.md +++ b/docs/contributing/feature-stages.md @@ -19,8 +19,8 @@ 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. They are disabled by default, and not recommended for use in -production as they may cause performance or stability issues. In most cases, -early access features are complete, but require further internal testing and +production because they might cause performance or stability issues. In most cases, +early access features are mostly complete, but require further internal testing and will stay in the early access stage for at least one month. Coder may make significant changes or revert features to a feature flag at any time. @@ -29,7 +29,7 @@ If you plan to activate an early access feature, we suggest that you use a staging deployment. ```yaml -# Enable all early access features +# Enable all early access features coder server --experiments=* # Enable multiple early access features @@ -40,7 +40,7 @@ coder server --experiments=feature1,feature2 You can opt-out of a feature after you've enabled it. -### Available experimental features +### Available early access features From b6d5cfd679c7abe99e676a600c688fa40fc63377 Mon Sep 17 00:00:00 2001 From: EdwardAngert <17991901+EdwardAngert@users.noreply.github.com> Date: Wed, 26 Feb 2025 18:55:36 +0000 Subject: [PATCH 03/10] beta section --- docs/contributing/feature-stages.md | 28 ++++++++++++++++++++++++---- 1 file changed, 24 insertions(+), 4 deletions(-) diff --git a/docs/contributing/feature-stages.md b/docs/contributing/feature-stages.md index 08be38c8ec9d9..7236361d79327 100644 --- a/docs/contributing/feature-stages.md +++ b/docs/contributing/feature-stages.md @@ -16,7 +16,7 @@ If you encounter an issue with any Coder feature, please submit a Early access features are neither feature-complete nor stable. We do not recommend using early access features in production deployments. -Coder releases early access features behind an “unsafe” experiment, where +Coder often releases early access features behind an “unsafe” experiment, where they’re accessible but not easy to find. They are disabled by default, and not recommended for use in production because they might cause performance or stability issues. In most cases, @@ -53,11 +53,31 @@ You can opt-out of a feature after you've enabled it. ## Beta -Beta features are open to the public, but are tagged with a `Beta` label. +- **Stable**: No +- **Production-ready**: Not fully +- **Support**: Documentation, [Discord](https://discord.gg/coder), and [GitHub issues](https://github.com/coder/coder/issues) + +Beta features are open to the public and are tagged with a `Beta` label. + +They’re in active development and subject to minor changes. +They might 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 are often ready for general availability within two-three releases. +You should test beta features in staging environments. +You can use beta features in production, but should set expectations and inform users that some features may be incomplete. + +We keep documentation about beta features up-to-date with the latest information, including planned features, limitations, and workarounds. +If you encounter an issue, please contact your [Coder account team](https://coder.com/contact), reach out on [Discord](https://discord.gg/coder), or create a [GitHub issues](https://github.com/coder/coder/issues) if there isn't one already. +While we will do our best to provide support with beta features, most issues will be escalated to the product team. +Beta features are not covered within service-level agreements (SLA). + +Most beta features are enabled by default. +Beta features are announced through the [Coder Changelog](https://coder.com/changelog), and more information is available in the documentation. ## General Availability (GA) +- **Stable**: Yes +- **Production-ready**: Yes +- **Support**: Yes, [based on license](https://coder.com/pricing). + All other features have been tested, are stable, and are enabled by default. From 28ea28580896020e6dc84b37c9b848b25b23e1d8 Mon Sep 17 00:00:00 2001 From: EdwardAngert <17991901+EdwardAngert@users.noreply.github.com> Date: Wed, 26 Feb 2025 19:24:49 +0000 Subject: [PATCH 04/10] ga --- docs/contributing/feature-stages.md | 14 +++++++++++++- 1 file changed, 13 insertions(+), 1 deletion(-) diff --git a/docs/contributing/feature-stages.md b/docs/contributing/feature-stages.md index 7236361d79327..d3999f8fa6a26 100644 --- a/docs/contributing/feature-stages.md +++ b/docs/contributing/feature-stages.md @@ -80,4 +80,16 @@ Beta features are announced through the [Coder Changelog](https://coder.com/chan - **Production-ready**: Yes - **Support**: Yes, [based on license](https://coder.com/pricing). -All other features have been tested, are stable, and are enabled by default. +All features that are not explicitly tagged as `Early access` or `Beta` are considered generally available (GA). +They have been tested, are stable, and are enabled by default. + +If your Coder license includes an SLA, please consult it for an outline of specific expectations. + +For support, consult our knowledgeable and growing community on [Discord](https://discord.gg/coder), or create a [GitHub issue](https://github.com/coder/coder/issues) if one doesn't exist already. +Customers with a valid Coder license, can submit a support request or contact your [account team](https://coder.com/contact). + +We intend [Coder documentation](../README.md) to be the [single source of truth](https://en.wikipedia.org/wiki/Single_source_of_truth) and all features should have some form of complete documentation that outlines how to use or implement a feature. +If you discover an error or if you have a suggestion that could improve the documentation, please [submit a GitHub issue](https://github.com/coder/internal/issues/new?title=request%28docs%29%3A+request+title+here&labels=["customer-feedback","docs"]&body=please+enter+your+request+here). + +Some GA features can be disabled for air-gapped deployments. +Consult the feature's documentation or submit a support ticket for assistance. From 734a0d22832b41816b46f2a6899932aa3fb24015 Mon Sep 17 00:00:00 2001 From: EdwardAngert <17991901+EdwardAngert@users.noreply.github.com> Date: Wed, 26 Feb 2025 19:25:28 +0000 Subject: [PATCH 05/10] typo --- docs/contributing/feature-stages.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/contributing/feature-stages.md b/docs/contributing/feature-stages.md index d3999f8fa6a26..bb4dfce4ddf27 100644 --- a/docs/contributing/feature-stages.md +++ b/docs/contributing/feature-stages.md @@ -4,7 +4,7 @@ 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 +[GitHub issue](https://github.com/coder/coder/issues) or join the [Coder Discord](https://discord.gg/coder). ## Early access features From 91743bb04807f4f60848407ff27f49c89da86b39 Mon Sep 17 00:00:00 2001 From: EdwardAngert <17991901+EdwardAngert@users.noreply.github.com> Date: Wed, 26 Feb 2025 19:31:20 +0000 Subject: [PATCH 06/10] ea steps to expand section --- docs/contributing/feature-stages.md | 24 +++++++++++++++++------- 1 file changed, 17 insertions(+), 7 deletions(-) diff --git a/docs/contributing/feature-stages.md b/docs/contributing/feature-stages.md index bb4dfce4ddf27..3e8e2efb914aa 100644 --- a/docs/contributing/feature-stages.md +++ b/docs/contributing/feature-stages.md @@ -28,18 +28,28 @@ Coder may make significant changes or revert features to a feature flag at any t If you plan to activate an early access feature, we suggest that you use a staging deployment. -```yaml -# Enable all early access features -coder server --experiments=* +
To enable early access features: -# Enable multiple early access features -coder server --experiments=feature1,feature2 +Use the [Coder CLI](../install/cli.md) `--experiments` flag to enable early access features: -# Alternatively, use the `CODER_EXPERIMENTS` environment variable. -``` +- Enable all early access features: + + ```shell + coder server --experiments=* + ``` + +- Enable multiple early access features: + + ```shell + coder server --experiments=feature1,feature2 + ``` + +You can also use the `CODER_EXPERIMENTS` [environment variable](../admin/setup/index.md). You can opt-out of a feature after you've enabled it. +
+ ### Available early access features From a4d0b91ff66845a8db99377a976f8df53c788259 Mon Sep 17 00:00:00 2001 From: EdwardAngert <17991901+EdwardAngert@users.noreply.github.com> Date: Wed, 26 Feb 2025 19:35:31 +0000 Subject: [PATCH 07/10] move feature stages to about --- docs/{contributing => about}/feature-stages.md | 0 docs/manifest.json | 12 ++++++------ 2 files changed, 6 insertions(+), 6 deletions(-) rename docs/{contributing => about}/feature-stages.md (100%) diff --git a/docs/contributing/feature-stages.md b/docs/about/feature-stages.md similarity index 100% rename from docs/contributing/feature-stages.md rename to docs/about/feature-stages.md diff --git a/docs/manifest.json b/docs/manifest.json index 2da08f84d6419..ba47905bac086 100644 --- a/docs/manifest.json +++ b/docs/manifest.json @@ -16,6 +16,12 @@ "title": "Screenshots", "description": "View screenshots of the Coder platform", "path": "./start/screenshots.md" + }, + { + "title": "Feature stages", + "description": "Information about pre-GA stages.", + "path": "./contributing/feature-stages.md", + "icon_path": "./images/icons/stairs.svg" } ] }, @@ -639,12 +645,6 @@ "path": "./contributing/CODE_OF_CONDUCT.md", "icon_path": "./images/icons/circle-dot.svg" }, - { - "title": "Feature stages", - "description": "Policies for Alpha and Experimental features.", - "path": "./contributing/feature-stages.md", - "icon_path": "./images/icons/stairs.svg" - }, { "title": "Documentation", "description": "Our style guide for use when authoring documentation", From a8ca40465d272349a5ec6d726f845db2afcc1315 Mon Sep 17 00:00:00 2001 From: EdwardAngert <17991901+EdwardAngert@users.noreply.github.com> Date: Wed, 26 Feb 2025 19:38:58 +0000 Subject: [PATCH 08/10] edit manifest --- docs/manifest.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/manifest.json b/docs/manifest.json index ba47905bac086..a46f21c4f57d0 100644 --- a/docs/manifest.json +++ b/docs/manifest.json @@ -20,7 +20,7 @@ { "title": "Feature stages", "description": "Information about pre-GA stages.", - "path": "./contributing/feature-stages.md", + "path": "./about/feature-stages.md", "icon_path": "./images/icons/stairs.svg" } ] From 6e82c46c2b3985ee040db9087b6de8b965d23c3e Mon Sep 17 00:00:00 2001 From: EdwardAngert <17991901+EdwardAngert@users.noreply.github.com> Date: Wed, 26 Feb 2025 19:40:18 +0000 Subject: [PATCH 09/10] rm icon for now --- docs/manifest.json | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/docs/manifest.json b/docs/manifest.json index a46f21c4f57d0..0dfb85096ae34 100644 --- a/docs/manifest.json +++ b/docs/manifest.json @@ -20,8 +20,7 @@ { "title": "Feature stages", "description": "Information about pre-GA stages.", - "path": "./about/feature-stages.md", - "icon_path": "./images/icons/stairs.svg" + "path": "./about/feature-stages.md" } ] }, From fd85a79cb32ac7c539301a527567471db7a03e5a Mon Sep 17 00:00:00 2001 From: Edward Angert Date: Wed, 26 Feb 2025 15:37:05 -0500 Subject: [PATCH 10/10] Update docs/about/feature-stages.md Co-authored-by: Ben Potter --- docs/about/feature-stages.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/about/feature-stages.md b/docs/about/feature-stages.md index 3e8e2efb914aa..f5afb78836a03 100644 --- a/docs/about/feature-stages.md +++ b/docs/about/feature-stages.md @@ -70,7 +70,7 @@ You can opt-out of a feature after you've enabled it. Beta features are open to the public and are tagged with a `Beta` label. They’re in active development and subject to minor changes. -They might contain bugs, but are generally ready for use. +They might contain minor bugs, but are generally ready for use. Beta features are often ready for general availability within two-three releases. You should test beta features in staging environments.