- Notifications
You must be signed in to change notification settings - Fork1.1k
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.
By clicking “Sign up for GitHub”, you agree to ourterms of service andprivacy statement. We’ll occasionally send you account related emails.
Already on GitHub?Sign in to your account
Merged
+35 −16
Merged
Changes from5 commits
Commits
Show all changes
7 commits Select commitHold shift + click to select a range
a97d027 move and edit SKirby's notes to markdown
EdwardAngert51d46e2 prettier
EdwardAngert255fb41 github issues for ea
EdwardAngert5022191 ran fmt make
EdwardAngert1dca655 add GA
EdwardAngertc25401f more generalized support copy
EdwardAngertfa88d70 make fmt
EdwardAngertFile filter
Filter by extension
Conversations
Failed to load comments.
Loading
Uh oh!
There was an error while loading.Please reload this page.
Jump to
Jump to file
Failed to load files.
Loading
Uh oh!
There was an error while loading.Please reload this page.
Diff view
Diff view
There are no files selected for viewing
49 changes: 41 additions & 8 deletionsdocs/contributing/feature-stages.md
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,21 +1,35 @@ | ||
| # Feature stages | ||
| Some Coder features are released in feature stages before they are generally | ||
| available. | ||
| ##Early access 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. | ||
| ### Early access support expectation | ||
| We recommend using [GitHub issues](https://github.com/coder/coder/issues) to | ||
| leave feedback and get support forearly access 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, | ||
| 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 | ||
| @@ -27,7 +41,11 @@ coder server --experiments=feature1,feature2 | ||
| # Alternatively, use the `CODER_EXPERIMENTS` environment variable. | ||
| ``` | ||
| ### Experimental features support expectation | ||
| Support for experimental features is available through _X_. | ||
EdwardAngert marked this conversation as resolved. OutdatedShow resolvedHide resolvedUh oh!There was an error while loading.Please reload this page. | ||
| ### Available experimental features | ||
| <!-- Code generated by scripts/release/docs_update_experiments.sh. DO NOT EDIT. --> | ||
| <!-- BEGIN: available-experimental-features --> | ||
| @@ -37,3 +55,18 @@ 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. | ||
| ### Beta features support expectation | ||
| Support for beta features is available through _X_. | ||
| ## General Availability (GA) | ||
| All other features have been tested, are stable, and are enabled by default. | ||
9 changes: 2 additions & 7 deletionsdocs/manifest.json
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.