Skip to content

docs: feature stages #6223

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 1 commit into from
Feb 15, 2023
Merged

docs: feature stages #6223

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
25 changes: 25 additions & 0 deletions docs/contributing/feature-stages.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
# Feature stages

Some Coder features are released as Alpha or Experimental.

## Alpha features

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.

We recommend using [GitHub issues](https://github.com/coder/coder/issues) to leave feedback and get support for alpha features.

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

```yaml
# Enable all experimental features
coder server --experiments=*

# Enable multiple experimental features
coder server --experiments=feature1,feature2

# Alternatively, use the `CODER_EXPERIMENTS` environment variable.
```

Visit `https://<your-coder-url>/api/v2/experiments` to see which experimental features are available for your deployment.
5 changes: 5 additions & 0 deletions docs/manifest.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -318,6 +318,11 @@
"description": "See the code of conduct for contributing to Coder",
"path": "./contributing/CODE_OF_CONDUCT.md"
},
{
"title": "Feature stages",
"description": "Policies for Alpha and Experimental features.",
"path": "./contributing/feature-stages.md"
},
{
"title": "Documentation",
"description": "Our style guide for use when authoring documentation",
Expand Down