mirror of
https://github.com/coder/coder.git
synced 2026-09-24 15:04:27 +08:00
chore(docs): fix broken or missing links (#15085)
Fixes a number of TODOs and broken links.
This commit is contained in:
@@ -12,6 +12,12 @@
|
||||
{
|
||||
"pattern": "docs.github.com"
|
||||
},
|
||||
{
|
||||
"pattern": "github.com/<your_github_handle>"
|
||||
},
|
||||
{
|
||||
"pattern": "imgur.com"
|
||||
},
|
||||
{
|
||||
"pattern": "support.google.com"
|
||||
},
|
||||
|
||||
@@ -77,7 +77,8 @@ can only be delivered to one method, and this method is configured globally with
|
||||
(default: `smtp`).
|
||||
|
||||
Enterprise customers can configure which method to use for each of the supported
|
||||
[Events](#events); see the [Preferences](#preferences) section below for more
|
||||
[Events](#workspace-events); see the
|
||||
[Preferences](#delivery-preferences-enterprise-premium) section below for more
|
||||
details.
|
||||
|
||||
## SMTP (Email)
|
||||
|
||||
@@ -94,7 +94,7 @@ coder provisioner start \
|
||||
--tag environment=kubernetes
|
||||
```
|
||||
|
||||
Note: Any user can start [user-scoped provisioners](#User-scoped-Provisioners),
|
||||
Note: Any user can start [user-scoped provisioners](#user-scoped-provisioners),
|
||||
but this will also require a template on your deployment with the corresponding
|
||||
tags.
|
||||
|
||||
|
||||
@@ -27,13 +27,13 @@ Give your template a name, description, and icon and press `Create template`.
|
||||
|
||||
> **⚠️ Note**: If template creation fails, Coder is likely not authorized to
|
||||
> deploy infrastructure in the given location. Learn how to configure
|
||||
> [provisioner authentication](#TODO).
|
||||
> [provisioner authentication](./extending-templates/provider-authentication.md).
|
||||
|
||||
### CLI
|
||||
|
||||
You can the [Coder CLI](../../install/cli.md) to manage templates for Coder.
|
||||
After [logging in](#TODO) to your deployment, create a folder to store your
|
||||
templates:
|
||||
After [logging in](../../reference/cli/login.md) to your deployment, create a
|
||||
folder to store your templates:
|
||||
|
||||
```sh
|
||||
# This snippet applies to macOS and Linux only
|
||||
|
||||
@@ -57,8 +57,9 @@ repository on
|
||||
[GitHub](https://github.com/coder/coder/tree/main/site/static/icon).
|
||||
|
||||
You can also view the entire list, with search and previews, by navigating to
|
||||
/icons on your Coder deployment. E.g. [https://coder.example.com/icons](#). This
|
||||
can be particularly useful in airgapped deployments.
|
||||
`/icons` on your Coder deployment (for example,
|
||||
`https://coder.example.com/icons`). This can be particularly useful in airgapped
|
||||
deployments.
|
||||
|
||||

|
||||
|
||||
|
||||
@@ -25,9 +25,9 @@ Then developers enter their repository URL as a
|
||||
workspace. [Envbuilder](https://github.com/coder/envbuilder) clones the repo and
|
||||
builds a container from the `devcontainer.json` specified in the repo.
|
||||
|
||||
When using the [Envbuilder Terraform provider](#provider), a previously built
|
||||
and cached image can be re-used directly, allowing instantaneous dev container
|
||||
starts.
|
||||
When using the [Envbuilder Terraform provider](#envbuilder-terraform-provider),
|
||||
a previously built and cached image can be re-used directly, allowing
|
||||
instantaneous dev container starts.
|
||||
|
||||
Developers can edit the `devcontainer.json` in their workspace to rebuild to
|
||||
iterate on their development environments.
|
||||
|
||||
@@ -58,9 +58,10 @@ terminating processes started by it or terminating the startup script itself (on
|
||||
Linux, `ps` and `kill` are useful tools).
|
||||
|
||||
For tips on how to write a startup script that doesn't run forever, see the
|
||||
[`startup_script`](#startup_script) section. For more ways to override the
|
||||
startup script behavior, see the
|
||||
[`startup_script_behavior`](#startup_script_behavior) section.
|
||||
[`startup_script`](https://registry.terraform.io/providers/coder/coder/latest/docs/resources/agent#startup_script)
|
||||
section. For more ways to override the startup script behavior, see the
|
||||
[`startup_script_behavior`](https://registry.terraform.io/providers/coder/coder/latest/docs/resources/agent#startup_script_behavior)
|
||||
section.
|
||||
|
||||
Template authors can also set the
|
||||
[startup script behavior](https://registry.terraform.io/providers/coder/coder/latest/docs/resources/agent#startup_script_behavior)
|
||||
@@ -75,9 +76,9 @@ be aware that programs, files, or settings may be missing from your workspace.
|
||||
This can happen if the
|
||||
[startup script](https://registry.terraform.io/providers/coder/coder/latest/docs/resources/agent#startup_script)
|
||||
is still running or has exited with a non-zero status (see
|
||||
[startup script error](#startup-script-error)). No action is necessary, but you
|
||||
may want to
|
||||
[start a new shell session](#session-was-started-before-the-startup-script-finished-web-terminal)
|
||||
[startup script error](#startup-script-exited-with-an-error)). No action is
|
||||
necessary, but you may want to
|
||||
[start a new shell session](#session-was-started-before-the-startup-script-finished)
|
||||
after it has completed or check the
|
||||
[startup script logs](#debugging-the-startup-script) to see if there are any
|
||||
issues.
|
||||
|
||||
@@ -4,10 +4,10 @@ Users can generate tokens to make API requests on behalf of themselves.
|
||||
|
||||
## Short-Lived Tokens (Sessions)
|
||||
|
||||
The [Coder CLI](../../install/cli.md) and [Backstage Plugin](#TODO) use
|
||||
short-lived token to authenticate. To generate a short-lived session token on
|
||||
behalf of your account, visit the following URL:
|
||||
`https://coder.example.com/cli-auth`
|
||||
The [Coder CLI](../../install/cli.md) and
|
||||
[Backstage Plugin](https://github.com/coder/backstage-plugins) use short-lived
|
||||
token to authenticate. To generate a short-lived session token on behalf of your
|
||||
account, visit the following URL: `https://coder.example.com/cli-auth`
|
||||
|
||||
### Session Durations
|
||||
|
||||
|
||||
@@ -2,7 +2,8 @@
|
||||
|
||||
You can develop in your Coder workspace remotely with
|
||||
[VSCode](https://code.visualstudio.com/download). We support connecting with the
|
||||
desktop client and VSCode in the browser with [code-server](#code-server).
|
||||
desktop client and VSCode in the browser with
|
||||
[code-server](https://github.com/coder/code-server).
|
||||
|
||||
## VSCode Desktop
|
||||
|
||||
|
||||
Reference in New Issue
Block a user