Fix broken links and improve formatting in docs

matifali · matifali · commit 549f6c367017 · 2024-10-01T10:22:44.000Z
Ensure documentation links are current and adjust line spacing for better readability across multiple integration and tutorial pages.
diff --git a/docs/admin/integrations/jfrog-artifactory.md b/docs/admin/integrations/jfrog-artifactory.md
@@ -162,7 +162,8 @@ concepts apply to all compute types.
 
 ## Offline Deployments
 
-See the [offline deployments](../templates/extending-templates/modules.md#offline-installations)
+See the
+[offline deployments](../templates/extending-templates/modules.md#offline-installations)
 section for instructions on how to use coder-modules in an offline environment
 with Artifactory.
 
diff --git a/docs/admin/integrations/jfrog-xray.md b/docs/admin/integrations/jfrog-xray.md
@@ -26,10 +26,8 @@ using Coder's [JFrog Xray Integration](https://github.com/coder/coder-xray).
    with a user that has the read
    [permission](https://jfrog.com/help/r/jfrog-platform-administration-documentation/permissions)
    for the repositories you want to scan.
-1. Create a Coder
-   [token](../../reference/cli/tokens_create#tokens-create)
-   with a user that has the
-   [`owner`](../users#roles) role.
+1. Create a Coder [token](../../reference/cli/tokens_create#tokens-create) with
+   a user that has the [`owner`](../users#roles) role.
 1. Create Kubernetes secrets for the JFrog Xray and Coder tokens.
 
    ```bash
diff --git a/docs/admin/integrations/multiple-kube-clusters.md b/docs/admin/integrations/multiple-kube-clusters.md
@@ -58,8 +58,9 @@ If you deployed Coder on a VM, copy the kubeconfig file to
 
 You can start from our
 [example template](https://github.com/coder/coder/tree/main/examples/templates/kubernetes).
-From there, add [template parameters](../templates/extending-templates/parameters.md) to
-allow developers to pick their desired cluster.
+From there, add
+[template parameters](../templates/extending-templates/parameters.md) to allow
+developers to pick their desired cluster.
 
 ```tf
 # main.tf
diff --git a/docs/admin/networking/README.md b/docs/admin/networking/README.md
@@ -169,6 +169,13 @@ with security policies. In these cases, pass the `--browser-only` flag to
 With browser-only connections, developers can only connect to their workspaces
 via the web terminal and [web IDEs](../../user-guides/workspace-access/web-ides.md).
 
+### Workspace Proxies (enterprise)
+
+Workspace proxies are a Coder Enterprise feature that allows you to provide
+low-latency browser experiences for geo-distributed teams.
+
+To learn more, see [Workspace Proxies](./workspace-proxies.md).
+
 ## Up next
 
 - Learn about [Port Forwarding](./port-forwarding.md)
diff --git a/docs/admin/networking/workspace-proxies.md b/docs/admin/networking/workspace-proxies.md
@@ -58,7 +58,7 @@ the workspace proxy usable. If the proxy deployment is successful,
 
 ```
 $ coder wsproxy ls
-NAME              URL                           STATUS STATUS
+NAME              URL                         STATUS STATUS
 brazil-saopaulo   https://brazil.example.com  ok
 europe-frankfurt  https://europe.example.com  ok
 sydney            https://sydney.example.com  ok
diff --git a/docs/tutorials/faqs.md b/docs/tutorials/faqs.md
@@ -2,7 +2,7 @@
 
 Frequently asked questions on Coder OSS and Enterprise deployments. These FAQs
 come from our community and enterprise customers, feel free to
-[contribute to this page](https://github.com/coder/coder/edit/main/docs/faqs.md).
+[contribute to this page](https://github.com/coder/coder/edit/main/docs/tutorials/faqs.md).
 
 For other community resources, see our
 [Github discussions](https://github.com/coder/coder/discussions), or join our
@@ -20,8 +20,7 @@ In the UI, click the Deployment tab -> Licenses and upload the `jwt` license
 file.
 
 > To add the license with the CLI, first
-> [install the Coder CLI](./install/index.md#install-script) and server to the
-> latest release.
+> [install the Coder CLI](../install/cli.md) and server to the latest release.
 
 If the license is a text string:
 
@@ -41,8 +40,8 @@ The primary developer use case is a local IDE connecting over SSH to a Coder
 workspace.
 
 Coder's networking stack has intelligence to attempt a peer-to-peer or
-[Direct connection](https://coder.com/docs/networking#direct-connections)
-between the local IDE and the workspace. However, this requires some additional
+[Direct connection](../admin/networking/README.md#direct-connections) between
+the local IDE and the workspace. However, this requires some additional
 protocols like UDP and being able to reach a STUN server to echo the IP
 addresses of the local IDE machine and workspace, for sharing using a Wireguard
 Coordination Server. By default, Coder assumes Internet and attempts to reach
@@ -56,11 +55,11 @@ to establish these direct connections.
 Setting the following flags as shown disables this logic to simplify
 troubleshooting.
 
-| Flag                                                                                                           | Value       | Meaning                               |
-| -------------------------------------------------------------------------------------------------------------- | ----------- | ------------------------------------- |
-| [`CODER_BLOCK_DIRECT`](https://coder.com/docs/reference/cli/server#--block-direct-connections)                 | `true`      | Blocks direct connections             |
-| [`CODER_DERP_SERVER_STUN_ADDRESSES`](https://coder.com/docs/reference/cli/server#--derp-server-stun-addresses) | `"disable"` | Disables STUN                         |
-| [`CODER_DERP_FORCE_WEBSOCKETS`](https://coder.com/docs/reference/cli/server#--derp-force-websockets)           | `true`      | Forces websockets over Tailscale DERP |
+| Flag                                                                                       | Value       | Meaning                               |
+| ------------------------------------------------------------------------------------------ | ----------- | ------------------------------------- |
+| [`CODER_BLOCK_DIRECT`](../reference/cli/server#--block-direct-connections)                 | `true`      | Blocks direct connections             |
+| [`CODER_DERP_SERVER_STUN_ADDRESSES`](../reference/cli/server#--derp-server-stun-addresses) | `"disable"` | Disables STUN                         |
+| [`CODER_DERP_FORCE_WEBSOCKETS`](../reference/cli/server#--derp-force-websockets)           | `true`      | Forces websockets over Tailscale DERP |
 
 ### How do I configure NGINX as the reverse proxy in front of Coder?
 
@@ -124,9 +123,9 @@ resource "coder_app" "code-server" {
 An important concept to understand is that Coder creates workspaces which have
 an agent that must be able to reach the `coder server`.
 
-If the [`CODER_ACCESS_URL`](https://coder.com/docs/admin/configure#access-url)
-is not accessible from a workspace, the workspace may build, but the agent
-cannot reach Coder, and thus the missing icons. e.g., Terminal, IDEs, Apps.
+If the [`CODER_ACCESS_URL`](../admin/configure.md#access-url) is not accessible
+from a workspace, the workspace may build, but the agent cannot reach Coder, and
+thus the missing icons. e.g., Terminal, IDEs, Apps.
 
 > By default, `coder server` automatically creates an Internet-accessible
 > reverse proxy so that workspaces you create can reach the server.
@@ -154,9 +153,9 @@ of these values can lead to existing workspaces failing to start. This issue
 occurs because the Terraform state will not be in sync with the new template.
 
 However, a lesser-known CLI sub-command,
-[`coder update`](https://coder.com/docs/reference/cli/update), can resolve this
-issue. This command re-prompts users to re-enter the input variables,
-potentially saving the workspace from a failed status.
+[`coder update`](../reference/cli/update), can resolve this issue. This command
+re-prompts users to re-enter the input variables, potentially saving the
+workspace from a failed status.
 
 ```sh
 coder update --always-prompt <workspace name>
diff --git a/docs/tutorials/templates/cloning-git-repositories.md b/docs/tutorials/templates/cloning-git-repositories.md
@@ -44,9 +44,9 @@ module "git-clone" {
 > [template editor UI](../../admin/templates/creating-templates.md#web-ui).
 
 You can also use
-[template parameters](../../admin/templates/extending-templates/parameters.md) to customize
-the Git URL and make it dynamic for use cases where a template supports multiple
-projects.
+[template parameters](../../admin/templates/extending-templates/parameters.md)
+to customize the Git URL and make it dynamic for use cases where a template
+supports multiple projects.
 
 ```tf
 data "coder_parameter" "git_repo" {
