Skip to content

Commit 7473439

Browse files
committed
docs: clarify feature stages criteria and support expectations
Updates the feature stages documentation to reflect internal agreements: Early Access (EA): - Clarify EA features are referred to internally as MVP, Phase 1, or Alpha - Detail customer expectations: rough edges, missing features, bugs expected - Update support: no support/SLA, escalated directly to product team - Confirm opt-in only via CODER_EXPERIMENTS - Add experimental naming convention requirement for API/CLI Beta: - Remove statement that beta features are enabled by default - Clarify beta features are opt-in but discoverable without experiment flags - Emphasize stable API goal between Beta and GA - State beta features are generally feature-complete (focus on stability) - Update support: best effort (no SLA), ~60% escalated to product team GA: - Add transition criteria: stability, scale, compatibility, 80% use cases - Clarify most GA features enabled by default, but config-heavy features (like Prebuilds) may remain opt-in by design - Emphasize documentation as single source of truth with air-gapped deployment instructions
1 parent fca9343 commit 7473439

File tree

1 file changed

+82
-44
lines changed

1 file changed

+82
-44
lines changed

docs/install/releases/feature-stages.md

Lines changed: 82 additions & 44 deletions
Original file line numberDiff line numberDiff line change
@@ -9,32 +9,38 @@ If you encounter an issue with any Coder feature, please submit a
99

1010
## Feature stages
1111

