ci: verify that all docs links work (#4710)

ammario · web-flow · commit c9bf2a909965 · 2022-10-23T17:09:58.000-05:00
diff --git a/.github/workflows/coder.yaml b/.github/workflows/coder.yaml
@@ -674,3 +674,10 @@ jobs:
           buildScriptName: "storybook:build"
           projectToken: 695c25b6cb65
           workingDir: "./site"
+  markdown-link-check:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@master
+    - uses: gaurav-nelson/github-action-markdown-link-check@v1
+      with:
+          config-file: .github/workflows/mlc_config.json
diff --git a/.github/workflows/mlc_config.json b/.github/workflows/mlc_config.json
@@ -0,0 +1,16 @@
+{
+    "ignorePatterns": [
+        {
+            "pattern": ":\/\/localhost"
+        },
+        {
+            "pattern": ":\/\/.*.?example\\.com"
+        },
+        {
+            "pattern": "developer.github.com"
+        },
+        {
+            "pattern": "tailscale.com"
+        }
+    ]
+}
diff --git a/docs/CONTRIBUTING.md b/docs/CONTRIBUTING.md
@@ -77,7 +77,7 @@ Use the following `make` commands and scripts in development:
 
 ### Documentation
 
-Our style guide for authoring documentation can be found [./contributing/documentation.md](here).
+Our style guide for authoring documentation can be found [here](./contributing/documentation.md).
 
 ### Backend
 
diff --git a/docs/admin/auth.md b/docs/admin/auth.md
@@ -78,7 +78,7 @@ Once complete, run `sudo service coder restart` to reboot Coder.
 ## SCIM (enterprise)
 
 Coder supports user provisioning and deprovisioning via SCIM 2.0 with header
-authentication. Upon deactivation, users are [suspended](userd.md#suspend-a-user)
+authentication. Upon deactivation, users are [suspended](./users.md#suspend-a-user)
 and are not deleted. [Configure](./configure.md) your SCIM application with an
 auth key and supply it the Coder server.
 
diff --git a/docs/dotfiles.md b/docs/dotfiles.md
@@ -1,9 +1,11 @@
 # Dotfiles
 
+<!-- markdown-link-check-disable -->
 Coder offers the `coder dotfiles <repo>` command which simplifies workspace
 personalization. Our behavior is consistent with Codespaces, so
 [their documentation](https://docs.github.com/en/codespaces/customizing-your-codespace/personalizing-codespaces-for-your-account#dotfiles)
 explains how it loads your repo.
+<!-- markdown-link-check-enable -->
 
 You can read more on dotfiles best practices [here](https://dotfiles.github.io).
 
diff --git a/docs/ides/web-ides.md b/docs/ides/web-ides.md
@@ -197,11 +197,9 @@ resource "coder_app" "intellij" {
 
 You can also reference/use to these pre-built templates with JetBrains projector:
 
-- IntelliJ ([Docker](https://github.com/mark-theshark/v2-templates/tree/main/docker-with-intellij), [Kubernetes](https://github.com/mark-theshark/v2-templates/tree/main/pod-with-intellij))
+- IntelliJ ([Docker](https://github.com/mark-theshark/v2-templates/tree/main/docker-with-intellij), [Kubernetes](https://github.com/sharkymark/v2-templates/tree/main/multi-projector-intellij))
 
-- PyCharm ([Docker](https://github.com/mark-theshark/v2-templates/tree/main/docker-with-pycharm), [Kubernetes](https://github.com/mark-theshark/v2-templates/tree/main/pod-with-pycharm)
-
-- GoLand ([Docker](https://github.com/mark-theshark/v2-templates/tree/main/docker-with-goland), [Kubernetes](https://github.com/mark-theshark/v2-templates/tree/main/pod-with-goland))
+- PyCharm ([Docker](https://github.com/mark-theshark/v2-templates/tree/main/docker-with-pycharm), [Kubernetes](https://github.com/sharkymark/v2-templates/tree/main/multi-projector-pycharm)
 
 > You need to have a valid `~/.kube/config` on your Coder host and a namespace on a Kubernetes cluster to use the Kubernetes pod template examples.
 
diff --git a/docs/networking.md b/docs/networking.md
@@ -16,7 +16,7 @@ All user <-> workspace connections are end-to-end encrypted.
 ## coder server
 
 Workspaces connect to the coder server via the server's external address,
-set via [`ACCESS_URL`](./admin/configure#access-url). There must not be a
+set via [`ACCESS_URL`](./admin/configure.md#access-url). There must not be a
 NAT between workspaces and coder server.
 
 Users connect to the coder server's dashboard and API through its `ACCESS_URL`
diff --git a/docs/quickstart.md b/docs/quickstart.md
@@ -5,7 +5,7 @@ possible way to use Coder.
 
 ## Generic Quickstart
 
-Please [install Coder](../install) before proceeding with the steps below.
+Please [install Coder](./install/index.md) before proceeding with the steps below.
 
 ## First time owner user setup
 
@@ -42,7 +42,7 @@ Connect to your workspace via SSH:
 coder ssh <workspaceName>
 ```
 
-To access your workspace in the Coder dashboard, navigate to the [configured access URL](../admin/configure#access-url),
+To access your workspace in the Coder dashboard, navigate to the [configured access URL](./admin/configure.md#access-url),
 and log in with the owner credentials provided to you by Coder.
 
 ![Coder Web UI with code-server](./images/code-server.png)
@@ -65,4 +65,4 @@ coder templates push gcp-linux # updates the template
 
 ## Up Next
 
-Learn about [templates](../templates.md).
+Learn about [templates](./templates.md).
diff --git a/examples/web-server/caddy/README.md b/examples/web-server/caddy/README.md
@@ -94,7 +94,7 @@ This is an example configuration of how to use Coder with [caddy](https://caddys
 
 ## Generating wildcard certificates
 
-By default, this configuration uses Caddy's [on-demand TLS](https://caddyserver.com/docs/caddyfile/options#on-demand-tls) to generate a certificate for each subdomain (e.g. `app1.coder.example.com`, `app2.coder.example.com`). When users visit new subdomains, such as accessing [ports on a workspace](../../networking/port-forwarding.md), the request will take an additional 5-30 seconds since a new certificate is being generated.
+By default, this configuration uses Caddy's [on-demand TLS](https://caddyserver.com/docs/caddyfile/options#on-demand-tls) to generate a certificate for each subdomain (e.g. `app1.coder.example.com`, `app2.coder.example.com`). When users visit new subdomains, such as accessing [ports on a workspace](../../../docs/networking/port-forwarding.md), the request will take an additional 5-30 seconds since a new certificate is being generated.
 
 For production deployments, we recommend configuring Caddy to generate a wildcard certificate, which requires an explicit DNS challenge and additional Caddy modules.
 
