Skip to content

Commit 0e50afe

Browse files
matifalimatifali
authored
fix(docs): fix broken docs (#7138)
* fixing a lot of broken links * more fixes * add 0 as valid status codes https://tools.ietf.org/html/rfc7231#section-6.3.1 --> 0 as status code
1 parent 9ec16d4 commit 0e50afe

26 files changed

+55
-57
lines changed

‎.github/workflows/mlc_config.json

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,5 +18,6 @@
1818
{
1919
"pattern": "tailscale.com"
2020
}
21-
]
21+
],
22+
"aliveStatusCodes": [200, 0]
2223
}

‎docs/README.md

Lines changed: 1 addition & 1 deletion
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.md)
31+
[Learn more about managing infrastructure.](./templates/README.md)
3232

3333
## IDE Support
3434

‎docs/about/architecture.md

Lines changed: 1 addition & 1 deletion
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.md#coder-agent) within workspaces.
43+
Templates are responsible for [creating and running agents](../templates/README.md#coder-agent) within workspaces.
4444

4545
## Service Bundling
4646

‎docs/admin/configure.md

Lines changed: 1 addition & 1 deletion
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.md#coder-apps) on an absolute path. Set this to a wildcard
38+
via the dashboard or running [coder_apps](../templates/README.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, you must use a single certificate for the

‎docs/admin/high-availability.md

Lines changed: 2 additions & 2 deletions
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.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/README.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.md)
60+
- [Networking](../networking/README.md)
6161
- [Kubernetes](../install/kubernetes.md)
6262
- [Enterprise](../enterprise.md)

‎docs/admin/provisioners.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -83,7 +83,7 @@ docker run --rm -it \
8383

8484
## Disable built-in provisioners
8585

86-
As mentioned above, the Coder server will run built-in provisioners by default. This can be disabled with a server-wide [flag or environment variable](../cli/coder_server.md#provisioner-daemons).
86+
As mentioned above, the Coder server will run built-in provisioners by default. This can be disabled with a server-wide [flag or environment variable](../cli/server.md#provisioner-daemons).
8787

8888
```sh
8989
coder server --provisioner-daemons=0

‎docs/enterprise.md

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -4,18 +4,18 @@ Coder is free to use and includes some features that are only accessible with a
44
[Contact Sales](https://coder.com/contact) for pricing or [get a free
55
trial](https://coder.com/trial).
66

7-
| Category | Feature | Open Source | Enterprise |
8-
| --------------- | ------------------------------------------------------------------------- | :---------: | :--------: |
9-
| User Management | [Groups](./admin/groups.md) | ❌ | ✅ |
10-
| User Management | [SCIM](./admin/auth.md#scim) | ❌ | ✅ |
11-
| Governance | [Audit Logging](./admin/audit-logs.md) | ❌ | ✅ |
12-
| Governance | [Browser Only Connections](./networking.md#browser-only-connections) | ❌ | ✅ |
13-
| Governance | [Template Access Control](./admin/rbac.md) | ❌ | ✅ |
14-
| Cost Control | [Quotas](./admin/quotas.md) | ❌ | ✅ |
15-
| Cost Control | [Max Workspace Autostop](./templates.md#configure-max-workspace-autostop) | ❌ | ✅ |
16-
| Deployment | [High Availability](./admin/high-availability.md) | ❌ | ✅ |
17-
| Deployment | [Service Banners](./admin/service-banners.md) | ❌ | ✅ |
18-
| Deployment | Isolated Terraform Runners | ❌ | ✅ |
7+
| Category | Feature | Open Source | Enterprise |
8+
| --------------- | -------------------------------------------------------------------------------- | :---------: | :--------: |
9+
| User Management | [Groups](./admin/groups.md) | ❌ | ✅ |
10+
| User Management | [SCIM](./admin/auth.md#scim) | ❌ | ✅ |
11+
| Governance | [Audit Logging](./admin/audit-logs.md) | ❌ | ✅ |
12+
| Governance | [Browser Only Connections](./networking/README.md#browser-only-connections) | ❌ | ✅ |
13+
| Governance | [Template Access Control](./admin/rbac.md) | ❌ | ✅ |
14+
| Cost Control | [Quotas](./admin/quotas.md) | ❌ | ✅ |
15+
| Cost Control | [Max Workspace Autostop](./templates/README.md#configure-max-workspace-autostop) | ❌ | ✅ |
16+
| Deployment | [High Availability](./admin/high-availability.md) | ❌ | ✅ |
17+
| Deployment | [Service Banners](./admin/service-banners.md) | ❌ | ✅ |
18+
| Deployment | Isolated Terraform Runners | ❌ | ✅ |
1919

2020
> Previous plans to restrict OIDC and Git Auth features in OSS have been removed
2121
> as of 2023-01-11

‎docs/ides.md

Lines changed: 1 addition & 1 deletion
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.md#browser-only-connections-enterprise).
25+
> The `VS Code Desktop` button can be hidden by enabling [Browser-only connections](./networking/README.md#Browser-only).
2626
2727
### Manual Installation
2828

‎docs/install/binary.md

Lines changed: 1 addition & 1 deletion
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.md)
33+
- [Templates](../templates/README.md)

‎docs/install/database.md

Lines changed: 1 addition & 1 deletion
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.md)
87+
- [Templates](../templates/README.md)

‎docs/install/docker.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -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.md)
100+
- [Templates](../templates/README.md)

‎docs/install/install.sh.md

Lines changed: 1 addition & 1 deletion
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.md)
28+
- [Templates](../templates/README.md)

‎docs/install/kubernetes.md

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

167-
See [troubleshooting templates](../templates.md#creating-and-troubleshooting-templates) for more steps.
167+
See [troubleshooting templates](../templates/README.md#troubleshooting-templates) for more steps.
168168

169169
## Next steps
170170

171171
- [Configuring Coder](../admin/configure.md)
172-
- [Templates](../templates.md)
172+
- [Templates](../templates/README.md)

‎docs/install/offline.md

Lines changed: 9 additions & 9 deletions
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.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.md#relayed-connections). | By default, Coder's built-in DERP relay can be used, or [custom relays](../networking.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/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) |
1616

1717
## Offline container images
1818

‎docs/install/packages.md

Lines changed: 1 addition & 1 deletion
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.md)
41+
- [Templates](../templates/README.md)

‎docs/install/windows.md

Lines changed: 1 addition & 1 deletion
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.md)
34+
- [Templates](../templates/README.md)

‎docs/networking/README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ All user <-> workspace connections are end-to-end encrypted.
1616
## coder server
1717

1818
Workspaces connect to the coder server via the server's external address,
19-
set via [`ACCESS_URL`](./admin/configure.md#access-url). There must not be a
19+
set via [`ACCESS_URL`](../admin/configure.md#access-url). There must not be a
2020
NAT between workspaces and coder server.
2121

2222
Users connect to the coder server's dashboard and API through its `ACCESS_URL`
@@ -39,7 +39,7 @@ the Coder server.
3939
The coder servers relays dashboard-initiated connections between the user and
4040
the workspace. Web terminal <-> workspace connections are an exception and may be direct.
4141

42-
In general, [port forwarded](./networking/port-forwarding.md) web apps are
42+
In general, [port forwarded](./port-forwarding.md) web apps are
4343
faster than dashboard-accessed web apps.
4444

4545
## 🌎 Geo-distribution
@@ -51,7 +51,7 @@ is no special geo-distribution configuration. To speed up direct connections,
5151
move the user and workspace closer together.
5252

5353
If a direct connection is not available (e.g. client or server is behind NAT), Coder
54-
will use a relayed connection. By default, [Coder uses Google's public STUN server](../cli/server#--derp-server-stun-addresses), but
54+
will use a relayed connection. By default, [Coder uses Google's public STUN server](../cli/server.md#--derp-server-stun-addresses), but
5555
this can be disabled or changed for [offline deployments](../install/offline.md).
5656

5757
### Relayed connections

0 commit comments

Comments
 (0)