docs: resolve README 404s (#7822)

ericpaulsen · web-flow · commit 6715cb6a95bf · 2023-06-02T20:56:06.000Z
diff --git a/docs/README.md b/docs/README.md
@@ -28,7 +28,7 @@ product.
 Coder workspaces don't stop at compute. You can add storage buckets, secrets, sidecars
 and whatever else Terraform lets you dream up.
 
-[Learn more about managing infrastructure.](./templates/README.md)
+[Learn more about managing infrastructure.](./templates/index.md)
 
 ## IDE Support
 
@@ -104,5 +104,5 @@ Azure, Google Cloud, Kubernetes, and more.
 
 ## Up next
 
-- Learn about [Templates](./templates/README.md)
+- Learn about [Templates](./templates/index.md)
 - [Install Coder](./install/install.sh.md)
diff --git a/docs/about/architecture.md b/docs/about/architecture.md
@@ -40,7 +40,7 @@ It offers the following services along with much more:
 - Liveness checks
 - `startup_script` automation
 
-Templates are responsible for [creating and running agents](../templates/README.md#coder-agent) within workspaces.
+Templates are responsible for [creating and running agents](../templates/index.md#coder-agent) within workspaces.
 
 ## Service Bundling
 
diff --git a/docs/admin/configure.md b/docs/admin/configure.md
@@ -35,7 +35,7 @@ coder server
 ## Wildcard access URL
 
 `CODER_WILDCARD_ACCESS_URL` is necessary for [port forwarding](../networking/port-forwarding.md#dashboard)
-via the dashboard or running [coder_apps](../templates/README.md#coder-apps) on an absolute path. Set this to a wildcard
+via the dashboard or running [coder_apps](../templates/index.md#coder-apps) on an absolute path. Set this to a wildcard
 subdomain that resolves to Coder (e.g. `*.coder.example.com`).
 
 If you are providing TLS certificates directly to the Coder server, either
diff --git a/docs/admin/high-availability.md b/docs/admin/high-availability.md
@@ -21,7 +21,7 @@ to the same Postgres endpoint.
 HA brings one configuration variable to set in each Coder
 node: `CODER_DERP_SERVER_RELAY_URL`. The HA nodes use these URLs to communicate
 with each other. Inter-node communication is only required while using the
-embedded relay (default). If you're using [custom relays](../networking/README.md#custom-relays), Coder ignores `CODER_DERP_SERVER_RELAY_URL` since Postgres is the sole rendezvous for the Coder nodes.
+embedded relay (default). If you're using [custom relays](../networking/index.md#custom-relays), Coder ignores `CODER_DERP_SERVER_RELAY_URL` since Postgres is the sole rendezvous for the Coder nodes.
 
 `CODER_DERP_SERVER_RELAY_URL` will never be `CODER_ACCESS_URL` because
 `CODER_ACCESS_URL` is a load balancer to all Coder nodes.
@@ -57,6 +57,6 @@ Then, increase the number of pods.
 
 ## Up next
 
-- [Networking](../networking/README.md)
+- [Networking](../networking/index.md)
 - [Kubernetes](../install/kubernetes.md)
 - [Enterprise](../enterprise.md)
diff --git a/docs/ides.md b/docs/ides.md
@@ -22,7 +22,7 @@ Click `VS Code Desktop` in the dashboard to one-click enter a workspace. This au
 
 ![Demo](https://github.com/coder/vscode-coder/raw/main/demo.gif?raw=true)
 
-> The `VS Code Desktop` button can be hidden by enabling [Browser-only connections](./networking/README.md#Browser-only).
+> The `VS Code Desktop` button can be hidden by enabling [Browser-only connections](./networking/index.md#Browser-only).
 
 ### Manual Installation
 
diff --git a/docs/install/binary.md b/docs/install/binary.md
@@ -30,4 +30,4 @@ Coder publishes self-contained .zip and .tar.gz archives in [GitHub releases](ht
 ## Next steps
 
 - [Configuring Coder](../admin/configure.md)
-- [Templates](../templates/README.md)
+- [Templates](../templates/index.md)
diff --git a/docs/install/database.md b/docs/install/database.md
@@ -84,4 +84,4 @@ psql -U coder -c '\dn'
 ## Next steps
 
 - [Configuring Coder](../admin/configure.md)
-- [Templates](../templates/README.md)
+- [Templates](../templates/index.md)
diff --git a/docs/install/docker.md b/docs/install/docker.md
@@ -88,7 +88,7 @@ an PostgreSQL container and volume.
 
 ### Docker-based workspace is stuck in "Connecting..."
 
-Ensure you have an externally-reachable `CODER_ACCESS_URL` set. See [troubleshooting templates](../templates/README.md#troubleshooting-templates) for more steps.
+Ensure you have an externally-reachable `CODER_ACCESS_URL` set. See [troubleshooting templates](../templates/index.md#troubleshooting-templates) for more steps.
 
 ### Permission denied while trying to connect to the Docker daemon socket
 
@@ -97,4 +97,4 @@ See Docker's official documentation to [Manage Docker as a non-root user](https:
 ## Next steps
 
 - [Configuring Coder](../admin/configure.md)
-- [Templates](../templates/README.md)
+- [Templates](../templates/index.md)
diff --git a/docs/install/install.sh.md b/docs/install/install.sh.md
@@ -25,4 +25,4 @@ By default, the Coder server runs on `http://127.0.0.1:3000` and uses a [public
 ## Next steps
 
 - [Configuring Coder](../admin/configure.md)
-- [Templates](../templates/README.md)
+- [Templates](../templates/index.md)
diff --git a/docs/install/kubernetes.md b/docs/install/kubernetes.md
@@ -176,9 +176,9 @@ Cloud's log management system if you are using managed Kubernetes.
 Ensure you have an externally-reachable `CODER_ACCESS_URL` set in your helm chart. If you do not have a domain set up,
 this should be the IP address of Coder's LoadBalancer (`kubectl get svc -n coder`).
 
-See [troubleshooting templates](../templates/README.md#troubleshooting-templates) for more steps.
+See [troubleshooting templates](../templates/index.md#troubleshooting-templates) for more steps.
 
 ## Next steps
 
 - [Configuring Coder](../admin/configure.md)
-- [Templates](../templates/README.md)
+- [Templates](../templates/index.md)
diff --git a/docs/install/offline.md b/docs/install/offline.md
@@ -4,15 +4,15 @@ All Coder features are supported in offline / behind firewalls / in air-gapped e
 
 > This is a general comparison. Keep reading for a full tutorial running Coder offline with Kubernetes or Docker.
 
-|                    | Public deployments                                                                                                                                                                                                                                                 | Offline deployments                                                                                                                                                                                                                                                          |
-| ------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| Terraform binary   | By default, Coder downloads Terraform binary from [releases.hashicorp.com](https://releases.hashicorp.com)                                                                                                                                                         | Terraform binary must be included in `PATH` for the VM or container image. [Supported versions](https://github.com/coder/coder/blob/main/provisioner/terraform/install.go#L23-L24)                                                                                           |
-| Terraform registry | Coder templates will attempt to download providers from [registry.terraform.io](https://registry.terraform.io) or [custom source addresses](https://developer.hashicorp.com/terraform/language/providers/requirements#source-addresses) specified in each template | [Custom source addresses](https://developer.hashicorp.com/terraform/language/providers/requirements#source-addresses) can be specified in each Coder template, or a custom registry/mirror can be used. More details below                                                   |
-| STUN               | By default, Coder uses Google's public STUN server for direct workspace connections                                                                                                                                                                                | STUN can be safely [disabled](../cli/server.md#--derp-server-stun-addresses), users can still connect via [relayed connections](../networking/README.md#-geo-distribution). Alternatively, you can set a [custom DERP server](../cli/server.md#--derp-server-stun-addresses) |
-| DERP               | By default, Coder's built-in DERP relay can be used, or [Tailscale's public relays](../networking/README.md#relayed-connections).                                                                                                                                  | By default, Coder's built-in DERP relay can be used, or [custom relays](../networking/README.md#custom-relays).                                                                                                                                                              |
-| PostgreSQL         | If no [PostgreSQL connection URL](../cli/server.md#--postgres-url) is specified, Coder will download Postgres from [repo1.maven.org](https://repo1.maven.org)                                                                                                      | An external database is required, you must specify a [PostgreSQL connection URL](../cli/server.md#--postgres-url)                                                                                                                                                            |
-| Telemetry          | Telemetry is on by default, and [can be disabled](../cli/server.md#--telemetry)                                                                                                                                                                                    | Telemetry [can be disabled](../cli/server.md#--telemetry)                                                                                                                                                                                                                    |
-| Update check       | By default, Coder checks for updates from [GitHub releases](https:/github.com/coder/coder/releases)                                                                                                                                                                | Update checks [can be disabled](../cli/server.md#--update-check)                                                                                                                                                                                                             |
+|                    | Public deployments                                                                                                                                                                                                                                                 | Offline deployments                                                                                                                                                                                                                                                         |
+| ------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| Terraform binary   | By default, Coder downloads Terraform binary from [releases.hashicorp.com](https://releases.hashicorp.com)                                                                                                                                                         | Terraform binary must be included in `PATH` for the VM or container image. [Supported versions](https://github.com/coder/coder/blob/main/provisioner/terraform/install.go#L23-L24)                                                                                          |
+| Terraform registry | Coder templates will attempt to download providers from [registry.terraform.io](https://registry.terraform.io) or [custom source addresses](https://developer.hashicorp.com/terraform/language/providers/requirements#source-addresses) specified in each template | [Custom source addresses](https://developer.hashicorp.com/terraform/language/providers/requirements#source-addresses) can be specified in each Coder template, or a custom registry/mirror can be used. More details below                                                  |
+| STUN               | By default, Coder uses Google's public STUN server for direct workspace connections                                                                                                                                                                                | STUN can be safely [disabled](../cli/server.md#--derp-server-stun-addresses), users can still connect via [relayed connections](../networking/index.md#-geo-distribution). Alternatively, you can set a [custom DERP server](../cli/server.md#--derp-server-stun-addresses) |
+| DERP               | By default, Coder's built-in DERP relay can be used, or [Tailscale's public relays](../networking/index.md#relayed-connections).                                                                                                                                   | By default, Coder's built-in DERP relay can be used, or [custom relays](../networking/index.md#custom-relays).                                                                                                                                                              |
+| PostgreSQL         | If no [PostgreSQL connection URL](../cli/server.md#--postgres-url) is specified, Coder will download Postgres from [repo1.maven.org](https://repo1.maven.org)                                                                                                      | An external database is required, you must specify a [PostgreSQL connection URL](../cli/server.md#--postgres-url)                                                                                                                                                           |
+| Telemetry          | Telemetry is on by default, and [can be disabled](../cli/server.md#--telemetry)                                                                                                                                                                                    | Telemetry [can be disabled](../cli/server.md#--telemetry)                                                                                                                                                                                                                   |
+| Update check       | By default, Coder checks for updates from [GitHub releases](https:/github.com/coder/coder/releases)                                                                                                                                                                | Update checks [can be disabled](../cli/server.md#--update-check)                                                                                                                                                                                                            |
 
 ## Offline container images
 
diff --git a/docs/install/packages.md b/docs/install/packages.md
@@ -38,4 +38,4 @@ sudo systemctl restart coder
 ## Next steps
 
 - [Configuring Coder](../admin/configure.md)
-- [Templates](../templates/README.md)
+- [Templates](../templates/index.md)
diff --git a/docs/install/windows.md b/docs/install/windows.md
@@ -31,4 +31,4 @@ Use the Windows installer to download the CLI and add Coder to `PATH`. Alternati
 ## Next steps
 
 - [Configuring Coder](../admin/configure.md)
-- [Templates](../templates/README.md)
+- [Templates](../templates/index.md)
diff --git a/docs/manifest.json b/docs/manifest.json
@@ -125,7 +125,7 @@
     {
       "title": "Templates",
       "description": "Learn about templates, which define the infrastructure underlying workspaces",
-      "path": "./templates/README.md",
+      "path": "./templates/index.md",
       "icon_path": "./images/icons/picture.svg",
       "children": [
         {
@@ -216,7 +216,7 @@
     {
       "title": "Networking",
       "description": "Learn about networking in Coder",
-      "path": "./networking/README.md",
+      "path": "./networking/index.md",
       "icon_path": "./images/icons/networking.svg",
       "children": [
         {
diff --git a/docs/networking/index.md b/docs/networking/index.md
diff --git a/docs/platforms/aws.md b/docs/platforms/aws.md
@@ -58,6 +58,6 @@ From there, you can import the AWS starter template in the dashboard and begin c
 ## Next steps
 
 - [IDEs with Coder](../ides.md)
-- [Writing custom templates for Coder](../templates/README.md)
+- [Writing custom templates for Coder](../templates/index.md)
 - [Configure the Coder server](../admin/configure.md)
 - [Use your own domain + TLS](../admin/configure.md#tls--reverse-proxy)
diff --git a/docs/platforms/azure.md b/docs/platforms/azure.md
@@ -105,5 +105,5 @@ Congrats! You can now navigate to your Coder dashboard and use this Linux on Azu
 ## Next Steps
 
 - [Port-forward](../networking/port-forwarding.md)
-- [Learn more about template configuration](../templates/README.md)
+- [Learn more about template configuration](../templates/index.md)
 - [Configure more IDEs](../ides/web-ides.md)
diff --git a/docs/platforms/docker.md b/docs/platforms/docker.md
@@ -74,7 +74,7 @@ Coder with Docker has the following advantages:
 
 ### Docker-based workspace is stuck in "Connecting..."
 
-Ensure you have an externally-reachable `CODER_ACCESS_URL` set. See [troubleshooting templates](../templates/README.md#Troubleshooting) for more steps.
+Ensure you have an externally-reachable `CODER_ACCESS_URL` set. See [troubleshooting templates](../templates/index.md#Troubleshooting) for more steps.
 
 ### Permission denied while trying to connect to the Docker daemon socket
 
@@ -83,5 +83,5 @@ See Docker's official documentation to [Manage Docker as a non-root user](https:
 ## Next Steps
 
 - [Port-forward](../networking/port-forwarding.md)
-- [Learn more about template configuration](../templates/README.md)
+- [Learn more about template configuration](../templates/index.md)
 - [Configure more IDEs](../ides/web-ides.md)
diff --git a/docs/platforms/google-cloud-platform.md b/docs/platforms/google-cloud-platform.md
@@ -110,5 +110,5 @@ Congrats! You can now create new Linux-based workspaces that use Google Cloud Pl
 
 ## Next Steps
 
-- [Learn more about template configuration](../templates/README.md)
+- [Learn more about template configuration](../templates/index.md)
 - [Configure more IDEs](../ides/web-ides.md)
diff --git a/docs/platforms/other.md b/docs/platforms/other.md
@@ -8,4 +8,4 @@ The following resources may help as you're deploying Coder.
 - [Run Coder as a system service](../install/packages.md)
 - [Deploy Coder offline](../install/offline.md)
 - [Supported resources (Terraform registry)](https://registry.terraform.io)
-- [Writing custom templates](../templates/README.md)
+- [Writing custom templates](../templates/index.md)
diff --git a/docs/templates/index.md b/docs/templates/index.md
diff --git a/docs/templates/resource-persistence.md b/docs/templates/resource-persistence.md
diff --git a/docs/workspaces.md b/docs/workspaces.md
