Skip to content

fix(docs): fix broken markdown links #7081

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Apr 11, 2023
Merged

fix(docs): fix broken markdown links #7081

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
0f44b8b
fix(docs): fix markdown docs links
matifali Apr 11, 2023
a0477de
Updated docgen to include extension
matifali Apr 11, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Next Next commit
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.
  • Loading branch information
@matifali
matifali committed Apr 11, 2023
commit 0f44b8bb3693eae9f09c48f508d126d935fdf896
2 changes: 1 addition & 1 deletion docs/admin/provisioners.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# External provisioners

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:
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:

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

Expand Down
66 changes: 33 additions & 33 deletions docs/cli.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,39 +23,39 @@ Coder — A tool for provisioning self-hosted development environments with Terr

## Subcommands

| Name | Purpose |
| --------------------------------------------------- | ---------------------------------------------------------------------- |
| [<code>config-ssh</code>](./cli/config-ssh) | Add an SSH Host entry for your workspaces "ssh coder.workspace" |
| [<code>create</code>](./cli/create) | Create a workspace |
| [<code>delete</code>](./cli/delete) | Delete a workspace |
| [<code>dotfiles</code>](./cli/dotfiles) | Personalize your workspace by applying a canonical dotfiles repository |
| [<code>features</code>](./cli/features) | List Enterprise features |
| [<code>groups</code>](./cli/groups) | Manage groups |
| [<code>licenses</code>](./cli/licenses) | Add, delete, and list licenses |
| [<code>list</code>](./cli/list) | List workspaces |
| [<code>login</code>](./cli/login) | Authenticate with Coder deployment |
| [<code>logout</code>](./cli/logout) | Unauthenticate your local session |
| [<code>ping</code>](./cli/ping) | Ping a workspace |
| [<code>port-forward</code>](./cli/port-forward) | Forward ports from machine to a workspace |
| [<code>provisionerd</code>](./cli/provisionerd) | Manage provisioner daemons |
| [<code>publickey</code>](./cli/publickey) | Output your Coder public key used for Git operations |
| [<code>rename</code>](./cli/rename) | Rename a workspace |
| [<code>reset-password</code>](./cli/reset-password) | Directly connect to the database to reset a user's password |
| [<code>restart</code>](./cli/restart) | Restart a workspace |
| [<code>scaletest</code>](./cli/scaletest) | Run a scale test against the Coder API |
| [<code>schedule</code>](./cli/schedule) | Schedule automated start and stop times for workspaces |
| [<code>server</code>](./cli/server) | Start a Coder server |
| [<code>show</code>](./cli/show) | Display details of a workspace's resources and agents |
| [<code>speedtest</code>](./cli/speedtest) | Run upload and download tests from your machine to a workspace |
| [<code>ssh</code>](./cli/ssh) | Start a shell into a workspace |
| [<code>start</code>](./cli/start) | Start a workspace |
| [<code>state</code>](./cli/state) | Manually manage Terraform state to fix broken workspaces |
| [<code>stop</code>](./cli/stop) | Stop a workspace |
| [<code>templates</code>](./cli/templates) | Manage templates |
| [<code>tokens</code>](./cli/tokens) | Manage personal access tokens |
| [<code>update</code>](./cli/update) | Will update and start a given workspace if it is out of date |
| [<code>users</code>](./cli/users) | Manage users |
| [<code>version</code>](./cli/version) | Show coder version |
| Name | Purpose |
| ------------------------------------------------------ | ---------------------------------------------------------------------- |
| [<code>config-ssh</code>](./cli/config-ssh.md) | Add an SSH Host entry for your workspaces "ssh coder.workspace" |
| [<code>create</code>](./cli/create.md) | Create a workspace |
| [<code>delete</code>](./cli/delete.md) | Delete a workspace |
| [<code>dotfiles</code>](./cli/dotfiles.md) | Personalize your workspace by applying a canonical dotfiles repository |
| [<code>features</code>](./cli/features.md) | List Enterprise features |
| [<code>groups</code>](./cli/groups.md) | Manage groups |
| [<code>licenses</code>](./cli/licenses.md) | Add, delete, and list licenses |
| [<code>list</code>](./cli/list.md) | List workspaces |
| [<code>login</code>](./cli/login.md) | Authenticate with Coder deployment |
| [<code>logout</code>](./cli/logout.md) | Unauthenticate your local session |
| [<code>ping</code>](./cli/ping.md) | Ping a workspace |
| [<code>port-forward</code>](./cli/port-forward.md) | Forward ports from machine to a workspace |
| [<code>provisionerd</code>](./cli/provisionerd.md) | Manage provisioner daemons |
| [<code>publickey</code>](./cli/publickey.md) | Output your Coder public key used for Git operations |
| [<code>rename</code>](./cli/rename.md) | Rename a workspace |
| [<code>reset-password</code>](./cli/reset-password.md) | Directly connect to the database to reset a user's password |
| [<code>restart</code>](./cli/restart.md) | Restart a workspace |
| [<code>scaletest</code>](./cli/scaletest.md) | Run a scale test against the Coder API |
| [<code>schedule</code>](./cli/schedule.md) | Schedule automated start and stop times for workspaces |
| [<code>server</code>](./cli/server.md) | Start a Coder server |
| [<code>show</code>](./cli/show.md) | Display details of a workspace's resources and agents |
| [<code>speedtest</code>](./cli/speedtest.md) | Run upload and download tests from your machine to a workspace |
| [<code>ssh</code>](./cli/ssh.md) | Start a shell into a workspace |
| [<code>start</code>](./cli/start.md) | Start a workspace |
| [<code>state</code>](./cli/state.md) | Manually manage Terraform state to fix broken workspaces |
| [<code>stop</code>](./cli/stop.md) | Stop a workspace |
| [<code>templates</code>](./cli/templates.md) | Manage templates |
| [<code>tokens</code>](./cli/tokens.md) | Manage personal access tokens |
| [<code>update</code>](./cli/update.md) | Will update and start a given workspace if it is out of date |
| [<code>users</code>](./cli/users.md) | Manage users |
| [<code>version</code>](./cli/version.md) | Show coder version |

