Skip to content

Commit 7471dfc

Browse files
committed
edits from code review
1 parent 9cf2b42 commit 7471dfc

File tree

1 file changed

+15
-13
lines changed

1 file changed

+15
-13
lines changed

docs/install/releases/feature-stages.md

Lines changed: 15 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -4,18 +4,18 @@ We release some Coder features or components in feature stages before we conside
44

55
This gives Coder users the opportunity to use the latest Coder features and improve the open-source project.
66

7-
If you encounter an issue with any Coder feature, please submit a
8-
[GitHub issue](https://github.com/coder/coder/issues) or join the
9-
[Coder Discord](https://discord.gg/coder).
7+
If you encounter an issue with a Coder feature at any stage, please submit a
8+
[GitHub issue](https://github.com/coder/coder/issues) if one doesn't already exist
9+
or join the [Coder Discord](https://discord.gg/coder).
1010

1111
## Feature stages
1212

1313
| Feature stage | Stable | Production-ready | Support | Description |
1414
|-------------------------------------------|--------|------------------|-----------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
1515
| [Experiment](#experiment-hidden) | No | No | N/A | For staging and testing only. Not feature-complete or stable.</br>Hidden and disabled by default. |
1616
| [Early Access](#early-access-features) | No | No | Limited documentation</br>GitHub issues | For staging only. Functional, but not feature-complete or stable.</br>Disabled by default. |
17-
| [Beta](#beta) | No | Not fully | Documentation</br>Discord</br>GitHub | Publicly available on an opt-in basis. In active development with minor bugs. Suitable for staging; optional for production. Not covered by SLA. |
18-
| [GA](#general-availability-ga) | Yes | Yes | License-based / SLA | Stable and tested. Enabled by default. Fully documented. Support based on license. |
17+
| [Beta](#beta) | No | Not fully | Documentation</br>Discord</br>GitHub | Publicly available on an opt-in basis. In active development with minor bugs. Suitable for staging; optional for production.|
18+
| [GA](#general-availability-ga) | Yes | Yes | License-based / SLA | Stable and tested. Enabled by default. Fully documented.|
1919
| [Legacy (Deprecated)](#legacy-deprecated) | Yes* | Yes* | Best-effort security updates | Legacy features continue to function, but will not be updated outside of the limits defined in a customer's license or agreement.</br>They will be removed in future versions of Coder. |
2020

2121
## Experiment (Hidden)
@@ -27,7 +27,7 @@ If you encounter an issue with any Coder feature, please submit a
2727
Experimental features are in active development and hidden by default.
2828
They are not ready for ongoing use and aspects might be broken or can lead to data loss.
2929

30-
You can enable an experimental feature for testing, if you want to explore the latest Coder code, or if you'd like to contribute.
30+
You can enable an experimental feature for testing if you want to explore the latest Coder code or if you'd like to contribute.
3131

3232
<details><summary>To enable an experimental feature:</summary>
3333

@@ -43,16 +43,17 @@ coder server --experiments=featureName
4343

4444
- **Stable**: No
4545
- **Production-ready**: No
46-
- **Support**: GitHub issues
46+
- **Support**: [Discord](https://discord.gg/coder), and [GitHub issues](https://github.com/coder/coder/issues)
4747

4848
Early access features are neither feature-complete nor stable.
4949
We do not recommend using early access features in production deployments.
5050

5151
Coder sometimes releases early access features that are available for use, but are disabled by default.
52+
5253
You shouldn't use early access features in production because they might cause performance or stability issues.
5354
Early access features can be mostly feature-complete, but require further internal testing and remain in the early access stage for at least one month.
5455

55-
Coder may make significant changes or revert features to a feature flag at any time.
56+
Coder may make significant changes or revert features to [Experiment](#experiment-hidden) at any time.
5657

5758
If you plan to activate an early access feature, we suggest that you use a staging deployment.
5859

@@ -102,7 +103,7 @@ Beta features are open to the public and are tagged with a `Beta` label.
102103
They’re in active development and subject to minor changes.
103104
They might contain minor bugs, but are generally ready for use.
104105

105-
Beta features are often ready for general availability within two-three releases.
106+
Beta features are often ready for general availability within two or three releases.
106107
You should test beta features in staging environments.
107108
You can use beta features in production, but should set expectations and inform users that some features may be incomplete.
108109

@@ -112,14 +113,15 @@ If you encounter an issue, please contact your [Coder account team](https://code
112113
While we will do our best to provide support with beta features, most issues will be escalated to the product team.
113114
Beta features are not covered within service-level agreements (SLA).
114115

115-
Most beta features are enabled by default.
116-
Beta features are announced through the [Coder Changelog](https://coder.com/changelog), and more information is available in the documentation.
116+
Beta features are announced through the [Coder Changelog](https://coder.com/changelog), and more information is available
117+
in the documentation for the feature.
117118

118119
## General Availability (GA)
119120

120121
- **Stable**: Yes
121122
- **Production-ready**: Yes
122-
- **Support**: Yes, [based on license](https://coder.com/pricing).
123+
- **Support**: [Based on license](https://coder.com/pricing), [Discord](https://discord.gg/coder), and
124+
[GitHub issues](https://github.com/coder/coder/issues)
123125

124126
All features that are not explicitly tagged as `Early access` or `Beta` are considered generally available (GA).
125127
They have been tested, are stable, and are enabled by default.
@@ -133,7 +135,7 @@ Customers with a valid Coder license, can submit a support request or contact yo
133135
We intend [Coder documentation](../../README.md) to be the [single source of truth](https://en.wikipedia.org/wiki/Single_source_of_truth)
134136
and all features should have some form of complete documentation that outlines how to use or implement a feature.
135137
If you discover an error or if you have a suggestion that could improve the documentation, please
136-
[submit a GitHub issue](https://github.com/coder/internal/issues/new?title=request%28docs%29%3A+request+title+here&labels=["customer-feedback","docs"]&body=please+enter+your+request+here).
138+
[submit a GitHub issue](https://github.com/coder/coder/issues/new?title=request%28docs%29%3A+request+title+here&labels=["customer-feedback","docs"]&body=please+enter+your+request+here).
137139

138140
Some GA features can be disabled for air-gapped deployments.
139141
Consult the feature's documentation or submit a support ticket for assistance.

0 commit comments

Comments
 (0)