docs: document new feature stages #16719
Conversation
|
how do y'all fee about having a bullet-pointed summary to start each section?
|
There was a problem hiding this comment.
Looks great. A couple of thoughts and I know this is early feedback:
- What do you think about explicitly mentioning which features are in which stage? I don't think this could/should be automated yet (like how we manually change beta labels) but something we should be sure to check before cutting a new release.
- Thoughts on representing this as a table?
- LOVE moving it to "About"
docs/contributing/feature-stages.md
Outdated
| @@ -9,37 +9,37 @@ If you encounter an issue with any Coder feature, please submit a | |||
|
|
|||
| ## Early access features | |||
|
|
|||
| - **Stable**: No | |||
| - **Production-ready**: No | |||
| - **Support**: GitHub issues | |||
There was a problem hiding this comment.
Can you also mention or "via design partnerships. Contact your account team" or similar. Or do you think this would be implied?
There was a problem hiding this comment.
| - **Support**: GitHub issues | |
| - **Support**: GitHub issues or your [Coder account team](https://coder.com/contact) |
I'm not familiar with the term design partnerships - is it easier if we say something like Feedback and issues through your [Coder account team](https://coder.com/contact) ?
docs/contributing/feature-stages.md
Outdated
| - **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 releases early access features behind an “unsafe” experiment, where |
There was a problem hiding this comment.
| Coder releases early access features behind an “unsafe” experiment, where | |
| Coder often releases early access features behind an “unsafe” experiment, where |
We also sometimes have early access via separate executable which is opt-in, such as the Coder Desktop binary or a module/helm install. So it is not exclusively coupled to experiments
|
docs/contributing/feature-stages.md
Outdated
| @@ -53,11 +53,31 @@ coder server --experiments=feature1,feature2 | |||
|
|
|||
| ## Beta | |||
|
|
|||
| Beta features are open to the public, but are tagged with a `Beta` label. | |||
| - **Stable**: No | |||
| - **Production-ready**: Not fully | |||
There was a problem hiding this comment.
| - **Production-ready**: Not fully | |
| - **Production-ready**: Yes. Might not be feature-complete. |
Co-authored-by: Ben Potter <ben@coder.com>
OOS for this PR
add support page that describes how users can get support. currently, this help article is the only thing that pops up and includes that
Users with valid Coder licenses can submit ticketsbut 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 otherpreview
preview