|
| 1 | +# Feature stages |
| 2 | + |
| 3 | +Some Coder features are released in feature stages before they are generally |
| 4 | +available. |
| 5 | + |
| 6 | +If you encounter an issue with any Coder feature, please submit a |
| 7 | +[GitHub issue](https://github.com/coder/coder/issues) or join the |
| 8 | +[Coder Discord](https://discord.gg/coder). |
| 9 | + |
| 10 | +## Early access features |
| 11 | + |
| 12 | +- **Stable**: No |
| 13 | +- **Production-ready**: No |
| 14 | +- **Support**: GitHub issues |
| 15 | + |
| 16 | +Early access features are neither feature-complete nor stable. We do not |
| 17 | +recommend using early access features in production deployments. |
| 18 | + |
| 19 | +Coder often releases early access features behind an “unsafe” experiment, where |
| 20 | +they’re accessible but not easy to find. |
| 21 | +They are disabled by default, and not recommended for use in |
| 22 | +production because they might cause performance or stability issues. In most cases, |
| 23 | +early access features are mostly complete, but require further internal testing and |
| 24 | +will stay in the early access stage for at least one month. |
| 25 | + |
| 26 | +Coder may make significant changes or revert features to a feature flag at any time. |
| 27 | + |
| 28 | +If you plan to activate an early access feature, we suggest that you use a |
| 29 | +staging deployment. |
| 30 | + |
| 31 | +<details><summary>To enable early access features:</summary> |
| 32 | + |
| 33 | +Use the [Coder CLI](../install/cli.md) `--experiments` flag to enable early access features: |
| 34 | + |
| 35 | +- Enable all early access features: |
| 36 | + |
| 37 | + ```shell |
| 38 | + coder server --experiments=* |
| 39 | + ``` |
| 40 | + |
| 41 | +- Enable multiple early access features: |
| 42 | + |
| 43 | + ```shell |
| 44 | + coder server --experiments=feature1,feature2 |
| 45 | + ``` |
| 46 | + |
| 47 | +You can also use the `CODER_EXPERIMENTS` [environment variable](../admin/setup/index.md). |
| 48 | + |
| 49 | +You can opt-out of a feature after you've enabled it. |
| 50 | + |
| 51 | +</details> |
| 52 | + |
| 53 | +### Available early access features |
| 54 | + |
| 55 | +<!-- Code generated by scripts/release/docs_update_experiments.sh. DO NOT EDIT. --> |
| 56 | +<!-- BEGIN: available-experimental-features --> |
| 57 | + |
| 58 | +| Feature | Description | Available in | |
| 59 | +|-----------------|---------------------------------------------------------------------|--------------| |
| 60 | +| `notifications` | Sends notifications via SMTP and webhooks following certain events. | stable | |
| 61 | + |
| 62 | +<!-- END: available-experimental-features --> |
| 63 | + |
| 64 | +## Beta |
| 65 | + |
| 66 | +- **Stable**: No |
| 67 | +- **Production-ready**: Not fully |
| 68 | +- **Support**: Documentation, [Discord](https://discord.gg/coder), and [GitHub issues](https://github.com/coder/coder/issues) |
| 69 | + |
| 70 | +Beta features are open to the public and are tagged with a `Beta` label. |
| 71 | + |
| 72 | +They’re in active development and subject to minor changes. |
| 73 | +They might contain minor bugs, but are generally ready for use. |
| 74 | + |
| 75 | +Beta features are often ready for general availability within two-three releases. |
| 76 | +You should test beta features in staging environments. |
| 77 | +You can use beta features in production, but should set expectations and inform users that some features may be incomplete. |
| 78 | + |
| 79 | +We keep documentation about beta features up-to-date with the latest information, including planned features, limitations, and workarounds. |
| 80 | +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. |
| 81 | +While we will do our best to provide support with beta features, most issues will be escalated to the product team. |
| 82 | +Beta features are not covered within service-level agreements (SLA). |
| 83 | + |
| 84 | +Most beta features are enabled by default. |
| 85 | +Beta features are announced through the [Coder Changelog](https://coder.com/changelog), and more information is available in the documentation. |
| 86 | + |
| 87 | +## General Availability (GA) |
| 88 | + |
| 89 | +- **Stable**: Yes |
| 90 | +- **Production-ready**: Yes |
| 91 | +- **Support**: Yes, [based on license](https://coder.com/pricing). |
| 92 | + |
| 93 | +All features that are not explicitly tagged as `Early access` or `Beta` are considered generally available (GA). |
| 94 | +They have been tested, are stable, and are enabled by default. |
| 95 | + |
| 96 | +If your Coder license includes an SLA, please consult it for an outline of specific expectations. |
| 97 | + |
| 98 | +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. |
| 99 | +Customers with a valid Coder license, can submit a support request or contact your [account team](https://coder.com/contact). |
| 100 | + |
| 101 | +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. |
| 102 | +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). |
| 103 | + |
| 104 | +Some GA features can be disabled for air-gapped deployments. |
| 105 | +Consult the feature's documentation or submit a support ticket for assistance. |
0 commit comments