From 01f4e7d335acddd3f925a6d57fe5a3827bef974f Mon Sep 17 00:00:00 2001 From: Ben Date: Wed, 15 Feb 2023 20:59:21 +0000 Subject: [PATCH] docs: feature stages --- docs/contributing/feature-stages.md | 25 +++++++++++++++++++++++++ docs/manifest.json | 5 +++++ 2 files changed, 30 insertions(+) create mode 100644 docs/contributing/feature-stages.md diff --git a/docs/contributing/feature-stages.md b/docs/contributing/feature-stages.md new file mode 100644 index 0000000000000..f02901570816a --- /dev/null +++ b/docs/contributing/feature-stages.md @@ -0,0 +1,25 @@ +# Feature stages + +Some Coder features are released as Alpha or Experimental. + +## 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. + +## 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. + +```yaml +# Enable all experimental features +coder server --experiments=* + +# Enable multiple experimental features +coder server --experiments=feature1,feature2 + +# Alternatively, use the `CODER_EXPERIMENTS` environment variable. +``` + +Visit `https:///api/v2/experiments` to see which experimental features are available for your deployment. diff --git a/docs/manifest.json b/docs/manifest.json index 99f98817269d3..b8e2b30bb3ded 100644 --- a/docs/manifest.json +++ b/docs/manifest.json @@ -318,6 +318,11 @@ "description": "See the code of conduct for contributing to Coder", "path": "./contributing/CODE_OF_CONDUCT.md" }, + { + "title": "Feature stages", + "description": "Policies for Alpha and Experimental features.", + "path": "./contributing/feature-stages.md" + }, { "title": "Documentation", "description": "Our style guide for use when authoring documentation",