Skip to content

chore(docs): outline new feature stages #14786

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.

Sign up for GitHub

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

Merged
merged 7 commits into from
Sep 26, 2024
Merged

chore(docs): outline new feature stages #14786

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
a97d027
move and edit SKirby's notes to markdown
EdwardAngert Sep 24, 2024
51d46e2
prettier
EdwardAngert Sep 24, 2024
255fb41
github issues for ea
EdwardAngert Sep 24, 2024
5022191
ran fmt make
EdwardAngert Sep 25, 2024
1dca655
add GA
EdwardAngert Sep 25, 2024
c25401f
more generalized support copy
EdwardAngert Sep 25, 2024
fa88d70
make fmt
EdwardAngert Sep 25, 2024
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
42 changes: 33 additions & 9 deletions docs/contributing/feature-stages.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,21 +1,34 @@
# Feature stages

Some Coder features are released as Alpha or Experimental.
Some Coder features are released in feature stages before they are generally
available.

## Alpha features
If you encounter an issue with any Coder feature, please submit a
[GitHub issues](https://github.com/coder/coder/issues) or join the
[Coder Discord](https://discord.gg/coder).

Alpha features are enabled in all Coder deployments but the feature is subject
to change, or even be removed. Breaking changes may not be documented in the
changelog. In most cases, features will only stay in alpha for 1 month.
## Early access features

We recommend using [GitHub issues](https://github.com/coder/coder/issues) to
leave feedback and get support for alpha features.
Early access features are neither feature-complete nor stable. We do not
recommend using early access features in production deployments.

Coder releases early access features behind an “unsafe” experiment, where
they’re accessible but not easy to find.

## Experimental features

These features are disabled by default, and not recommended for use in
production as they may cause performance or stability issues. In most cases,
features will only stay in experimental for 1-2 weeks of internal testing.
experimental features are complete, but require further internal testing and
will stay in the experimental stage for one month.

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

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

You can opt-out of an experiment after you've enabled it.

```yaml
# Enable all experimental features
Expand All @@ -27,7 +40,7 @@ coder server --experiments=feature1,feature2
# Alternatively, use the `CODER_EXPERIMENTS` environment variable.
```

## Available experimental features
### Available experimental features

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

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

## Beta

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

They’re subject to minor changes and may contain bugs, but are generally ready
for use.

## General Availability (GA)

All other features have been tested, are stable, and are enabled by default.
9 changes: 2 additions & 7 deletions docs/manifest.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,5 @@
{
"versions": [
"main"
],
"versions": ["main"],
"routes": [
{
"title": "About",
Expand Down Expand Up @@ -410,10 +408,7 @@
"description": "Learn how to use the role based access control against templates",
"path": "./admin/rbac.md",
"icon_path": "./images/icons/rbac.svg",
"state": [
"enterprise",
"beta"
]
"state": ["enterprise", "beta"]
},
{
"title": "Configuration",
Expand Down
Loading