mirror of
https://github.com/coder/coder.git
synced 2025-07-13 21:36:50 +00:00
chore(docs): move feature stage docs to install directory (#17199)
I think the feature stages page should be co-located with releases and not at the entrance of the docs. [preview](https://coder.com/docs/@move-feature-stages/install/releases/feature-stages) --------- Co-authored-by: EdwardAngert <17991901+EdwardAngert@users.noreply.github.com>
This commit is contained in:
Stephen Kirby
GitHub
@ -278,7 +278,7 @@ troubleshoot:
|
||||
`CODER_VERBOSE=true` or `--verbose` to output debug logs.
|
||||
1. If you are on version 2.15.x, notifications must be enabled using the
|
||||
`notifications`
|
||||
[experiment](../../../about/feature-stages.md#early-access-features).
|
||||
[experiment](../../../install/releases/feature-stages.md#early-access-features).
|
||||
|
||||
Notifications are enabled by default in Coder v2.16.0 and later.
|
||||
|
||||
|
||||
@ -16,7 +16,7 @@
|
||||
> previously necessary to activate this additional feature.
|
||||
|
||||
- Our scale test CLI is
|
||||
[experimental](https://coder.com/docs/about/feature-stages.md#early-access-features)
|
||||
[experimental](https://coder.com/docs/install/releases/feature-stages#early-access-features)
|
||||
to allow for rapid iteration. You can still interact with it via
|
||||
`coder exp scaletest` (#8339)
|
||||
|
||||
|
||||
@ -1,7 +1,7 @@
|
||||
## Changelog
|
||||
|
||||
> [!NOTE]
|
||||
> This is a mainline Coder release. We advise enterprise customers without a staging environment to install our [latest stable release](https://github.com/coder/coder/releases/latest) while we refine this version. Learn more about our [Release Schedule](../install/releases.md).
|
||||
> This is a mainline Coder release. We advise enterprise customers without a staging environment to install our [latest stable release](https://github.com/coder/coder/releases/latest) while we refine this version. Learn more about our [Release Schedule](../install/releases/index.md).
|
||||
|
||||
### BREAKING CHANGES
|
||||
|
||||
|
||||
@ -61,7 +61,7 @@
|
||||
|
||||
### Experimental features
|
||||
|
||||
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).
|
||||
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/install/releases/feature-stages#early-access-features).
|
||||
|
||||
- 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)
|
||||
- Port sharing: Allow users to share ports running in their workspace with other Coder users (#11939) (#12119) (#12383) (@deansheather) (@f0ssel)
|
||||
|
||||
@ -3,7 +3,7 @@
|
||||
A single CLI (`coder`) is used for both the Coder server and the client.
|
||||
|
||||
We support two release channels: mainline and stable - read the
|
||||
[Releases](./releases.md) page to learn more about which best suits your team.
|
||||
[Releases](./releases/index.md) page to learn more about which best suits your team.
|
||||
|
||||
## Download the latest release from GitHub
|
||||
|
||||
|
||||
@ -3,7 +3,7 @@
|
||||
A single CLI (`coder`) is used for both the Coder server and the client.
|
||||
|
||||
We support two release channels: mainline and stable - read the
|
||||
[Releases](./releases.md) page to learn more about which best suits your team.
|
||||
[Releases](./releases/index.md) page to learn more about which best suits your team.
|
||||
|
||||
There are several ways to install Coder. Follow the steps on this page for a
|
||||
minimal installation of Coder, or for a step-by-step guide on how to install and
|
||||
|
||||
@ -123,7 +123,7 @@ details on the values that are available, or you can view the
|
||||
file directly.
|
||||
|
||||
We support two release channels: mainline and stable - read the
|
||||
[Releases](./releases.md) page to learn more about which best suits your team.
|
||||
[Releases](./releases/index.md) page to learn more about which best suits your team.
|
||||
|
||||
- **Mainline** Coder release:
|
||||
|
||||
|
||||
@ -136,7 +136,7 @@ kubectl create secret generic coder-db-url -n coder \
|
||||
- **Mainline**: `2.20.x`
|
||||
- **Stable**: `2.19.x`
|
||||
|
||||
Learn more about release channels in the [Releases documentation](./releases.md).
|
||||
Learn more about release channels in the [Releases documentation](./releases/index.md).
|
||||
|
||||
1. Select **Next** when your configuration is complete.
|
||||
|
||||
|
||||
@ -35,7 +35,7 @@ staging deployment.
|
||||
|
||||
<details><summary>To enable early access features:</summary>
|
||||
|
||||
Use the [Coder CLI](../install/cli.md) `--experiments` flag to enable early access features:
|
||||
Use the [Coder CLI](../../install/cli.md) `--experiments` flag to enable early access features:
|
||||
|
||||
- Enable all early access features:
|
||||
|
||||
@ -49,7 +49,7 @@ Use the [Coder CLI](../install/cli.md) `--experiments` flag to enable early acce
|
||||
coder server --experiments=feature1,feature2
|
||||
```
|
||||
|
||||
You can also use the `CODER_EXPERIMENTS` [environment variable](../admin/setup/index.md).
|
||||
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.
|
||||
|
||||
@ -101,7 +101,7 @@ If your Coder license includes an SLA, please consult it for an outline of speci
|
||||
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.
|
||||
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.
|
||||
@ -35,7 +35,7 @@ only for security issues or CVEs.
|
||||
- In-product security vulnerabilities and CVEs are supported
|
||||
|
||||
For more information on feature rollout, see our
|
||||
[feature stages documentation](../about/feature-stages.md).
|
||||
[feature stages documentation](../releases/feature-stages.md).
|
||||
|
||||
## Installing stable
|
||||
|
||||
@ -49,7 +49,7 @@ latest stable release:
|
||||
curl -fsSL https://coder.com/install.sh | sh -s -- --stable
|
||||
```
|
||||
|
||||
Best practices for installing Coder can be found on our [install](./index.md)
|
||||
Best practices for installing Coder can be found on our [install](../index.md)
|
||||
pages.
|
||||
|
||||
## Release schedule
|
||||
@ -16,11 +16,6 @@
|
||||
"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"
|
||||
}
|
||||
]
|
||||
},
|
||||
@ -110,8 +105,15 @@
|
||||
{
|
||||
"title": "Releases",
|
||||
"description": "Learn about the Coder release channels and schedule",
|
||||
"path": "./install/releases.md",
|
||||
"icon_path": "./images/icons/star.svg"
|
||||
"path": "./install/releases/index.md",
|
||||
"icon_path": "./images/icons/star.svg",
|
||||
"children": [
|
||||
{
|
||||
"title": "Feature stages",
|
||||
"description": "Information about pre-GA stages.",
|
||||
"path": "./install/releases/feature-stages.md"
|
||||
}
|
||||
]
|
||||
}
|
||||
]
|
||||
},
|
||||
|
||||
@ -94,7 +94,7 @@ parse_experiments() {
|
||||
}
|
||||
|
||||
workdir=build/docs/experiments
|
||||
dest=docs/about/feature-stages.md
|
||||
dest=docs/install/releases/feature-stages.md
|
||||
|
||||
log "Updating available experimental features in ${dest}"
|
||||
|
||||
|
||||
@ -61,7 +61,7 @@ export const FeatureStageBadge: FC<FeatureStageBadgeProps> = ({
|
||||
</p>
|
||||
|
||||
<Link
|
||||
href={docs("/about/feature-stages")}
|
||||
href={docs("/install/releases/feature-stages")}
|
||||
target="_blank"
|
||||
rel="noreferrer"
|
||||
css={styles.tooltipLink}
|
||||
|
||||
Reference in New Issue
Block a user