mirror of
https://github.com/coder/coder.git
synced 2026-09-22 05:05:20 +08:00
chore(docs): correct broken links in restructure (#14989)
Co-authored-by: Muhammad Atif Ali <atif@coder.com>
This commit is contained in:
Stephen Kirby
co-authored by
Muhammad Atif Ali
Muhammad Atif Ali
parent
163f96b71a
commit
9eefd2a636
@@ -247,10 +247,12 @@ be applied selectively or to discourage anyone from contributing.
|
||||
|
||||
## Releases
|
||||
|
||||
Coder releases are initiated via [`./scripts/release.sh`](../scripts/release.sh)
|
||||
Coder releases are initiated via
|
||||
[`./scripts/release.sh`](https://github.com/coder/coder/blob/main/scripts/release.sh)
|
||||
and automated via GitHub Actions. Specifically, the
|
||||
[`release.yaml`](../.github/workflows/release.yaml) workflow. They are created
|
||||
based on the current [`main`](https://github.com/coder/coder/tree/main) branch.
|
||||
[`release.yaml`](https://github.com/coder/coder/blob/main/.github/workflows/release.yaml)
|
||||
workflow. They are created based on the current
|
||||
[`main`](https://github.com/coder/coder/tree/main) branch.
|
||||
|
||||
The release notes for a release are automatically generated from commit titles
|
||||
and metadata from PRs that are merged into `main`.
|
||||
@@ -258,9 +260,10 @@ and metadata from PRs that are merged into `main`.
|
||||
### Creating a release
|
||||
|
||||
The creation of a release is initiated via
|
||||
[`./scripts/release.sh`](../scripts/release.sh). This script will show a preview
|
||||
of the release that will be created, and if you choose to continue, create and
|
||||
push the tag which will trigger the creation of the release via GitHub Actions.
|
||||
[`./scripts/release.sh`](https://github.com/coder/coder/blob/main/scripts/release.sh).
|
||||
This script will show a preview of the release that will be created, and if you
|
||||
choose to continue, create and push the tag which will trigger the creation of
|
||||
the release via GitHub Actions.
|
||||
|
||||
See `./scripts/release.sh --help` for more information.
|
||||
|
||||
|
||||
@@ -324,7 +324,8 @@ could affect workspace users experience once the platform is live.
|
||||
|
||||
### Helm Chart Configuration
|
||||
|
||||
1. Reference our [Helm chart values file](../../../../helm/coder/values.yaml)
|
||||
1. Reference our
|
||||
[Helm chart values file](https://github.com/coder/coder/blob/main/helm/coder/values.yaml)
|
||||
and identify the required values for deployment.
|
||||
1. Create a `values.yaml` and add it to your version control system.
|
||||
1. Determine the necessary environment variables. Here is the
|
||||
|
||||
@@ -2,7 +2,7 @@
|
||||
|
||||
<blockquote class="info">
|
||||
This article explains how to use secrets in a workspace. To authenticate the
|
||||
workspace provisioner, see <a href="/admin/auth">this</a>.
|
||||
workspace provisioner, see <a href="../users">this</a>.
|
||||
</blockquote>
|
||||
|
||||
Coder is open-minded about how you get your secrets into your workspaces.
|
||||
|
||||
@@ -59,11 +59,7 @@ If you are providing TLS certificates directly to the Coder server, either
|
||||
|
||||
The Coder server can directly use TLS certificates with `CODER_TLS_ENABLE` and
|
||||
accompanying configuration flags. However, Coder can also run behind a
|
||||
reverse-proxy to terminate TLS certificates from LetsEncrypt, for example.
|
||||
|
||||
- [Apache](./web-server/apache/index.md)
|
||||
- [Caddy](./web-server/caddy/index.md)
|
||||
- [NGINX](./web-server/nginx/index.md)
|
||||
reverse-proxy to terminate TLS certificates from LetsEncrypt.
|
||||
|
||||
### Kubernetes TLS configuration
|
||||
|
||||
|
||||
@@ -61,7 +61,7 @@ In offline and restricted deploymnets, there are 2 ways to fetch modules.
|
||||
|
||||
### Artifactory
|
||||
|
||||
Air gapped users can clone the [coder/modules](htpps://github.com/coder/modules)
|
||||
Air gapped users can clone the [coder/modules](https://github.com/coder/modules)
|
||||
repo and publish a
|
||||
[local terraform module repository](https://jfrog.com/help/r/jfrog-artifactory-documentation/set-up-a-terraform-module/provider-registry)
|
||||
to resolve modules via [Artifactory](https://jfrog.com/artifactory/).
|
||||
|
||||
@@ -82,7 +82,7 @@ creating VM-based workspaces.
|
||||
|
||||
|
||||
|
||||
## Next steps
|
||||
### Next steps
|
||||
|
||||
- [IDEs with Coder](../../user-guides/workspace-access/index.md)
|
||||
- [Writing custom templates for Coder](../../admin/templates/index.md)
|
||||
|
||||
@@ -62,7 +62,7 @@ To log in to an existing Coder deployment:
|
||||
coder login https://coder.example.com
|
||||
```
|
||||
|
||||
## Next up
|
||||
## Next steps
|
||||
|
||||
- [Create your first template](../start/first-template.md)
|
||||
- [Set up your first deployment](../start/coder-tour.md)
|
||||
- [Expose your control plane to other users](../admin/setup/index.md)
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
# Install Coder on Kubernetes
|
||||
|
||||
You can install Coder on Kubernetes using Helm. We run on most Kubernetes
|
||||
distributions, including [OpenShift](./other/openshift.md).
|
||||
distributions, including [OpenShift](./other.md).
|
||||
|
||||
## Requirements
|
||||
|
||||
|
||||
@@ -14,7 +14,7 @@ environments. However, some changes to your configuration are necessary.
|
||||
| DERP | By default, Coder's built-in DERP relay can be used, or [Tailscale's public relays](../admin/networking/index.md#relayed-connections). | By default, Coder's built-in DERP relay can be used, or [custom relays](../admin/networking/index.md#custom-relays). |
|
||||
| PostgreSQL | If no [PostgreSQL connection URL](../reference/cli/server.md#--postgres-url) is specified, Coder will download Postgres from [repo1.maven.org](https://repo1.maven.org) | An external database is required, you must specify a [PostgreSQL connection URL](../reference/cli/server.md#--postgres-url) |
|
||||
| Telemetry | Telemetry is on by default, and [can be disabled](../reference/cli/server.md#--telemetry) | Telemetry [can be disabled](../reference/cli/server.md#--telemetry) |
|
||||
| Update check | By default, Coder checks for updates from [GitHub releases](https:/github.com/coder/coder/releases) | Update checks [can be disabled](../reference/cli/server.md#--update-check) |
|
||||
| Update check | By default, Coder checks for updates from [GitHub releases](https://github.com/coder/coder/releases) | Update checks [can be disabled](../reference/cli/server.md#--update-check) |
|
||||
|
||||
## Offline container images
|
||||
|
||||
|
||||
+6
-1
@@ -100,7 +100,7 @@
|
||||
"title": "Releases",
|
||||
"description": "Learn about the Coder release channels and schedule",
|
||||
"path": "./install/releases.md",
|
||||
"icon_path": "./images/icons/trash.svg"
|
||||
"icon_path": "./images/icons/star.svg"
|
||||
}
|
||||
]
|
||||
},
|
||||
@@ -145,6 +145,11 @@
|
||||
"title": "Filebrowser",
|
||||
"description": "Access your workspace files",
|
||||
"path": "./user-guides/workspace-access/filebrowser.md"
|
||||
},
|
||||
{
|
||||
"title": "Web IDEs and Coder Apps",
|
||||
"description": "Access your workspace with IDEs in the browser",
|
||||
"path": "./user-guides/workspace-access/web-ides.md"
|
||||
}
|
||||
]
|
||||
},
|
||||
|
||||
@@ -40,7 +40,7 @@ manually setting up an SSH connection.
|
||||
|
||||
|
||||
|
||||
1. Enter your Coder deployment'ssetup/index.md
|
||||
1. Enter your Coder deployment's
|
||||
[Access Url](../../admin/setup/index.md#access-url) and click **Connect**.
|
||||
|
||||
Gateway opens your Coder deployment's `cli-auth` page with a session token.
|
||||
|
||||
Reference in New Issue
Block a user