opensource/coder
3
0
Fork 0
mirror of https://github.com/coder/coder.git synced 2026-09-24 15:04:27 +08:00
Code Issues Packages Projects Releases Wiki Activity

fix(docs): fix broken markdown links (#7081)

Browse Source 
* 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
This commit is contained in:
Muhammad Atif Ali
2023-04-11 15:05:51 -05:00
committed by GitHub
parent a44070e2ec
commit 531fd23fd2
20 changed files with 103 additions and 106 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/cli/features.md
+3 -3
View File
@@ -16,6 +16,6 @@ coder features
## Subcommands
| Name | Purpose |
| ------------------------------------ | ------- |
| [<code>list</code>](./features_list) | |
| Name | Purpose |
| --------------------------------------- | ------- |
| [<code>list</code>](./features_list.md) | |
docs/cli/groups.md
+6 -6
View File
@@ -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 |
docs/cli/licenses.md
+5 -5
View File
@@ -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) |
docs/cli/provisionerd.md
+3 -3
View File
@@ -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 |
docs/cli/scaletest.md
+4 -4
View File
@@ -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. |
docs/cli/schedule.md
+6 -6
View File
@@ -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 |
docs/cli/server.md
+5 -5
View File
@@ -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
docs/cli/state.md
+4 -4
View File
@@ -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. |
docs/cli/templates.md
+11 -11
View File
@@ -33,14 +33,14 @@ Templates are written in standard Terraform and describe the infrastructure for
## Subcommands
| Name | Purpose |
| --------------------------------------------- | ------------------------------------------------------------------------------ |
| [<code>create</code>](./templates_create) | Create a template from the current directory or as specified by flag |
| [<code>delete</code>](./templates_delete) | Delete templates |
| [<code>edit</code>](./templates_edit) | Edit the metadata of a template by name. |
| [<code>init</code>](./templates_init) | Get started with a templated template. |
| [<code>list</code>](./templates_list) | List all the templates available for the organization |
| [<code>plan</code>](./templates_plan) | Plan a template push from the current directory |
| [<code>pull</code>](./templates_pull) | Download the latest version of a template to a path. |
| [<code>push</code>](./templates_push) | Push a new template version from the current directory or as specified by flag |
| [<code>versions</code>](./templates_versions) | Manage different versions of the specified template |
| Name | Purpose |
| ------------------------------------------------ | ------------------------------------------------------------------------------ |
| [<code>create</code>](./templates_create.md) | Create a template from the current directory or as specified by flag |
| [<code>delete</code>](./templates_delete.md) | Delete templates |
| [<code>edit</code>](./templates_edit.md) | Edit the metadata of a template by name. |
| [<code>init</code>](./templates_init.md) | Get started with a templated template. |
| [<code>list</code>](./templates_list.md) | List all the templates available for the organization |
| [<code>plan</code>](./templates_plan.md) | Plan a template push from the current directory |
| [<code>pull</code>](./templates_pull.md) | Download the latest version of a template to a path. |
| [<code>push</code>](./templates_push.md) | Push a new template version from the current directory or as specified by flag |
| [<code>versions</code>](./templates_versions.md) | Manage different versions of the specified template |
docs/cli/templates_versions.md
+3 -3
View File
@@ -24,6 +24,6 @@ coder templates versions
## Subcommands
| Name | Purpose |
| ---------------------------------------------- | ----------------------------------------------- |
| [<code>list</code>](./templates_versions_list) | List all the versions of the specified template |
| Name | Purpose |
| ------------------------------------------------- | ----------------------------------------------- |
| [<code>list</code>](./templates_versions_list.md) | List all the versions of the specified template |
docs/cli/tokens.md
+5 -5
View File
@@ -33,8 +33,8 @@ Tokens are used to authenticate automated clients to Coder.
## Subcommands
| Name | Purpose |
| -------------------------------------- | -------------- |
| [<code>create</code>](./tokens_create) | Create a token |
| [<code>list</code>](./tokens_list) | List tokens |
| [<code>remove</code>](./tokens_remove) | Delete a token |
| Name | Purpose |
| ----------------------------------------- | -------------- |
| [<code>create</code>](./tokens_create.md) | Create a token |
| [<code>list</code>](./tokens_list.md) | List tokens |
| [<code>remove</code>](./tokens_remove.md) | Delete a token |
docs/cli/users.md
+7 -7
View File
@@ -16,10 +16,10 @@ coder users [subcommand]
## Subcommands
| Name | Purpose |
| ----------------------------------------- | ------------------------------------------------------------------------------------- |
| [<code>activate</code>](./users_activate) | Update a user's status to 'active'. Active users can fully interact with the platform |
| [<code>create</code>](./users_create) | |
| [<code>list</code>](./users_list) | |
| [<code>show</code>](./users_show) | Show a single user. Use 'me' to indicate the currently authenticated user. |
| [<code>suspend</code>](./users_suspend) | Update a user's status to 'suspended'. A suspended user cannot log into the platform |
| Name | Purpose |
| -------------------------------------------- | ------------------------------------------------------------------------------------- |
| [<code>activate</code>](./users_activate.md) | Update a user's status to 'active'. Active users can fully interact with the platform |
| [<code>create</code>](./users_create.md) | |
| [<code>list</code>](./users_list.md) | |
| [<code>show</code>](./users_show.md) | Show a single user. Use 'me' to indicate the currently authenticated user. |
| [<code>suspend</code>](./users_suspend.md) | Update a user's status to 'suspended'. A suspended user cannot log into the platform |