diff --git a/docs/about/feature-stages.md b/docs/about/feature-stages.md new file mode 100644 index 0000000000000..f5afb78836a03 --- /dev/null +++ b/docs/about/feature-stages.md @@ -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. + +

To enable early access features:

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

+ +### Available early access features + + + + +| Feature | Description | Available in | +|-----------------|---------------------------------------------------------------------|--------------| +| `notifications` | Sends notifications via SMTP and webhooks following certain events. | stable | + + + +## 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. diff --git a/docs/contributing/feature-stages.md b/docs/contributing/feature-stages.md deleted file mode 100644 index 97b8b020a4559..0000000000000 --- a/docs/contributing/feature-stages.md +++ /dev/null @@ -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 - - - - -| Feature | Description | Available in | -|-----------------|---------------------------------------------------------------------|--------------| -| `notifications` | Sends notifications via SMTP and webhooks following certain events. | stable | - - - -## 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. diff --git a/docs/manifest.json b/docs/manifest.json index 2da08f84d6419..0dfb85096ae34 100644 --- a/docs/manifest.json +++ b/docs/manifest.json @@ -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", pFad - Phonifier reborn

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.

Alternative Proxies: