Skip to content

Commit 22cc6a3

Browse files
authored
docs: feature stages (#6223)
1 parent 786ad8d commit 22cc6a3

File tree

2 files changed

+30
-0
lines changed

2 files changed

+30
-0
lines changed

docs/contributing/feature-stages.md

+25
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
# Feature stages
2+
3+
Some Coder features are released as Alpha or Experimental.
4+
5+
## Alpha features
6+
7+
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.
8+
9+
We recommend using [GitHub issues](https://github.com/coder/coder/issues) to leave feedback and get support for alpha features.
10+
11+
## Experimental features
12+
13+
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.
14+
15+
```yaml
16+
# Enable all experimental features
17+
coder server --experiments=*
18+
19+
# Enable multiple experimental features
20+
coder server --experiments=feature1,feature2
21+
22+
# Alternatively, use the `CODER_EXPERIMENTS` environment variable.
23+
```
24+
25+
Visit `https://<your-coder-url>/api/v2/experiments` to see which experimental features are available for your deployment.

docs/manifest.json

+5
Original file line numberDiff line numberDiff line change
@@ -318,6 +318,11 @@
318318
"description": "See the code of conduct for contributing to Coder",
319319
"path": "./contributing/CODE_OF_CONDUCT.md"
320320
},
321+
{
322+
"title": "Feature stages",
323+
"description": "Policies for Alpha and Experimental features.",
324+
"path": "./contributing/feature-stages.md"
325+
},
321326
{
322327
"title": "Documentation",
323328
"description": "Our style guide for use when authoring documentation",

0 commit comments

Comments
 (0)