-
Notifications
You must be signed in to change notification settings - Fork 976
docs: document new feature stages #16719
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
Merged
Merged
Changes from 9 commits
Commits
Show all changes
10 commits
Select commit
Hold shift + click to select a range
098ada0
edit early access stage
EdwardAngert 4ec822f
copy edit EA
EdwardAngert b6d5cfd
beta section
EdwardAngert 28ea285
ga
EdwardAngert 734a0d2
typo
EdwardAngert 91743bb
ea steps to expand section
EdwardAngert a4d0b91
move feature stages to about
EdwardAngert a8ca404
edit manifest
EdwardAngert 6e82c46
rm icon for now
EdwardAngert fd85a79
Update docs/about/feature-stages.md
EdwardAngert File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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 |
---|---|---|
@@ -0,0 +1,105 @@ | ||
# Feature stages | ||
|
||
Some Coder features are released in feature stages before they are generally | ||
available. | ||
|
||
If you encounter an issue with any Coder feature, please submit a | ||
[GitHub issue](https://github.com/coder/coder/issues) or join the | ||
[Coder Discord](https://discord.gg/coder). | ||
|
||
## Early access features | ||
|
||
- **Stable**: No | ||
- **Production-ready**: No | ||
- **Support**: GitHub issues | ||
|
||
Early access features are neither feature-complete nor stable. We do not | ||
recommend using early access features in production deployments. | ||
|
||
Coder often releases early access features behind an “unsafe” experiment, where | ||
they’re accessible but not easy to find. | ||
They are disabled by default, and not recommended for use in | ||
production because they might cause performance or stability issues. In most cases, | ||
early access features are mostly complete, but require further internal testing and | ||
will stay 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. | ||
|
||
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: | ||
|
||
- Enable all early access features: | ||
|
||
```shell | ||
coder server --experiments=* | ||
``` | ||
|
||
- Enable multiple early access features: | ||
|
||
```shell | ||
coder server --experiments=feature1,feature2 | ||
``` | ||
|
||
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. | ||
|
||
</details> | ||
|
||
### Available early access features | ||
|
||
<!-- Code generated by scripts/release/docs_update_experiments.sh. DO NOT EDIT. --> | ||
<!-- BEGIN: available-experimental-features --> | ||
|
||
| Feature | Description | Available in | | ||
|-----------------|---------------------------------------------------------------------|--------------| | ||
| `notifications` | Sends notifications via SMTP and webhooks following certain events. | stable | | ||
|
||
<!-- 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) | ||
|
||
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 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. | ||
|
||
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. | ||
|
||
## 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. | ||
|
||
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). | ||
|
||
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. |
This file was deleted.
Oops, something went wrong.
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
Oops, something went wrong.
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.
Uh oh!
There was an error while loading. Please reload this page.