docs: feature stages (#6223)

This commit is contained in:
Ben Potter
2023-02-15 15:51:31 -06:00
committed by GitHub
parent 786ad8d8b1
commit 22cc6a3fb6
2 changed files with 30 additions and 0 deletions
+25
View File
@@ -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://<your-coder-url>/api/v2/experiments` to see which experimental features are available for your deployment.
+5
View File
@@ -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",