Skip to content

Commit 7bada4b

Browse files
EdwardAngertEdwardAngert
committed
Merge remote-tracking branch 'origin/main' into 16475-workspace-presets
2 parents e82afb3 + b3d6755 commit 7bada4b

File tree

12 files changed

+131
-82
lines changed

12 files changed

+131
-82
lines changed

‎cli/exp_rpty_test.go

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -87,6 +87,11 @@ func TestExpRpty(t *testing.T) {
8787
require.NoError(t, err, "Could not stop container")
8888
})
8989

90+
_ = agenttest.New(t, client.URL, agentToken, func(o *agent.Options) {
91+
o.ExperimentalContainersEnabled = true
92+
})
93+
_ = coderdtest.NewWorkspaceAgentWaiter(t, client, workspace.ID).Wait()
94+
9095
inv, root := clitest.New(t, "exp", "rpty", workspace.Name, "-c", ct.Container.ID)
9196
clitest.SetupConfig(t, client, root)
9297
pty := ptytest.New(t).Attach(inv)
@@ -96,11 +101,6 @@ func TestExpRpty(t *testing.T) {
96101
assert.NoError(t, err)
97102
})
98103

99-
_ = agenttest.New(t, client.URL, agentToken, func(o *agent.Options) {
100-
o.ExperimentalContainersEnabled = true
101-
})
102-
_ = coderdtest.NewWorkspaceAgentWaiter(t, client, workspace.ID).Wait()
103-
104104
pty.ExpectMatch(fmt.Sprintf("Connected to %s", workspace.Name))
105105
pty.ExpectMatch("Reconnect ID: ")
106106
pty.ExpectMatch(" #")

‎docs/about/feature-stages.md

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

‎docs/admin/monitoring/notifications/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -269,7 +269,7 @@ troubleshoot:
269269
`CODER_VERBOSE=true` or `--verbose` to output debug logs.
270270
1. If you are on version 2.15.x, notifications must be enabled using the
271271
`notifications`
272-
[experiment](../../../contributing/feature-stages.md#experimental-features).
272+
[experiment](../../../about/feature-stages.md#early-access-features).
273273

274274
Notifications are enabled by default in Coder v2.16.0 and later.
275275

‎docs/changelogs/v0.26.0.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@
1616
> previously necessary to activate this additional feature.
1717
1818
- Our scale test CLI is
19-
[experimental](https://coder.com/docs/contributing/feature-stages#experimental-features)
19+
[experimental](https://coder.com/docs/about/feature-stages.md#early-access-features)
2020
to allow for rapid iteration. You can still interact with it via
2121
`coder exp scaletest` (#8339)
2222

‎docs/changelogs/v2.9.0.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -61,7 +61,7 @@
6161

6262
### Experimental features
6363

64-
The following features are hidden or disabled by default as we don't guarantee stability. Learn more about experiments in [our documentation](https://coder.com/docs/contributing/feature-stages#experimental-features).
64+
The following features are hidden or disabled by default as we don't guarantee stability. Learn more about experiments in [our documentation](https://coder.com/docs/about/feature-stages.md#early-access-features).
6565

6666
- The `coder support` command generates a ZIP with deployment information, agent logs, and server config values for troubleshooting purposes. We will publish documentation on how it works (and un-hide the feature) in a future release (#12328) (@johnstcn)
6767
- Port sharing: Allow users to share ports running in their workspace with other Coder users (#11939) (#12119) (#12383) (@deansheather) (@f0ssel)

‎docs/contributing/feature-stages.md

Lines changed: 0 additions & 63 deletions
This file was deleted.

‎docs/install/releases.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ only for security issues or CVEs.
3535
- In-product security vulnerabilities and CVEs are supported
3636

3737
> For more information on feature rollout, see our
38-
> [feature stages documentation](../contributing/feature-stages.md).
38+
> [feature stages documentation](../about/feature-stages.md).
3939
4040
## Installing stable
4141

‎docs/manifest.json

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,11 @@
1616
"title": "Screenshots",
1717
"description": "View screenshots of the Coder platform",
1818
"path": "./start/screenshots.md"
19+
},
20+
{
21+
"title": "Feature stages",
22+
"description": "Information about pre-GA stages.",
23+
"path": "./about/feature-stages.md"
1924
}
2025
]
2126
},
@@ -639,12 +644,6 @@
639644
"path": "./contributing/CODE_OF_CONDUCT.md",
640645
"icon_path": "./images/icons/circle-dot.svg"
641646
},
642-
{
643-
"title": "Feature stages",
644-
"description": "Policies for Alpha and Experimental features.",
645-
"path": "./contributing/feature-stages.md",
646-
"icon_path": "./images/icons/stairs.svg"
647-
},
648647
{
649648
"title": "Documentation",
650649
"description": "Our style guide for use when authoring documentation",

‎scripts/release/docs_update_experiments.sh

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -94,7 +94,7 @@ parse_experiments() {
9494
}
9595

9696
workdir=build/docs/experiments
97-
dest=docs/contributing/feature-stages.md
97+
dest=docs/about/feature-stages.md
9898

9999
log "Updating available experimental features in ${dest}"
100100

‎site/src/components/FeatureStageBadge/FeatureStageBadge.tsx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -61,7 +61,7 @@ export const FeatureStageBadge: FC<FeatureStageBadgeProps> = ({
6161
</p>
6262

6363
<Link
64-
href={docs("/contributing/feature-stages")}
64+
href={docs("/about/feature-stages")}
6565
target="_blank"
6666
rel="noreferrer"
6767
css={styles.tooltipLink}

0 commit comments

Comments
 (0)