1
1
# Feature stages
2
2
3
- Some Coder features are released as Alpha or Experimental.
3
+ Some Coder features are released in feature stages before they are generally
4
+ available.
4
5
5
- ## Alpha features
6
+ If you encounter an issue with any Coder feature, please submit a
7
+ [ GitHub issues] ( https://github.com/coder/coder/issues ) or join the
8
+ [ Coder Discord] ( https://discord.gg/coder ) .
6
9
7
- Alpha features are enabled in all Coder deployments but the feature is subject
8
- to change, or even be removed. Breaking changes may not be documented in the
9
- changelog. In most cases, features will only stay in alpha for 1 month.
10
+ ## Early access features
10
11
11
- We recommend using [ GitHub issues] ( https://github.com/coder/coder/issues ) to
12
- leave feedback and get support for alpha features.
12
+ Early access features are neither feature-complete nor stable. We do not
13
+ recommend using early access features in production deployments.
14
+
15
+ Coder releases early access features behind an “unsafe” experiment, where
16
+ they’re accessible but not easy to find.
13
17
14
18
## Experimental features
15
19
16
20
These features are disabled by default, and not recommended for use in
17
21
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.
22
+ experimental features are complete, but require further internal testing and
23
+ will stay in the experimental stage for one month.
24
+
25
+ Coder may make significant changes to experiments or revert features to a
26
+ feature flag at any time.
27
+
28
+ If you plan to activate an experimental feature, we suggest that you use a
29
+ staging deployment.
30
+
31
+ You can opt-out of an experiment after you've enabled it.
19
32
20
33
``` yaml
21
34
# Enable all experimental features
@@ -27,7 +40,7 @@ coder server --experiments=feature1,feature2
27
40
# Alternatively, use the `CODER_EXPERIMENTS` environment variable.
28
41
```
29
42
30
- ## Available experimental features
43
+ ### Available experimental features
31
44
32
45
<!-- Code generated by scripts/release/docs_update_experiments.sh. DO NOT EDIT. -->
33
46
<!-- BEGIN: available-experimental-features -->
@@ -37,3 +50,14 @@ coder server --experiments=feature1,feature2
37
50
| ` notifications ` | Sends notifications via SMTP and webhooks following certain events. | stable |
38
51
39
52
<!-- END: available-experimental-features -->
53
+
54
+ ## Beta
55
+
56
+ Beta features are open to the public, but are tagged with a ` Beta ` label.
57
+
58
+ They’re subject to minor changes and may contain bugs, but are generally ready
59
+ for use.
60
+
61
+ ## General Availability (GA)
62
+
63
+ All other features have been tested, are stable, and are enabled by default.
0 commit comments