mirror of
https://github.com/coder/coder.git
synced 2026-09-21 20:51:01 +08:00
docs: document new feature stages (#16719)
- [x] translate notes to docs - [x] move to Home > About > Feature Stages - [x] decide on bullet point summaries (👍 👎 in comment) ### OOS for this PR add support page that describes how users can get support. currently, [this help article](https://help.coder.com/hc/en-us/articles/25308666965783-Get-Help-with-Coder) is the only thing that pops up and includes that `Users with valid Coder licenses can submit tickets` but doesn't show how, nor does it include the support bundle docs (link or content). it'd be good to have these things relate to each other ## preview [preview](https://coder.com/docs/@feature-stages/contributing/feature-stages) --------- Co-authored-by: EdwardAngert <17991901+EdwardAngert@users.noreply.github.com> Co-authored-by: Ben Potter <ben@coder.com>
This commit is contained in:
Edward Angert
co-authored by
EdwardAngert
Ben Potter
EdwardAngert
Ben Potter
parent
1cb864bc1b
commit
81ef9e9e80
@@ -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 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.
|
||||
|
||||
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.
|
||||
@@ -1,63 +0,0 @@
|
||||
# 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 issues](https://github.com/coder/coder/issues) or join the
|
||||
[Coder Discord](https://discord.gg/coder).
|
||||
|
||||
## 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.
|
||||
|
||||
## 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
|
||||
coder server --experiments=*
|
||||
|
||||
# Enable multiple experimental features
|
||||
coder server --experiments=feature1,feature2
|
||||
|
||||
# Alternatively, use the `CODER_EXPERIMENTS` environment variable.
|
||||
```
|
||||
|
||||
### Available experimental 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
|
||||
|
||||
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.
|
||||
+5
-6
@@ -16,6 +16,11 @@
|
||||
"title": "Screenshots",
|
||||
"description": "View screenshots of the Coder platform",
|
||||
"path": "./start/screenshots.md"
|
||||
},
|
||||
{
|
||||
"title": "Feature stages",
|
||||
"description": "Information about pre-GA stages.",
|
||||
"path": "./about/feature-stages.md"
|
||||
}
|
||||
]
|
||||
},
|
||||
@@ -639,12 +644,6 @@
|
||||
"path": "./contributing/CODE_OF_CONDUCT.md",
|
||||
"icon_path": "./images/icons/circle-dot.svg"
|
||||
},
|
||||
{
|
||||
"title": "Feature stages",
|
||||
"description": "Policies for Alpha and Experimental features.",
|
||||
"path": "./contributing/feature-stages.md",
|
||||
"icon_path": "./images/icons/stairs.svg"
|
||||
},
|
||||
{
|
||||
"title": "Documentation",
|
||||
"description": "Our style guide for use when authoring documentation",
|
||||
|
||||
Reference in New Issue
Block a user