## Options

Expand Down
6 changes: 3 additions & 3 deletions docs/cli/features.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,6 @@ coder features

## Subcommands

| Name | Purpose |
| ------------------------------------ | ------- |
| [<code>list</code>](./features_list) | |
| Name | Purpose |
| --------------------------------------- | ------- |
| [<code>list</code>](./features_list.md) | |
12 changes: 6 additions & 6 deletions docs/cli/groups.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,9 +16,9 @@ coder groups

## Subcommands

| Name | Purpose |
| -------------------------------------- | ------------------- |
| [<code>create</code>](./groups_create) | Create a user group |
| [<code>delete</code>](./groups_delete) | Delete a user group |
| [<code>edit</code>](./groups_edit) | Edit a user group |
| [<code>list</code>](./groups_list) | List user groups |
| Name | Purpose |
| ----------------------------------------- | ------------------- |
| [<code>create</code>](./groups_create.md) | Create a user group |
| [<code>delete</code>](./groups_delete.md) | Delete a user group |
| [<code>edit</code>](./groups_edit.md) | Edit a user group |
| [<code>list</code>](./groups_list.md) | List user groups |
10 changes: 5 additions & 5 deletions docs/cli/licenses.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,8 +16,8 @@ coder licenses

## Subcommands

| Name | Purpose |
| ---------------------------------------- | --------------------------------- |
| [<code>add</code>](./licenses_add) | Add license to Coder deployment |
| [<code>delete</code>](./licenses_delete) | Delete license by ID |
| [<code>list</code>](./licenses_list) | List licenses (including expired) |
| Name | Purpose |
| ------------------------------------------- | --------------------------------- |
| [<code>add</code>](./licenses_add.md) | Add license to Coder deployment |
| [<code>delete</code>](./licenses_delete.md) | Delete license by ID |
| [<code>list</code>](./licenses_list.md) | List licenses (including expired) |
6 changes: 3 additions & 3 deletions docs/cli/provisionerd.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,6 @@ coder provisionerd

## Subcommands

| Name | Purpose |
| ------------------------------------------ | ------------------------ |
| [<code>start</code>](./provisionerd_start) | Run a provisioner daemon |
| Name | Purpose |
| --------------------------------------------- | ------------------------ |
| [<code>start</code>](./provisionerd_start.md) | Run a provisioner daemon |
8 changes: 4 additions & 4 deletions docs/cli/scaletest.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ coder scaletest

## Subcommands

| Name | Purpose |
| --------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| [<code>cleanup</code>](./scaletest_cleanup) | Cleanup scaletest workspaces, then cleanup scaletest users. |
| [<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. |
| Name | Purpose |
| ------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| [<code>cleanup</code>](./scaletest_cleanup.md) | Cleanup scaletest workspaces, then cleanup scaletest users. |
| [<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. |
12 changes: 6 additions & 6 deletions docs/cli/schedule.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,9 +12,9 @@ coder schedule { show | start | stop | override } <workspace>

## Subcommands

| Name | Purpose |
| ------------------------------------------------------ | ----------------------------------------------------------------- |
| [<code>override-stop</code>](./schedule_override-stop) | Override the stop time of a currently running workspace instance. |
| [<code>show</code>](./schedule_show) | Show workspace schedule |
| [<code>start</code>](./schedule_start) | Edit workspace start schedule |
| [<code>stop</code>](./schedule_stop) | Edit workspace stop schedule |
| Name | Purpose |
| --------------------------------------------------------- | ----------------------------------------------------------------- |
| [<code>override-stop</code>](./schedule_override-stop.md) | Override the stop time of a currently running workspace instance. |
| [<code>show</code>](./schedule_show.md) | Show workspace schedule |
| [<code>start</code>](./schedule_start.md) | Edit workspace start schedule |
| [<code>stop</code>](./schedule_stop.md) | Edit workspace stop schedule |
10 changes: 5 additions & 5 deletions docs/cli/server.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,11 +12,11 @@ coder server [flags]

## Subcommands

| Name | Purpose |
| ---------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------ |
| [<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. |
| [<code>postgres-builtin-serve</code>](./server_postgres-builtin-serve) | Run the built-in PostgreSQL deployment. |
| [<code>postgres-builtin-url</code>](./server_postgres-builtin-url) | Output the connection URL for the built-in PostgreSQL deployment. |
| Name | Purpose |
| ------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------ |
| [<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. |
| [<code>postgres-builtin-serve</code>](./server_postgres-builtin-serve.md) | Run the built-in PostgreSQL deployment. |
| [<code>postgres-builtin-url</code>](./server_postgres-builtin-url.md) | Output the connection URL for the built-in PostgreSQL deployment. |

## Options

Expand Down
8 changes: 4 additions & 4 deletions docs/cli/state.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ coder state

## Subcommands

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