From 89ff48744c21a061e828c53a1aec34d66ce99722 Mon Sep 17 00:00:00 2001 From: Cian Johnston Date: Tue, 15 Oct 2024 16:50:49 +0100 Subject: [PATCH] chore(docs): fix broken or missing links (#15085) Fixes a number of TODOs and broken links. --- .github/workflows/mlc_config.json | 6 ++++++ docs/admin/monitoring/notifications/index.md | 3 ++- docs/admin/provisioners.md | 2 +- docs/admin/templates/creating-templates.md | 6 +++--- docs/admin/templates/extending-templates/icons.md | 5 +++-- .../templates/managing-templates/devcontainers.md | 6 +++--- docs/admin/templates/troubleshooting.md | 13 +++++++------ docs/admin/users/sessions-tokens.md | 8 ++++---- docs/user-guides/workspace-access/vscode.md | 3 ++- 9 files changed, 31 insertions(+), 21 deletions(-) diff --git a/.github/workflows/mlc_config.json b/.github/workflows/mlc_config.json index 4905e50e21..405f69cc86 100644 --- a/.github/workflows/mlc_config.json +++ b/.github/workflows/mlc_config.json @@ -12,6 +12,12 @@ { "pattern": "docs.github.com" }, + { + "pattern": "github.com/" + }, + { + "pattern": "imgur.com" + }, { "pattern": "support.google.com" }, diff --git a/docs/admin/monitoring/notifications/index.md b/docs/admin/monitoring/notifications/index.md index 00bf65d601..48a1d95e0b 100644 --- a/docs/admin/monitoring/notifications/index.md +++ b/docs/admin/monitoring/notifications/index.md @@ -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) diff --git a/docs/admin/provisioners.md b/docs/admin/provisioners.md index 49e3968039..5b66fdeb08 100644 --- a/docs/admin/provisioners.md +++ b/docs/admin/provisioners.md @@ -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. diff --git a/docs/admin/templates/creating-templates.md b/docs/admin/templates/creating-templates.md index f79a4d3c97..8af4391e04 100644 --- a/docs/admin/templates/creating-templates.md +++ b/docs/admin/templates/creating-templates.md @@ -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 diff --git a/docs/admin/templates/extending-templates/icons.md b/docs/admin/templates/extending-templates/icons.md index 7ae54d2916..6f9876210b 100644 --- a/docs/admin/templates/extending-templates/icons.md +++ b/docs/admin/templates/extending-templates/icons.md @@ -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. ![The icon gallery](../../../images/icons-gallery.png) diff --git a/docs/admin/templates/managing-templates/devcontainers.md b/docs/admin/templates/managing-templates/devcontainers.md index 1d23d926eb..de10582c24 100644 --- a/docs/admin/templates/managing-templates/devcontainers.md +++ b/docs/admin/templates/managing-templates/devcontainers.md @@ -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. diff --git a/docs/admin/templates/troubleshooting.md b/docs/admin/templates/troubleshooting.md index 4f5dea02b2..7c61dfaa8b 100644 --- a/docs/admin/templates/troubleshooting.md +++ b/docs/admin/templates/troubleshooting.md @@ -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. diff --git a/docs/admin/users/sessions-tokens.md b/docs/admin/users/sessions-tokens.md index de9aa8b752..dbbcfb82df 100644 --- a/docs/admin/users/sessions-tokens.md +++ b/docs/admin/users/sessions-tokens.md @@ -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 diff --git a/docs/user-guides/workspace-access/vscode.md b/docs/user-guides/workspace-access/vscode.md index 17a08d8cb7..54d3fcf9c0 100644 --- a/docs/user-guides/workspace-access/vscode.md +++ b/docs/user-guides/workspace-access/vscode.md @@ -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