Skip to content

Commit 531fd23

Browse files
authored
fix(docs): fix broken markdown links (#7081)
* fix(docs): fix markdown docs links More than half of them were actually valid links but, due to missing file extensions were flagged as invalid. I added a file extension, so it should pass now. * Updated docgen to include extension
1 parent a44070e commit 531fd23

20 files changed

+103
-106
lines changed

docs/admin/provisioners.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# External provisioners
22

3-
By default, the Coder server runs [built-in provisioner daemons](../cli/coder_server.md#provisioner-daemons), which execute `terraform` during workspace and template builds. However, there are sometimes benefits to running external provisioner daemons:
3+
By default, the Coder server runs [built-in provisioner daemons](../cli/server.md#provisioner-daemons), which execute `terraform` during workspace and template builds. However, there are sometimes benefits to running external provisioner daemons:
44

55
- **Secure build environments:** Run build jobs in isolated containers, preventing malicious templates from gaining shell access to the Coder host.
66

docs/cli.md

+33-33
Original file line numberDiff line numberDiff line change
@@ -23,39 +23,39 @@ Coder — A tool for provisioning self-hosted development environments with Terr
2323

2424
## Subcommands
2525

26-
| Name | Purpose |
27-
| --------------------------------------------------- | ---------------------------------------------------------------------- |
28-
| [<code>config-ssh</code>](./cli/config-ssh) | Add an SSH Host entry for your workspaces "ssh coder.workspace" |
29-
| [<code>create</code>](./cli/create) | Create a workspace |
30-
| [<code>delete</code>](./cli/delete) | Delete a workspace |
31-
| [<code>dotfiles</code>](./cli/dotfiles) | Personalize your workspace by applying a canonical dotfiles repository |
32-
| [<code>features</code>](./cli/features) | List Enterprise features |
33-
| [<code>groups</code>](./cli/groups) | Manage groups |
34-
| [<code>licenses</code>](./cli/licenses) | Add, delete, and list licenses |
35-
| [<code>list</code>](./cli/list) | List workspaces |
36-
| [<code>login</code>](./cli/login) | Authenticate with Coder deployment |
37-
| [<code>logout</code>](./cli/logout) | Unauthenticate your local session |
38-
| [<code>ping</code>](./cli/ping) | Ping a workspace |
39-
| [<code>port-forward</code>](./cli/port-forward) | Forward ports from machine to a workspace |
40-
| [<code>provisionerd</code>](./cli/provisionerd) | Manage provisioner daemons |
41-
| [<code>publickey</code>](./cli/publickey) | Output your Coder public key used for Git operations |
42-
| [<code>rename</code>](./cli/rename) | Rename a workspace |
43-
| [<code>reset-password</code>](./cli/reset-password) | Directly connect to the database to reset a user's password |
44-
| [<code>restart</code>](./cli/restart) | Restart a workspace |
45-
| [<code>scaletest</code>](./cli/scaletest) | Run a scale test against the Coder API |
46-
| [<code>schedule</code>](./cli/schedule) | Schedule automated start and stop times for workspaces |
47-
| [<code>server</code>](./cli/server) | Start a Coder server |
48-
| [<code>show</code>](./cli/show) | Display details of a workspace's resources and agents |
49-
| [<code>speedtest</code>](./cli/speedtest) | Run upload and download tests from your machine to a workspace |
50-
| [<code>ssh</code>](./cli/ssh) | Start a shell into a workspace |
51-
| [<code>start</code>](./cli/start) | Start a workspace |
52-
| [<code>state</code>](./cli/state) | Manually manage Terraform state to fix broken workspaces |
53-
| [<code>stop</code>](./cli/stop) | Stop a workspace |
54-
| [<code>templates</code>](./cli/templates) | Manage templates |
55-
| [<code>tokens</code>](./cli/tokens) | Manage personal access tokens |
56-
| [<code>update</code>](./cli/update) | Will update and start a given workspace if it is out of date |
57-
| [<code>users</code>](./cli/users) | Manage users |
58-
| [<code>version</code>](./cli/version) | Show coder version |
26+
| Name | Purpose |
27+
| ------------------------------------------------------ | ---------------------------------------------------------------------- |
28+
| [<code>config-ssh</code>](./cli/config-ssh.md) | Add an SSH Host entry for your workspaces "ssh coder.workspace" |
29+
| [<code>create</code>](./cli/create.md) | Create a workspace |
30+
| [<code>delete</code>](./cli/delete.md) | Delete a workspace |
31+
| [<code>dotfiles</code>](./cli/dotfiles.md) | Personalize your workspace by applying a canonical dotfiles repository |
32+
| [<code>features</code>](./cli/features.md) | List Enterprise features |
33+
| [<code>groups</code>](./cli/groups.md) | Manage groups |
34+
| [<code>licenses</code>](./cli/licenses.md) | Add, delete, and list licenses |
35+
| [<code>list</code>](./cli/list.md) | List workspaces |
36+
| [<code>login</code>](./cli/login.md) | Authenticate with Coder deployment |
37+
| [<code>logout</code>](./cli/logout.md) | Unauthenticate your local session |
38+
| [<code>ping</code>](./cli/ping.md) | Ping a workspace |
39+
| [<code>port-forward</code>](./cli/port-forward.md) | Forward ports from machine to a workspace |
40+
| [<code>provisionerd</code>](./cli/provisionerd.md) | Manage provisioner daemons |
41+
| [<code>publickey</code>](./cli/publickey.md) | Output your Coder public key used for Git operations |
42+
| [<code>rename</code>](./cli/rename.md) | Rename a workspace |
43+
| [<code>reset-password</code>](./cli/reset-password.md) | Directly connect to the database to reset a user's password |
44+
| [<code>restart</code>](./cli/restart.md) | Restart a workspace |
45+
| [<code>scaletest</code>](./cli/scaletest.md) | Run a scale test against the Coder API |
46+
| [<code>schedule</code>](./cli/schedule.md) | Schedule automated start and stop times for workspaces |
47+
| [<code>server</code>](./cli/server.md) | Start a Coder server |
48+
| [<code>show</code>](./cli/show.md) | Display details of a workspace's resources and agents |
49+
| [<code>speedtest</code>](./cli/speedtest.md) | Run upload and download tests from your machine to a workspace |
50+
| [<code>ssh</code>](./cli/ssh.md) | Start a shell into a workspace |
51+
| [<code>start</code>](./cli/start.md) | Start a workspace |
52+
| [<code>state</code>](./cli/state.md) | Manually manage Terraform state to fix broken workspaces |
53+
| [<code>stop</code>](./cli/stop.md) | Stop a workspace |
54+
| [<code>templates</code>](./cli/templates.md) | Manage templates |
55+
| [<code>tokens</code>](./cli/tokens.md) | Manage personal access tokens |
56+
| [<code>update</code>](./cli/update.md) | Will update and start a given workspace if it is out of date |
57+
| [<code>users</code>](./cli/users.md) | Manage users |
58+
| [<code>version</code>](./cli/version.md) | Show coder version |
5959

6060
## Options
6161

docs/cli/features.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,6 @@ coder features
1616

1717
## Subcommands
1818

19-
| Name | Purpose |
20-
| ------------------------------------ | ------- |
21-
| [<code>list</code>](./features_list) | |
19+
| Name | Purpose |
20+
| --------------------------------------- | ------- |
21+
| [<code>list</code>](./features_list.md) | |

docs/cli/groups.md

+6-6
Original file line numberDiff line numberDiff line change
@@ -16,9 +16,9 @@ coder groups
1616

1717
## Subcommands
1818

19-
| Name | Purpose |
20-
| -------------------------------------- | ------------------- |
21-
| [<code>create</code>](./groups_create) | Create a user group |
22-
| [<code>delete</code>](./groups_delete) | Delete a user group |
23-
| [<code>edit</code>](./groups_edit) | Edit a user group |
24-
| [<code>list</code>](./groups_list) | List user groups |
19+
| Name | Purpose |
20+
| ----------------------------------------- | ------------------- |
21+
| [<code>create</code>](./groups_create.md) | Create a user group |
22+
| [<code>delete</code>](./groups_delete.md) | Delete a user group |
23+
| [<code>edit</code>](./groups_edit.md) | Edit a user group |
24+
| [<code>list</code>](./groups_list.md) | List user groups |

docs/cli/licenses.md

+5-5
Original file line numberDiff line numberDiff line change
@@ -16,8 +16,8 @@ coder licenses
1616

1717
## Subcommands
1818

19-
| Name | Purpose |
20-
| ---------------------------------------- | --------------------------------- |
21-
| [<code>add</code>](./licenses_add) | Add license to Coder deployment |
22-
| [<code>delete</code>](./licenses_delete) | Delete license by ID |
23-
| [<code>list</code>](./licenses_list) | List licenses (including expired) |
19+
| Name | Purpose |
20+
| ------------------------------------------- | --------------------------------- |
21+
| [<code>add</code>](./licenses_add.md) | Add license to Coder deployment |
22+
| [<code>delete</code>](./licenses_delete.md) | Delete license by ID |
23+
| [<code>list</code>](./licenses_list.md) | List licenses (including expired) |

docs/cli/provisionerd.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,6 @@ coder provisionerd
1212

1313
## Subcommands
1414

15-
| Name | Purpose |
16-
| ------------------------------------------ | ------------------------ |
17-
| [<code>start</code>](./provisionerd_start) | Run a provisioner daemon |
15+
| Name | Purpose |
16+
| --------------------------------------------- | ------------------------ |
17+
| [<code>start</code>](./provisionerd_start.md) | Run a provisioner daemon |

docs/cli/scaletest.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ coder scaletest
1212

1313
## Subcommands
1414

15-
| Name | Purpose |
16-
| --------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
17-
| [<code>cleanup</code>](./scaletest_cleanup) | Cleanup scaletest workspaces, then cleanup scaletest users. |
18-
| [<code>create-workspaces</code>](./scaletest_create-workspaces) | Creates many users, then creates a workspace for each user and waits for them finish building and fully come online. Optionally runs a command inside each workspace, and connects to the workspace over WireGuard. |
15+
| Name | Purpose |
16+
| ------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
17+
| [<code>cleanup</code>](./scaletest_cleanup.md) | Cleanup scaletest workspaces, then cleanup scaletest users. |
18+
| [<code>create-workspaces</code>](./scaletest_create-workspaces.md) | Creates many users, then creates a workspace for each user and waits for them finish building and fully come online. Optionally runs a command inside each workspace, and connects to the workspace over WireGuard. |

docs/cli/schedule.md

+6-6
Original file line numberDiff line numberDiff line change
@@ -12,9 +12,9 @@ coder schedule { show | start | stop | override } <workspace>
1212

1313
## Subcommands
1414

15-
| Name | Purpose |
16-
| ------------------------------------------------------ | ----------------------------------------------------------------- |
17-
| [<code>override-stop</code>](./schedule_override-stop) | Override the stop time of a currently running workspace instance. |
18-
| [<code>show</code>](./schedule_show) | Show workspace schedule |
19-
| [<code>start</code>](./schedule_start) | Edit workspace start schedule |
20-
| [<code>stop</code>](./schedule_stop) | Edit workspace stop schedule |
15+
| Name | Purpose |
16+
| --------------------------------------------------------- | ----------------------------------------------------------------- |
17+
| [<code>override-stop</code>](./schedule_override-stop.md) | Override the stop time of a currently running workspace instance. |
18+
| [<code>show</code>](./schedule_show.md) | Show workspace schedule |
19+
| [<code>start</code>](./schedule_start.md) | Edit workspace start schedule |
20+
| [<code>stop</code>](./schedule_stop.md) | Edit workspace stop schedule |

docs/cli/server.md

+5-5
Original file line numberDiff line numberDiff line change
@@ -12,11 +12,11 @@ coder server [flags]
1212

1313
## Subcommands
1414

15-
| Name | Purpose |
16-
| ---------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------ |
17-
| [<code>create-admin-user</code>](./server_create-admin-user) | Create a new admin user with the given username, email and password and adds it to every organization. |
18-
| [<code>postgres-builtin-serve</code>](./server_postgres-builtin-serve) | Run the built-in PostgreSQL deployment. |
19-
| [<code>postgres-builtin-url</code>](./server_postgres-builtin-url) | Output the connection URL for the built-in PostgreSQL deployment. |
15+
| Name | Purpose |
16+
| ------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------ |
17+
| [<code>create-admin-user</code>](./server_create-admin-user.md) | Create a new admin user with the given username, email and password and adds it to every organization. |
18+
| [<code>postgres-builtin-serve</code>](./server_postgres-builtin-serve.md) | Run the built-in PostgreSQL deployment. |
19+
| [<code>postgres-builtin-url</code>](./server_postgres-builtin-url.md) | Output the connection URL for the built-in PostgreSQL deployment. |
2020

2121
## Options
2222

docs/cli/state.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ coder state
1212

1313
## Subcommands
1414

15-
| Name | Purpose |
16-
| --------------------------------- | --------------------------------------------- |
17-
| [<code>pull</code>](./state_pull) | Pull a Terraform state file from a workspace. |
18-
| [<code>push</code>](./state_push) | Push a Terraform state file to a workspace. |
15+
| Name | Purpose |
16+
| ------------------------------------ | --------------------------------------------- |
17+
| [<code>pull</code>](./state_pull.md) | Pull a Terraform state file from a workspace. |
18+
| [<code>push</code>](./state_push.md) | Push a Terraform state file to a workspace. |

0 commit comments

Comments
 (0)