Skip to content

Commit a97d027

Browse files
committed
move and edit SKirby's notes to markdown
1 parent 6cf30a7 commit a97d027

File tree

1 file changed

+42
-4
lines changed

1 file changed

+42
-4
lines changed

docs/contributing/feature-stages.md

Lines changed: 42 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
11
# Feature stages
22

3-
Some Coder features are released as Alpha or Experimental.
3+
Some Coder features are released in feature stages before they are generally available.
4+
5+
For more information about a specific feature, please contact _X_.
46

57
## Alpha features
68

@@ -11,11 +13,33 @@ changelog. In most cases, features will only stay in alpha for 1 month.
1113
We recommend using [GitHub issues](https://github.com/coder/coder/issues) to
1214
leave feedback and get support for alpha features.
1315

16+
## Early access (EA) features
17+
18+
Early access features are neither feature-complete nor stable.
19+
We do not recommend using EA features in production deployments.
20+
21+
Coder releases EA features behind an “unsafe” experiment, where they’re
22+
accessible but not easy to find.
23+
24+
### Early access support expectation
25+
26+
Support for early access features is available through _X_.
27+
1428
## Experimental features
1529

1630
These features are disabled by default, and not recommended for use in
17-
production as they may cause performance or stability issues. In most cases,
18-
features will only stay in experimental for 1-2 weeks of internal testing.
31+
production as they may cause performance or stability issues.
32+
In most cases, experimental features are complete, but require further
33+
internal testing and will only stay in the experimental stage for one or
34+
two weeks.
35+
36+
Coder may make significant changes to experiments or revert features to a
37+
feature flag at any time.
38+
39+
If you plan to activate an experimental feature, we suggest that you use
40+
a staging deployment.
41+
42+
You can opt-out of an experiment after you've enabled it.
1943

2044
```yaml
2145
# Enable all experimental features
@@ -27,7 +51,11 @@ coder server --experiments=feature1,feature2
2751
# Alternatively, use the `CODER_EXPERIMENTS` environment variable.
2852
```
2953

30-
## Available experimental features
54+
### Experimental features support expectation
55+
56+
Support for experimental features is available through _X_.
57+
58+
### Available experimental features
3159

3260
<!-- Code generated by scripts/release/docs_update_experiments.sh. DO NOT EDIT. -->
3361
<!-- BEGIN: available-experimental-features -->
@@ -37,3 +65,13 @@ coder server --experiments=feature1,feature2
3765
| `notifications` | Sends notifications via SMTP and webhooks following certain events. | mainline, stable |
3866

3967
<!-- END: available-experimental-features -->
68+
69+
## Beta
70+
71+
Beta features are open to the public, but are tagged with a `Beta` label.
72+
73+
They’re subject to minor changes and may contain bugs, but are generally ready for use.
74+
75+
### Beta features support expectation
76+
77+
Support for beta features is available through _X_.

0 commit comments

Comments
 (0)