From 0f44b8bb3693eae9f09c48f508d126d935fdf896 Mon Sep 17 00:00:00 2001 From: Muhammad Atif Ali Date: Tue, 11 Apr 2023 14:36:41 +0300 Subject: [PATCH 1/2] 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. --- docs/admin/provisioners.md | 2 +- docs/cli.md | 66 ++++++++++++++--------------- docs/cli/features.md | 6 +-- docs/cli/groups.md | 12 +++--- docs/cli/licenses.md | 10 ++--- docs/cli/provisionerd.md | 6 +-- docs/cli/scaletest.md | 8 ++-- docs/cli/schedule.md | 12 +++--- docs/cli/server.md | 10 ++--- docs/cli/state.md | 8 ++-- docs/cli/templates.md | 22 +++++----- docs/cli/templates_versions.md | 6 +-- docs/cli/tokens.md | 10 ++--- docs/cli/users.md | 14 +++--- docs/networking.md | 2 +- docs/platforms/docker.md | 2 +- docs/platforms/kubernetes/index.md | 2 +- docs/platforms/other.md | 4 +- docs/templates/resource-metadata.md | 2 +- 19 files changed, 102 insertions(+), 102 deletions(-) diff --git a/docs/admin/provisioners.md b/docs/admin/provisioners.md index d775384a5ab3d..18ce4d7683347 100644 --- a/docs/admin/provisioners.md +++ b/docs/admin/provisioners.md @@ -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. diff --git a/docs/cli.md b/docs/cli.md index 92e1cece5a086..c92caa6feb037 100644 --- a/docs/cli.md +++ b/docs/cli.md @@ -23,39 +23,39 @@ Coder — A tool for provisioning self-hosted development environments with Terr ## Subcommands -| Name | Purpose | -| --------------------------------------------------- | ---------------------------------------------------------------------- | -| [config-ssh](./cli/config-ssh) | Add an SSH Host entry for your workspaces "ssh coder.workspace" | -| [create](./cli/create) | Create a workspace | -| [delete](./cli/delete) | Delete a workspace | -| [dotfiles](./cli/dotfiles) | Personalize your workspace by applying a canonical dotfiles repository | -| [features](./cli/features) | List Enterprise features | -| [groups](./cli/groups) | Manage groups | -| [licenses](./cli/licenses) | Add, delete, and list licenses | -| [list](./cli/list) | List workspaces | -| [login](./cli/login) | Authenticate with Coder deployment | -| [logout](./cli/logout) | Unauthenticate your local session | -| [ping](./cli/ping) | Ping a workspace | -| [port-forward](./cli/port-forward) | Forward ports from machine to a workspace | -| [provisionerd](./cli/provisionerd) | Manage provisioner daemons | -| [publickey](./cli/publickey) | Output your Coder public key used for Git operations | -| [rename](./cli/rename) | Rename a workspace | -| [reset-password](./cli/reset-password) | Directly connect to the database to reset a user's password | -| [restart](./cli/restart) | Restart a workspace | -| [scaletest](./cli/scaletest) | Run a scale test against the Coder API | -| [schedule](./cli/schedule) | Schedule automated start and stop times for workspaces | -| [server](./cli/server) | Start a Coder server | -| [show](./cli/show) | Display details of a workspace's resources and agents | -| [speedtest](./cli/speedtest) | Run upload and download tests from your machine to a workspace | -| [ssh](./cli/ssh) | Start a shell into a workspace | -| [start](./cli/start) | Start a workspace | -| [state](./cli/state) | Manually manage Terraform state to fix broken workspaces | -| [stop](./cli/stop) | Stop a workspace | -| [templates](./cli/templates) | Manage templates | -| [tokens](./cli/tokens) | Manage personal access tokens | -| [update](./cli/update) | Will update and start a given workspace if it is out of date | -| [users](./cli/users) | Manage users | -| [version](./cli/version) | Show coder version | +| Name | Purpose | +| ------------------------------------------------------ | ---------------------------------------------------------------------- | +| [config-ssh](./cli/config-ssh.md) | Add an SSH Host entry for your workspaces "ssh coder.workspace" | +| [create](./cli/create.md) | Create a workspace | +| [delete](./cli/delete.md) | Delete a workspace | +| [dotfiles](./cli/dotfiles.md) | Personalize your workspace by applying a canonical dotfiles repository | +| [features](./cli/features.md) | List Enterprise features | +| [groups](./cli/groups.md) | Manage groups | +| [licenses](./cli/licenses.md) | Add, delete, and list licenses | +| [list](./cli/list.md) | List workspaces | +| [login](./cli/login.md) | Authenticate with Coder deployment | +| [logout](./cli/logout.md) | Unauthenticate your local session | +| [ping](./cli/ping.md) | Ping a workspace | +| [port-forward](./cli/port-forward.md) | Forward ports from machine to a workspace | +| [provisionerd](./cli/provisionerd.md) | Manage provisioner daemons | +| [publickey](./cli/publickey.md) | Output your Coder public key used for Git operations | +| [rename](./cli/rename.md) | Rename a workspace | +| [reset-password](./cli/reset-password.md) | Directly connect to the database to reset a user's password | +| [restart](./cli/restart.md) | Restart a workspace | +| [scaletest](./cli/scaletest.md) | Run a scale test against the Coder API | +| [schedule](./cli/schedule.md) | Schedule automated start and stop times for workspaces | +| [server](./cli/server.md) | Start a Coder server | +| [show](./cli/show.md) | Display details of a workspace's resources and agents | +| [speedtest](./cli/speedtest.md) | Run upload and download tests from your machine to a workspace | +| [ssh](./cli/ssh.md) | Start a shell into a workspace | +| [start](./cli/start.md) | Start a workspace | +| [state](./cli/state.md) | Manually manage Terraform state to fix broken workspaces | +| [stop](./cli/stop.md) | Stop a workspace | +| [templates](./cli/templates.md) | Manage templates | +| [tokens](./cli/tokens.md) | Manage personal access tokens | +| [update](./cli/update.md) | Will update and start a given workspace if it is out of date | +| [users](./cli/users.md) | Manage users | +| [version](./cli/version.md) | Show coder version | ## Options diff --git a/docs/cli/features.md b/docs/cli/features.md index 7b4a5fa88b4f8..d367623f049a0 100644 --- a/docs/cli/features.md +++ b/docs/cli/features.md @@ -16,6 +16,6 @@ coder features ## Subcommands -| Name | Purpose | -| ------------------------------------ | ------- | -| [list](./features_list) | | +| Name | Purpose | +| --------------------------------------- | ------- | +| [list](./features_list.md) | | diff --git a/docs/cli/groups.md b/docs/cli/groups.md index 97df9e7c72245..0651b278ab58f 100644 --- a/docs/cli/groups.md +++ b/docs/cli/groups.md @@ -16,9 +16,9 @@ coder groups ## Subcommands -| Name | Purpose | -| -------------------------------------- | ------------------- | -| [create](./groups_create) | Create a user group | -| [delete](./groups_delete) | Delete a user group | -| [edit](./groups_edit) | Edit a user group | -| [list](./groups_list) | List user groups | +| Name | Purpose | +| ----------------------------------------- | ------------------- | +| [create](./groups_create.md) | Create a user group | +| [delete](./groups_delete.md) | Delete a user group | +| [edit](./groups_edit.md) | Edit a user group | +| [list](./groups_list.md) | List user groups | diff --git a/docs/cli/licenses.md b/docs/cli/licenses.md index 08a69f834b307..f365b022c4e3d 100644 --- a/docs/cli/licenses.md +++ b/docs/cli/licenses.md @@ -16,8 +16,8 @@ coder licenses ## Subcommands -| Name | Purpose | -| ---------------------------------------- | --------------------------------- | -| [add](./licenses_add) | Add license to Coder deployment | -| [delete](./licenses_delete) | Delete license by ID | -| [list](./licenses_list) | List licenses (including expired) | +| Name | Purpose | +| ------------------------------------------- | --------------------------------- | +| [add](./licenses_add.md) | Add license to Coder deployment | +| [delete](./licenses_delete.md) | Delete license by ID | +| [list](./licenses_list.md) | List licenses (including expired) | diff --git a/docs/cli/provisionerd.md b/docs/cli/provisionerd.md index 0c5c772b6f3a2..21af8ff547fcb 100644 --- a/docs/cli/provisionerd.md +++ b/docs/cli/provisionerd.md @@ -12,6 +12,6 @@ coder provisionerd ## Subcommands -| Name | Purpose | -| ------------------------------------------ | ------------------------ | -| [start](./provisionerd_start) | Run a provisioner daemon | +| Name | Purpose | +| --------------------------------------------- | ------------------------ | +| [start](./provisionerd_start.md) | Run a provisioner daemon | diff --git a/docs/cli/scaletest.md b/docs/cli/scaletest.md index f5733cc167635..aae17ff7ba5fd 100644 --- a/docs/cli/scaletest.md +++ b/docs/cli/scaletest.md @@ -12,7 +12,7 @@ coder scaletest ## Subcommands -| Name | Purpose | -| --------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| [cleanup](./scaletest_cleanup) | Cleanup scaletest workspaces, then cleanup scaletest users. | -| [create-workspaces](./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 | +| ------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| [cleanup](./scaletest_cleanup.md) | Cleanup scaletest workspaces, then cleanup scaletest users. | +| [create-workspaces](./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. | diff --git a/docs/cli/schedule.md b/docs/cli/schedule.md index f79b1d061daff..4e9891f123ac4 100644 --- a/docs/cli/schedule.md +++ b/docs/cli/schedule.md @@ -12,9 +12,9 @@ coder schedule { show | start | stop | override } ## Subcommands -| Name | Purpose | -| ------------------------------------------------------ | ----------------------------------------------------------------- | -| [override-stop](./schedule_override-stop) | Override the stop time of a currently running workspace instance. | -| [show](./schedule_show) | Show workspace schedule | -| [start](./schedule_start) | Edit workspace start schedule | -| [stop](./schedule_stop) | Edit workspace stop schedule | +| Name | Purpose | +| --------------------------------------------------------- | ----------------------------------------------------------------- | +| [override-stop](./schedule_override-stop.md) | Override the stop time of a currently running workspace instance. | +| [show](./schedule_show.md) | Show workspace schedule | +| [start](./schedule_start.md) | Edit workspace start schedule | +| [stop](./schedule_stop.md) | Edit workspace stop schedule | diff --git a/docs/cli/server.md b/docs/cli/server.md index 0d0f061c669bf..e66ed063dd62f 100644 --- a/docs/cli/server.md +++ b/docs/cli/server.md @@ -12,11 +12,11 @@ coder server [flags] ## Subcommands -| Name | Purpose | -| ---------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------ | -| [create-admin-user](./server_create-admin-user) | Create a new admin user with the given username, email and password and adds it to every organization. | -| [postgres-builtin-serve](./server_postgres-builtin-serve) | Run the built-in PostgreSQL deployment. | -| [postgres-builtin-url](./server_postgres-builtin-url) | Output the connection URL for the built-in PostgreSQL deployment. | +| Name | Purpose | +| ------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------ | +| [create-admin-user](./server_create-admin-user.md) | Create a new admin user with the given username, email and password and adds it to every organization. | +| [postgres-builtin-serve](./server_postgres-builtin-serve.md) | Run the built-in PostgreSQL deployment. | +| [postgres-builtin-url](./server_postgres-builtin-url.md) | Output the connection URL for the built-in PostgreSQL deployment. | ## Options diff --git a/docs/cli/state.md b/docs/cli/state.md index d573e75a2ce44..b0e9ca7433750 100644 --- a/docs/cli/state.md +++ b/docs/cli/state.md @@ -12,7 +12,7 @@ coder state ## Subcommands -| Name | Purpose | -| --------------------------------- | --------------------------------------------- | -| [pull](./state_pull) | Pull a Terraform state file from a workspace. | -| [push](./state_push) | Push a Terraform state file to a workspace. | +| Name | Purpose | +| ------------------------------------ | --------------------------------------------- | +| [pull](./state_pull.md) | Pull a Terraform state file from a workspace. | +| [push](./state_push.md) | Push a Terraform state file to a workspace. | diff --git a/docs/cli/templates.md b/docs/cli/templates.md index 8a15b8c3fa99a..ed459f2d70d82 100644 --- a/docs/cli/templates.md +++ b/docs/cli/templates.md @@ -33,14 +33,14 @@ Templates are written in standard Terraform and describe the infrastructure for ## Subcommands -| Name | Purpose | -| --------------------------------------------- | ------------------------------------------------------------------------------ | -| [create](./templates_create) | Create a template from the current directory or as specified by flag | -| [delete](./templates_delete) | Delete templates | -| [edit](./templates_edit) | Edit the metadata of a template by name. | -| [init](./templates_init) | Get started with a templated template. | -| [list](./templates_list) | List all the templates available for the organization | -| [plan](./templates_plan) | Plan a template push from the current directory | -| [pull](./templates_pull) | Download the latest version of a template to a path. | -| [push](./templates_push) | Push a new template version from the current directory or as specified by flag | -| [versions](./templates_versions) | Manage different versions of the specified template | +| Name | Purpose | +| ------------------------------------------------ | ------------------------------------------------------------------------------ | +| [create](./templates_create.md) | Create a template from the current directory or as specified by flag | +| [delete](./templates_delete.md) | Delete templates | +| [edit](./templates_edit.md) | Edit the metadata of a template by name. | +| [init](./templates_init.md) | Get started with a templated template. | +| [list](./templates_list.md) | List all the templates available for the organization | +| [plan](./templates_plan.md) | Plan a template push from the current directory | +| [pull](./templates_pull.md) | Download the latest version of a template to a path. | +| [push](./templates_push.md) | Push a new template version from the current directory or as specified by flag | +| [versions](./templates_versions.md) | Manage different versions of the specified template | diff --git a/docs/cli/templates_versions.md b/docs/cli/templates_versions.md index 468596428b853..9114ce1646ccf 100644 --- a/docs/cli/templates_versions.md +++ b/docs/cli/templates_versions.md @@ -24,6 +24,6 @@ coder templates versions ## Subcommands -| Name | Purpose | -| ---------------------------------------------- | ----------------------------------------------- | -| [list](./templates_versions_list) | List all the versions of the specified template | +| Name | Purpose | +| ------------------------------------------------- | ----------------------------------------------- | +| [list](./templates_versions_list.md) | List all the versions of the specified template | diff --git a/docs/cli/tokens.md b/docs/cli/tokens.md index 264b1e9ce71b2..a6314c05c9137 100644 --- a/docs/cli/tokens.md +++ b/docs/cli/tokens.md @@ -33,8 +33,8 @@ Tokens are used to authenticate automated clients to Coder. ## Subcommands -| Name | Purpose | -| -------------------------------------- | -------------- | -| [create](./tokens_create) | Create a token | -| [list](./tokens_list) | List tokens | -| [remove](./tokens_remove) | Delete a token | +| Name | Purpose | +| ----------------------------------------- | -------------- | +| [create](./tokens_create.md) | Create a token | +| [list](./tokens_list.md) | List tokens | +| [remove](./tokens_remove.md) | Delete a token | diff --git a/docs/cli/users.md b/docs/cli/users.md index a95a6450218ae..ade49b04a866b 100644 --- a/docs/cli/users.md +++ b/docs/cli/users.md @@ -16,10 +16,10 @@ coder users [subcommand] ## Subcommands -| Name | Purpose | -| ----------------------------------------- | ------------------------------------------------------------------------------------- | -| [activate](./users_activate) | Update a user's status to 'active'. Active users can fully interact with the platform | -| [create](./users_create) | | -| [list](./users_list) | | -| [show](./users_show) | Show a single user. Use 'me' to indicate the currently authenticated user. | -| [suspend](./users_suspend) | Update a user's status to 'suspended'. A suspended user cannot log into the platform | +| Name | Purpose | +| -------------------------------------------- | ------------------------------------------------------------------------------------- | +| [activate](./users_activate.md) | Update a user's status to 'active'. Active users can fully interact with the platform | +| [create](./users_create.md) | | +| [list](./users_list.md) | | +| [show](./users_show.md) | Show a single user. Use 'me' to indicate the currently authenticated user. | +| [suspend](./users_suspend.md) | Update a user's status to 'suspended'. A suspended user cannot log into the platform | diff --git a/docs/networking.md b/docs/networking.md index 0844a936ec1ae..6e1012f415408 100644 --- a/docs/networking.md +++ b/docs/networking.md @@ -51,7 +51,7 @@ is no special geo-distribution configuration. To speed up direct connections, move the user and workspace closer together. If a direct connection is not available (e.g. client or server is behind NAT), Coder -will use a relayed connection. By default, [Coder uses Google's public STUN server](./cli/coder_server#--derp-server-stun-addresses), but +will use a relayed connection. By default, [Coder uses Google's public STUN server](./cli/server.md#--derp-server-stun-addresses), but this can be disabled or changed for [offline deployments](./install/offline.md). ### Relayed connections diff --git a/docs/platforms/docker.md b/docs/platforms/docker.md index be49e0e2212c9..fcdebebf52e6a 100644 --- a/docs/platforms/docker.md +++ b/docs/platforms/docker.md @@ -7,7 +7,7 @@ Coder with Docker has the following advantages: - Workspaces share resources for burst operations > Note that the below steps are only supported on a Linux distribution. -> If on macOS, please [run Coder via the standalone binary](./binary.md). +> If on macOS, please [run Coder via the standalone binary](../install//binary.md). ## Requirements diff --git a/docs/platforms/kubernetes/index.md b/docs/platforms/kubernetes/index.md index 03416f16b4aea..eef0e70e72c79 100644 --- a/docs/platforms/kubernetes/index.md +++ b/docs/platforms/kubernetes/index.md @@ -4,7 +4,7 @@ Coder's control plane and/or workspaces can be deployed on Kubernetes. ## Installation -Refer to our [Helm install docs](../install/kubernetes.md) to deploy Coder on Kubernetes. The default helm values will provision the following: +Refer to our [Helm install docs](../../install/kubernetes.md) to deploy Coder on Kubernetes. The default helm values will provision the following: - Coder control plane (as a `Deployment`) - ServiceAccount + Role + RoleBinding to provision pods + PVCS in the current namespace (used for Kubernetes workspaces) diff --git a/docs/platforms/other.md b/docs/platforms/other.md index 16c12db16cd9a..76ca4c8ebe969 100644 --- a/docs/platforms/other.md +++ b/docs/platforms/other.md @@ -1,11 +1,11 @@ # Other platforms -Coder is highly extensible and is not limited to the platforms outlined in these docs. The control plane can be provisioned on any VM or container compute, and workspaces can include any Terraform resource. See our [architecture diagram](./about/architecture.md) for more details. +Coder is highly extensible and is not limited to the platforms outlined in these docs. The control plane can be provisioned on any VM or container compute, and workspaces can include any Terraform resource. See our [architecture diagram](../about/architecture.md) for more details. The following resources may help as you're deploying Coder. - [Coder packages: one-click install on cloud providers](https://github.com/coder/packages) - [Run Coder as a system service](../install/packages.md) -- [Deploy Coder offline](../enterprise/offline.md) +- [Deploy Coder offline](../install/offline.md) - [Supported resources (Terraform registry)](https://registry.terraform.io) - [Writing custom templates](../templates.md) diff --git a/docs/templates/resource-metadata.md b/docs/templates/resource-metadata.md index ebfb360c9eeb7..ef267cdf33113 100644 --- a/docs/templates/resource-metadata.md +++ b/docs/templates/resource-metadata.md @@ -121,4 +121,4 @@ Read more [here](./agent-metadata.md). ## Up next - Learn about [secrets](../secrets.md) -- Learn about [Agent Metadata](../agent-metadata.md) +- Learn about [Agent Metadata](./agent-metadata.md) From a0477dedd84505bd8c349d2ee7caf40790f4a268 Mon Sep 17 00:00:00 2001 From: Muhammad Atif Ali Date: Tue, 11 Apr 2023 14:46:38 +0000 Subject: [PATCH 2/2] Updated docgen to include extension --- scripts/clidocgen/gen.go | 5 +---- 1 file changed, 1 insertion(+), 4 deletions(-) diff --git a/scripts/clidocgen/gen.go b/scripts/clidocgen/gen.go index e22f00a4c5a86..ac50b511ca134 100644 --- a/scripts/clidocgen/gen.go +++ b/scripts/clidocgen/gen.go @@ -55,10 +55,7 @@ func init() { return fmt.Sprintf("%s", s) }, "commandURI": func(cmd *clibase.Cmd) string { - return strings.TrimSuffix( - fmtDocFilename(cmd), - ".md", - ) + return fmtDocFilename(cmd) }, "fullName": fullName, "tableHeader": func() string {