Skip to content

docs: update deployment.go feature stages and script to reflect current stages #17975

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
wants to merge 35 commits into
base: main
Choose a base branch
from
Draft
Changes from 1 commit
Commits
Show all changes
35 commits
Select commit Hold shift + click to select a range
a8a640f
chore: fall back to `gh auth login` for update_experiments.sh script
bpmct May 20, 2025
b4ed9d2
refactor: update experiment parsing script to use ExperimentsSafe ins…
bpmct May 20, 2025
89144e9
docs: add prebuilds experiment
bpmct May 20, 2025
6bc8796
bump version
bpmct May 20, 2025
ba5ce86
chore: reduce `ignore_changes` suggestion scope (#17947)
EdwardAngert May 20, 2025
83424ed
chore(coderd/rbac): add `Action{Create,Delete}Agent` to `ResourceWork…
EdwardAngert May 20, 2025
068a293
fmt (🤞)
bpmct May 20, 2025
38b093d
fmt
bpmct May 20, 2025
f6e5735
chore: replace MUI icons with Lucide icons - 17 (#17957)
EdwardAngert May 21, 2025
030d77e
docs: explain coder:// link for RDP (#17901)
EdwardAngert May 21, 2025
4b347db
feat: add Claude.md initial draft (#17785)
EdwardAngert May 21, 2025
a707538
chore: ignore 'session shutdown' yamux error in tests (#17964)
EdwardAngert May 21, 2025
1727e42
refactor: update provisioners column copy (#17949)
EdwardAngert May 21, 2025
312eacb
feat: improve transaction safety in CompleteJob function (#17970)
EdwardAngert May 21, 2025
df73eca
fix: show diagnostics if there are no parameters (#17967)
EdwardAngert May 21, 2025
6cc69c0
fix: update textarea to fit content height and set a max height (#17946)
EdwardAngert May 21, 2025
8dfd38b
Add feature stages documentation and update script
EdwardAngert May 20, 2025
e576175
Improve docs script to avoid duplicate end markers
EdwardAngert May 21, 2025
3405d6c
Refactor feature stages to use deployment.go as source of truth
EdwardAngert May 21, 2025
509c2fb
Remove unused workdir variable in docs_update_experiments.sh
May 21, 2025
6028875
Update deployment.go and feature-stages.md for feature stages documen…
May 21, 2025
2f6a564
update documentation script to fix spacing in tables
EdwardAngert May 21, 2025
422586f
make
EdwardAngert May 21, 2025
1011f34
feat: add experimental workspace parameters page for dynamic params (…
EdwardAngert May 21, 2025
44370a7
refactor: show unhealthy status on workspace status indicator (#17956)
EdwardAngert May 21, 2025
dad7d9c
chore: replace MUI Button - 3 (#17955)
EdwardAngert May 21, 2025
a3cbf87
chore: replace MUI icons with Lucide icons - update 18 (#17958)
EdwardAngert May 21, 2025
d9d2263
fix: reduce cost of prebuild failure (#17697)
EdwardAngert May 21, 2025
becaee6
remove GetDocsPath
EdwardAngert May 21, 2025
39a2876
remove GetDocsPath comment
EdwardAngert May 21, 2025
21635c8
all beta and ea
EdwardAngert May 21, 2025
4a21d5a
chore: fix autoversion script and update experiments/docs to v2.22.1 …
EdwardAngert May 22, 2025
cb82ecc
Merge branch 'main' into update-feature-stages
EdwardAngert May 22, 2025
27ea63d
fix: resolve merge conflict in feature-stages docs
EdwardAngert May 22, 2025
144fa64
make
EdwardAngert May 22, 2025
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
docs: add prebuilds experiment
  • Loading branch information
bpmct committed May 20, 2025
commit 89144e9eece8d000c807cd1d08f355109948e8c6
94 changes: 59 additions & 35 deletions docs/install/releases/feature-stages.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ If you encounter an issue with any Coder feature, please submit a
## Feature stages

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

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

Coder may make significant changes or revert features to a feature flag at any time.
Coder may make significant changes or revert features to a feature flag at any
time.

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

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

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

- Enable all early access features:

```shell
coder server --experiments=*
```
```shell
coder server --experiments=*
```

- Enable multiple early access features:

```shell
coder server --experiments=feature1,feature2
```
```shell
coder server --experiments=feature1,feature2
```

You can also use the `CODER_EXPERIMENTS` [environment variable](../../admin/setup/index.md).
You can also use the `CODER_EXPERIMENTS`
[environment variable](../../admin/setup/index.md).

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

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

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

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

## Beta

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

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

They’re in active development and subject to minor changes.
They might contain minor bugs, but are generally ready for use.
They’re in active development and subject to minor changes. They might contain
minor bugs, but are generally ready for use.

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

We keep documentation about beta features up-to-date with the latest information, including planned features, limitations, and workarounds.
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.
While we will do our best to provide support with beta features, most issues will be escalated to the product team.
Beta features are not covered within service-level agreements (SLA).
We keep documentation about beta features up-to-date with the latest
information, including planned features, limitations, and workarounds. 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. While we will do our best to provide support with beta features, most
issues will be escalated to the product team. Beta features are not covered
within service-level agreements (SLA).

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

## General Availability (GA)

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

All features that are not explicitly tagged as `Early access` or `Beta` are considered generally available (GA).
They have been tested, are stable, and are enabled by default.
All features that are not explicitly tagged as `Early access` or `Beta` are
considered generally available (GA). They have been tested, are stable, and are
enabled by default.

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

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.
Customers with a valid Coder license, can submit a support request or contact your [account team](https://coder.com/contact).
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. Customers with a valid Coder license, can submit a support request or
contact your [account team](https://coder.com/contact).

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

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