Skip to content

Commit fe895cd

Browse files
authored
chore(docs): outline new feature stages (#14786)
adds new feature sections ### To do - [x] populate or delete scope of support sections - [ ] if populate, then: - what should people expect - how/where do they get it - [x] rm Alpha? - [ ] ~link to wikipedia?~ - ~EA: <https://en.wikipedia.org/wiki/Software_release_life_cycle#Alpha>~ - ~Experimental: <https://en.wikipedia.org/wiki/Software_release_life_cycle#Feature-complete>~ - ~Beta: <https://en.wikipedia.org/wiki/Software_release_life_cycle#Open_and_closed_beta>~ --------- Co-authored-by: EdwardAngert <17991901+EdwardAngert@users.noreply.github.com>
1 parent 13f0a0e commit fe895cd

File tree

2 files changed

+35
-16
lines changed

2 files changed

+35
-16
lines changed

docs/contributing/feature-stages.md

Lines changed: 33 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,34 @@
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
4+
available.
45

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).
69

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
1011

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.
1317

1418
## Experimental features
1519

1620
These features are disabled by default, and not recommended for use in
1721
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.
1932

2033
```yaml
2134
# Enable all experimental features
@@ -27,7 +40,7 @@ coder server --experiments=feature1,feature2
2740
# Alternatively, use the `CODER_EXPERIMENTS` environment variable.
2841
```
2942

30-
## Available experimental features
43+
### Available experimental features
3144

3245
<!-- Code generated by scripts/release/docs_update_experiments.sh. DO NOT EDIT. -->
3346
<!-- BEGIN: available-experimental-features -->
@@ -37,3 +50,14 @@ coder server --experiments=feature1,feature2
3750
| `notifications` | Sends notifications via SMTP and webhooks following certain events. | mainline, stable |
3851

3952
<!-- 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.

docs/manifest.json

Lines changed: 2 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,5 @@
11
{
2-
"versions": [
3-
"main"
4-
],
2+
"versions": ["main"],
53
"routes": [
64
{
75
"title": "About",
@@ -419,10 +417,7 @@
419417
"description": "Learn how to use the role based access control against templates",
420418
"path": "./admin/rbac.md",
421419
"icon_path": "./images/icons/rbac.svg",
422-
"state": [
423-
"enterprise",
424-
"beta"
425-
]
420+
"state": ["enterprise", "beta"]
426421
},
427422
{
428423
"title": "Configuration",

0 commit comments

Comments
 (0)