12-
| Feature stage | Stable | Production-ready | Support | Description |
13-
|----------------------------------------|--------|------------------|-----------------------|-------------------------------------------------------------------------------------------------------------------------------|
14-
| [Early Access](#early-access-features) | No | No | GitHub issues | For staging only. Not feature-complete or stable. Disabled by default. |
15-
| [Beta](#beta) | No | Not fully | Docs, Discord, GitHub | Publicly available. In active development with minor bugs. Suitable for staging; optional for production. Not covered by SLA. |
16-
| [GA](#general-availability-ga) | Yes | Yes | License-based | Stable and tested. Enabled by default. Fully documented. Support based on license. |
12+
| Feature stage | Stable | Production-ready | Support | Description |
13+
|----------------------------------------|--------|------------------|----------------------------|-----------------------------------------------------------------------------------------------------------------------|
14+
| [Early Access](#early-access-features) | No | No | No support (GitHub issues) | For staging only. Not feature-complete or stable. Disabled by default. |
15+
| [Beta](#beta) | No | Not fully | Best effort (no SLA) | Publicly available. Mostly stable with minor bugs. Suitable for staging; optional for production. Not covered by SLA. |
16+
| [GA](#general-availability-ga) | Yes | Yes | License-based | Stable and tested. Fully documented. Support based on license. |
1717

1818
## Early access features
1919

2020
- **Stable**: No
2121
- **Production-ready**: No
22-
- **Support**: GitHub issues
22+
- **Support**: No support, no SLA. Bugs, feature requests, and feedback are
23+
escalated directly to the product team. You can submit feedback through
24+
[GitHub issues](https://github.com/coder/coder/issues).
2325

24-
Early access features are neither feature-complete nor stable. We do not
25-
recommend using early access features in production deployments.
26+
Early access features are neither feature-complete nor stable.
27+
**Do not use early access features in production deployments.**
2628

27-
Coder sometimes releases early access features that are available for use, but
28-
are disabled by default. You shouldn't use early access features in production
29-
because they might cause performance or stability issues. Early access features
30-
can be mostly feature-complete, but require further internal testing and remain
31-
in the early access stage for at least one month.
29+
Early access features are also referred to internally as MVP, Phase 1, or Alpha.
30+
These features are rough around the edges, may be missing functionality, and
31+
bugs are expected. Coder may make significant changes to or completely remove
32+
early access features at any time.
3233

33-
Coder may make significant changes or revert features to a feature flag at any
34-
time.
34+
### Early access feature requirements
3535

36-
If you plan to activate an early access feature, we suggest that you use a
37-
staging deployment.
36+
- **Opt-in only**: Early access features are always disabled by default.
37+
Administrators must explicitly enable them, typically via a server flag such
38+
as `CODER_EXPERIMENTS`.
39+
- **Experimental naming**: API routes and CLI commands for early access features
40+
use "experimental" naming conventions. These experimental routes are
41+
deprecated when the feature moves to Beta.
42+
- **Staging only**: If you plan to test an early access feature, use a staging
43+
deployment.
3844

3945
<details><summary>To enable early access features:</summary>
4046

@@ -74,31 +80,43 @@ stable release.
7480

7581
- **Stable**: No
7682
- **Production-ready**: Not fully
77-
- **Support**: Documentation, [Discord](https://discord.gg/coder), and
78-
[GitHub issues](https://github.com/coder/coder/issues)
79-
80-
Beta features are open to the public and are tagged with a `Beta` label.
81-
82-
They’re in active development and subject to minor changes. They might contain
83-
minor bugs, but are generally ready for use.
84-
85-
Beta features are often ready for general availability within two-three
86-
releases. You should test beta features in staging environments. You can use
87-
beta features in production, but should set expectations and inform users that
88-
some features may be incomplete.
89-
90-
We keep documentation about beta features up-to-date with the latest
91-
information, including planned features, limitations, and workarounds. If you
83+
- **Support**: Best effort support (no SLA). Approximately 60% of support
84+
tickets are escalated to the product team. You can also reach out via
85+
[Documentation](../../README.md), [Discord](https://discord.gg/coder), and
86+
[GitHub issues](https://github.com/coder/coder/issues).
87+
88+
Beta features are publicly available and tagged with a `Beta` label. They are
89+
generally stable with a mostly complete feature set, though minor bugs may
90+
exist.
91+
92+
### Beta feature characteristics
93+
94+
- **Opt-in**: Beta features are not enabled by default. Unlike Early Access
95+
features, Beta features can be naturally discovered via the product and
96+
documentation without requiring `CODER_EXPERIMENTS` flags. Administrators can
97+
enable them through standard configuration.
98+
- **Stable API**: The goal for Beta is to achieve a generally stable feature set
99+
and API. Significant API changes are not expected between Beta and GA.
100+
- **Feature complete**: Beta features generally contain the same features as GA.
101+
The focus between Beta and GA is on stability and bug fixes, not adding new
102+
functionality.
103+
- **Production optional**: You can use Beta features in production, but should
104+
inform users that some rough edges may exist. We recommend testing in staging
105+
environments first.
106+
107+
Beta features are typically ready for general availability within two to three
108+
releases. We keep documentation about Beta features up-to-date with the latest
109+
information, including planned features, limitations, and workarounds.
110+
111+
Beta features are not covered within service-level agreements (SLA). If you
92112
encounter an issue, please contact your
93113
[Coder account team](https://coder.com/contact), reach out on
94114
[Discord](https://discord.gg/coder), or create a
95-
[GitHub issues](https://github.com/coder/coder/issues) if there isn't one
96-
already. While we will do our best to provide support with beta features, most
97-
issues will be escalated to the product team. Beta features are not covered
98-
within service-level agreements (SLA).
115+
[GitHub issue](https://github.com/coder/coder/issues) if there isn't one
116+
already.
99117

100-
Most beta features are enabled by default. Beta features are announced through
101-
the [Coder Changelog](https://coder.com/changelog), and more information is
118+
Beta features are announced through the
119+
[Coder Changelog](https://coder.com/changelog), and more information is
102120
available in the documentation.
103121

104122
## General Availability (GA)
@@ -108,23 +126,43 @@ available in the documentation.
108126
- **Support**: Yes, [based on license](https://coder.com/pricing).
109127

110128
All features that are not explicitly tagged as `Early access` or `Beta` are
111-
considered generally available (GA). They have been tested, are stable, and are
112-
enabled by default.
129+
considered generally available (GA). They have been tested and are stable.
130+
131+
### Transition from Beta to GA
132+
133+
The transition from Beta to GA focuses primarily on:
134+
135+
- **Stability**: Ensuring the feature works reliably across various conditions.
136+
- **Scale**: Verifying performance under production workloads.
137+
- **Compatibility**: Testing across a wider set of Coder versions and
138+
environments.
139+
140+
A feature should fit at least 80% of planned use cases before reaching GA.
141+
142+
### GA feature characteristics
143+
144+
- **Enabled by default**: Most GA features are enabled by default. However,
145+
features that require extra configuration (such as Prebuilds or external
146+
integrations) may remain opt-in by design, even in GA.
147+
- **Full documentation**: GA features have complete documentation that outlines
148+
how to use or implement the feature, including configuration options,
149+
troubleshooting, and instructions for disabling features in air-gapped
150+
deployments where applicable.
113151

114152
If your Coder license includes an SLA, please consult it for an outline of
115153
specific expectations.
116154

117155
For support, consult our knowledgeable and growing community on
118156
[Discord](https://discord.gg/coder), or create a
119157
[GitHub issue](https://github.com/coder/coder/issues) if one doesn't exist
120-
already. Customers with a valid Coder license, can submit a support request or
158+
already. Customers with a valid Coder license can submit a support request or
121159
contact your [account team](https://coder.com/contact).
122160

123161
We intend [Coder documentation](../../README.md) to be the
124162
[single source of truth](https://en.wikipedia.org/wiki/Single_source_of_truth)
125-
and all features should have some form of complete documentation that outlines
126-
how to use or implement a feature. If you discover an error or if you have a
127-
suggestion that could improve the documentation, please
163+
and all features should have complete documentation that outlines how to use or
164+
implement a feature. If you discover an error or if you have a suggestion that
165+
could improve the documentation, please
128166
[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).
129167

130168
Some GA features can be disabled for air-gapped deployments. Consult the

0 commit comments

Comments
 (0)