Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Commit 6715cb6

Browse files
ericpaulsenericpaulsen
authored
docs: resolve README 404s (coder#7822)
1 parent edccd2d commit 6715cb6

23 files changed

+457
-36
lines changed

‎docs/README.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ product.
2828
Coder workspaces don't stop at compute. You can add storage buckets, secrets, sidecars
2929
and whatever else Terraform lets you dream up.
3030

31-
[Learn more about managing infrastructure.](./templates/README.md)
31+
[Learn more about managing infrastructure.](./templates/index.md)
3232

3333
## IDE Support
3434

@@ -104,5 +104,5 @@ Azure, Google Cloud, Kubernetes, and more.
104104

105105
## Up next
106106

107-
- Learn about [Templates](./templates/README.md)
107+
- Learn about [Templates](./templates/index.md)
108108
- [Install Coder](./install/install.sh.md)

‎docs/about/architecture.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ It offers the following services along with much more:
4040
- Liveness checks
4141
- `startup_script` automation
4242

43-
Templates are responsible for [creating and running agents](../templates/README.md#coder-agent) within workspaces.
43+
Templates are responsible for [creating and running agents](../templates/index.md#coder-agent) within workspaces.
4444

4545
## Service Bundling
4646

‎docs/admin/configure.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ coder server
3535
## Wildcard access URL
3636

3737
`CODER_WILDCARD_ACCESS_URL` is necessary for [port forwarding](../networking/port-forwarding.md#dashboard)
38-
via the dashboard or running [coder_apps](../templates/README.md#coder-apps) on an absolute path. Set this to a wildcard
38+
via the dashboard or running [coder_apps](../templates/index.md#coder-apps) on an absolute path. Set this to a wildcard
3939
subdomain that resolves to Coder (e.g. `*.coder.example.com`).
4040

4141
If you are providing TLS certificates directly to the Coder server, either

‎docs/admin/high-availability.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ to the same Postgres endpoint.
2121
HA brings one configuration variable to set in each Coder
2222
node: `CODER_DERP_SERVER_RELAY_URL`. The HA nodes use these URLs to communicate
2323
with each other. Inter-node communication is only required while using the
24-
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.
24+
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.
2525

2626
`CODER_DERP_SERVER_RELAY_URL` will never be `CODER_ACCESS_URL` because
2727
`CODER_ACCESS_URL` is a load balancer to all Coder nodes.
@@ -57,6 +57,6 @@ Then, increase the number of pods.
5757
5858
## Up next
5959
60-
- [Networking](../networking/README.md)
60+
- [Networking](../networking/index.md)
6161
- [Kubernetes](../install/kubernetes.md)
6262
- [Enterprise](../enterprise.md)

‎docs/ides.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ Click `VS Code Desktop` in the dashboard to one-click enter a workspace. This au
2222

2323
![Demo](https://github.com/coder/vscode-coder/raw/main/demo.gif?raw=true)
2424

25-
> The `VS Code Desktop` button can be hidden by enabling [Browser-only connections](./networking/README.md#Browser-only).
25+
> The `VS Code Desktop` button can be hidden by enabling [Browser-only connections](./networking/index.md#Browser-only).
2626
2727
### Manual Installation
2828

‎docs/install/binary.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -30,4 +30,4 @@ Coder publishes self-contained .zip and .tar.gz archives in [GitHub releases](ht
3030
## Next steps
3131

3232
- [Configuring Coder](../admin/configure.md)
33-
- [Templates](../templates/README.md)
33+
- [Templates](../templates/index.md)

‎docs/install/database.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -84,4 +84,4 @@ psql -U coder -c '\dn'
8484
## Next steps
8585

8686
- [Configuring Coder](../admin/configure.md)
87-
- [Templates](../templates/README.md)
87+
- [Templates](../templates/index.md)

‎docs/install/docker.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -88,7 +88,7 @@ an PostgreSQL container and volume.
8888

8989
### Docker-based workspace is stuck in "Connecting..."
9090

91-
Ensure you have an externally-reachable `CODER_ACCESS_URL` set. See [troubleshooting templates](../templates/README.md#troubleshooting-templates) for more steps.
91+
Ensure you have an externally-reachable `CODER_ACCESS_URL` set. See [troubleshooting templates](../templates/index.md#troubleshooting-templates) for more steps.
9292

9393
### Permission denied while trying to connect to the Docker daemon socket
9494

@@ -97,4 +97,4 @@ See Docker's official documentation to [Manage Docker as a non-root user](https:
9797
## Next steps
9898

9999
- [Configuring Coder](../admin/configure.md)
100-
- [Templates](../templates/README.md)
100+
- [Templates](../templates/index.md)

‎docs/install/install.sh.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -25,4 +25,4 @@ By default, the Coder server runs on `http://127.0.0.1:3000` and uses a [public
2525
## Next steps
2626

2727
- [Configuring Coder](../admin/configure.md)
28-
- [Templates](../templates/README.md)
28+
- [Templates](../templates/index.md)

‎docs/install/kubernetes.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -176,9 +176,9 @@ Cloud's log management system if you are using managed Kubernetes.
176176
Ensure you have an externally-reachable `CODER_ACCESS_URL` set in your helm chart. If you do not have a domain set up,
177177
this should be the IP address of Coder's LoadBalancer (`kubectl get svc -n coder`).
178178

179-
See [troubleshooting templates](../templates/README.md#troubleshooting-templates) for more steps.
179+
See [troubleshooting templates](../templates/index.md#troubleshooting-templates) for more steps.
180180

181181
## Next steps
182182

183183
- [Configuring Coder](../admin/configure.md)
184-
- [Templates](../templates/README.md)
184+
- [Templates](../templates/index.md)

‎docs/install/offline.md

+9-9
Original file line numberDiff line numberDiff line change
@@ -4,15 +4,15 @@ All Coder features are supported in offline / behind firewalls / in air-gapped e
44

55
> This is a general comparison. Keep reading for a full tutorial running Coder offline with Kubernetes or Docker.
66
7-
| | Public deployments | Offline deployments |
8-
| ------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
9-
| 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) |
10-
| 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 |
11-
| 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) |
12-
| 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). |
13-
| 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) |
14-
| Telemetry | Telemetry is on by default, and [can be disabled](../cli/server.md#--telemetry) | Telemetry [can be disabled](../cli/server.md#--telemetry) |
15-
| 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) |
7+
| | Public deployments | Offline deployments |
8+
| ------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
9+
| 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) |
10+
| 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 |
11+
| 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) |
12+
| 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). |
13+
| 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) |
14+
| Telemetry | Telemetry is on by default, and [can be disabled](../cli/server.md#--telemetry) | Telemetry [can be disabled](../cli/server.md#--telemetry) |
15+
| 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) |
1616

1717
## Offline container images
1818

‎docs/install/packages.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -38,4 +38,4 @@ sudo systemctl restart coder
3838
## Next steps
3939

4040
- [Configuring Coder](../admin/configure.md)
41-
- [Templates](../templates/README.md)
41+
- [Templates](../templates/index.md)

‎docs/install/windows.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -31,4 +31,4 @@ Use the Windows installer to download the CLI and add Coder to `PATH`. Alternati
3131
## Next steps
3232

3333
- [Configuring Coder](../admin/configure.md)
34-
- [Templates](../templates/README.md)
34+
- [Templates](../templates/index.md)

‎docs/manifest.json

+2-2
Original file line numberDiff line numberDiff line change
@@ -125,7 +125,7 @@
125125
{
126126
"title": "Templates",
127127
"description": "Learn about templates, which define the infrastructure underlying workspaces",
128-
"path": "./templates/README.md",
128+
"path": "./templates/index.md",
129129
"icon_path": "./images/icons/picture.svg",
130130
"children": [
131131
{
@@ -216,7 +216,7 @@
216216
{
217217
"title": "Networking",
218218
"description": "Learn about networking in Coder",
219-
"path": "./networking/README.md",
219+
"path": "./networking/index.md",
220220
"icon_path": "./images/icons/networking.svg",
221221
"children": [
222222
{

‎docs/networking/README.md renamed to ‎docs/networking/index.md

File renamed without changes.

‎docs/platforms/aws.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -58,6 +58,6 @@ From there, you can import the AWS starter template in the dashboard and begin c
5858
## Next steps
5959

6060
- [IDEs with Coder](../ides.md)
61-
- [Writing custom templates for Coder](../templates/README.md)
61+
- [Writing custom templates for Coder](../templates/index.md)
6262
- [Configure the Coder server](../admin/configure.md)
6363
- [Use your own domain + TLS](../admin/configure.md#tls--reverse-proxy)

‎docs/platforms/azure.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -105,5 +105,5 @@ Congrats! You can now navigate to your Coder dashboard and use this Linux on Azu
105105
## Next Steps
106106

107107
- [Port-forward](../networking/port-forwarding.md)
108-
- [Learn more about template configuration](../templates/README.md)
108+
- [Learn more about template configuration](../templates/index.md)
109109
- [Configure more IDEs](../ides/web-ides.md)

‎docs/platforms/docker.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -74,7 +74,7 @@ Coder with Docker has the following advantages:
7474

7575
### Docker-based workspace is stuck in "Connecting..."
7676

77-
Ensure you have an externally-reachable `CODER_ACCESS_URL` set. See [troubleshooting templates](../templates/README.md#Troubleshooting) for more steps.
77+
Ensure you have an externally-reachable `CODER_ACCESS_URL` set. See [troubleshooting templates](../templates/index.md#Troubleshooting) for more steps.
7878

7979
### Permission denied while trying to connect to the Docker daemon socket
8080

@@ -83,5 +83,5 @@ See Docker's official documentation to [Manage Docker as a non-root user](https:
8383
## Next Steps
8484

8585
- [Port-forward](../networking/port-forwarding.md)
86-
- [Learn more about template configuration](../templates/README.md)
86+
- [Learn more about template configuration](../templates/index.md)
8787
- [Configure more IDEs](../ides/web-ides.md)

‎docs/platforms/google-cloud-platform.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -110,5 +110,5 @@ Congrats! You can now create new Linux-based workspaces that use Google Cloud Pl
110110

111111
## Next Steps
112112

113-
- [Learn more about template configuration](../templates/README.md)
113+
- [Learn more about template configuration](../templates/index.md)
114114
- [Configure more IDEs](../ides/web-ides.md)

‎docs/platforms/other.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -8,4 +8,4 @@ The following resources may help as you're deploying Coder.
88
- [Run Coder as a system service](../install/packages.md)
99
- [Deploy Coder offline](../install/offline.md)
1010
- [Supported resources (Terraform registry)](https://registry.terraform.io)
11-
- [Writing custom templates](../templates/README.md)
11+
- [Writing custom templates](../templates/index.md)

0 commit comments

Comments
 (0)