Skip to content

Commit 89144e9

Browse files
committed
docs: add prebuilds experiment
1 parent b4ed9d2 commit 89144e9

File tree

1 file changed

+59
-35
lines changed

1 file changed

+59
-35
lines changed

docs/install/releases/feature-stages.md

Lines changed: 59 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ If you encounter an issue with any Coder feature, please submit a
1010
## Feature stages
1111

1212
| Feature stage | Stable | Production-ready | Support | Description |
13-
|----------------------------------------|--------|------------------|-----------------------|-------------------------------------------------------------------------------------------------------------------------------|
13+
| -------------------------------------- | ------ | ---------------- | --------------------- | ----------------------------------------------------------------------------------------------------------------------------- |
1414
| [Early Access](#early-access-features) | No | No | GitHub issues | For staging only. Not feature-complete or stable. Disabled by default. |
1515
| [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. |
1616
| [GA](#general-availability-ga) | Yes | Yes | License-based | Stable and tested. Enabled by default. Fully documented. Support based on license. |
@@ -24,32 +24,37 @@ If you encounter an issue with any Coder feature, please submit a
2424
Early access features are neither feature-complete nor stable. We do not
2525
recommend using early access features in production deployments.
2626

27-
Coder sometimes releases early access features that are available for use, but are disabled by default.
28-
You shouldn't use early access features in production because they might cause performance or stability issues.
29-
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.
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.
3032

31-
Coder may make significant changes or revert features to a feature flag at any time.
33+
Coder may make significant changes or revert features to a feature flag at any
34+
time.
3235

3336
If you plan to activate an early access feature, we suggest that you use a
3437
staging deployment.
3538

3639
<details><summary>To enable early access features:</summary>
3740

38-
Use the [Coder CLI](../../install/cli.md) `--experiments` flag to enable early access features:
41+
Use the [Coder CLI](../../install/cli.md) `--experiments` flag to enable early
42+
access features:
3943

4044
- Enable all early access features:
4145

42-
```shell
43-
coder server --experiments=*
44-
```
46+
```shell
47+
coder server --experiments=*
48+
```
4549

4650
- Enable multiple early access features:
4751

48-
```shell
49-
coder server --experiments=feature1,feature2
50-
```
52+
```shell
53+
coder server --experiments=feature1,feature2
54+
```
5155

52-
You can also use the `CODER_EXPERIMENTS` [environment variable](../../admin/setup/index.md).
56+
You can also use the `CODER_EXPERIMENTS`
57+
[environment variable](../../admin/setup/index.md).
5358

5459
You can opt-out of a feature after you've enabled it.
5560

@@ -60,49 +65,68 @@ You can opt-out of a feature after you've enabled it.
6065
<!-- Code generated by scripts/release/docs_update_experiments.sh. DO NOT EDIT. -->
6166
<!-- BEGIN: available-experimental-features -->
6267

63-
Currently no experimental features are available in the latest mainline or stable release.
68+
| Feature | Description | Available in |
69+
| --------------------- | -------------------------------------------- | ------------ |
70+
| `workspace-prebuilds` | Enables the new workspace prebuilds feature. | mainline |
6471

6572
<!-- END: available-experimental-features -->
6673

6774
## Beta
6875

6976
- **Stable**: No
7077
- **Production-ready**: Not fully
71-
- **Support**: Documentation, [Discord](https://discord.gg/coder), and [GitHub issues](https://github.com/coder/coder/issues)
78+
- **Support**: Documentation, [Discord](https://discord.gg/coder), and
79+
[GitHub issues](https://github.com/coder/coder/issues)
7280

7381
Beta features are open to the public and are tagged with a `Beta` label.
7482

75-
They’re in active development and subject to minor changes.
76-
They might contain minor bugs, but are generally ready for use.
83+
They’re in active development and subject to minor changes. They might contain
84+
minor bugs, but are generally ready for use.
7785

78-
Beta features are often ready for general availability within two-three releases.
79-
You should test beta features in staging environments.
80-
You can use beta features in production, but should set expectations and inform users that some features may be incomplete.
86+
Beta features are often ready for general availability within two-three
87+
releases. You should test beta features in staging environments. You can use
88+
beta features in production, but should set expectations and inform users that
89+
some features may be incomplete.
8190

82-
We keep documentation about beta features up-to-date with the latest information, including planned features, limitations, and workarounds.
83-
If you encounter an issue, please contact your [Coder account team](https://coder.com/contact), reach out on [Discord](https://discord.gg/coder), or create a [GitHub issues](https://github.com/coder/coder/issues) if there isn't one already.
84-
While we will do our best to provide support with beta features, most issues will be escalated to the product team.
85-
Beta features are not covered within service-level agreements (SLA).
91+
We keep documentation about beta features up-to-date with the latest
92+
information, including planned features, limitations, and workarounds. If you
93+
encounter an issue, please contact your
94+
[Coder account team](https://coder.com/contact), reach out on
95+
[Discord](https://discord.gg/coder), or create a
96+
[GitHub issues](https://github.com/coder/coder/issues) if there isn't one
97+
already. While we will do our best to provide support with beta features, most
98+
issues will be escalated to the product team. Beta features are not covered
99+
within service-level agreements (SLA).
86100

87-
Most beta features are enabled by default.
88-
Beta features are announced through the [Coder Changelog](https://coder.com/changelog), and more information is available in the documentation.
101+
Most beta features are enabled by default. Beta features are announced through
102+
the [Coder Changelog](https://coder.com/changelog), and more information is
103+
available in the documentation.
89104

90105
## General Availability (GA)
91106

92107
- **Stable**: Yes
93108
- **Production-ready**: Yes
94109
- **Support**: Yes, [based on license](https://coder.com/pricing).
95110

96-
All features that are not explicitly tagged as `Early access` or `Beta` are considered generally available (GA).
97-
They have been tested, are stable, and are enabled by default.
111+
All features that are not explicitly tagged as `Early access` or `Beta` are
112+
considered generally available (GA). They have been tested, are stable, and are
113+
enabled by default.
98114

99-
If your Coder license includes an SLA, please consult it for an outline of specific expectations.
115+
If your Coder license includes an SLA, please consult it for an outline of
116+
specific expectations.
100117

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

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

107-
Some GA features can be disabled for air-gapped deployments.
108-
Consult the feature's documentation or submit a support ticket for assistance.
131+
Some GA features can be disabled for air-gapped deployments. Consult the
132+
feature's documentation or submit a support ticket for assistance.

0 commit comments

Comments
 (0)