Skip to content

fix(docs): fix broken docs #7138

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Apr 14, 2023
Merged

fix(docs): fix broken docs #7138

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
df8864a
fixing a lot of broken links
matifali Apr 14, 2023
c3190c2
more fixes
matifali Apr 14, 2023
4ac82fe
add 0 as valid status codes
matifali Apr 14, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion .github/workflows/mlc_config.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,5 +18,6 @@
{
"pattern": "tailscale.com"
}
]
],
"aliveStatusCodes": [200, 0]
}
2 changes: 1 addition & 1 deletion docs/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.md)
[Learn more about managing infrastructure.](./templates/README.md)

## IDE Support

Expand Down
2 changes: 1 addition & 1 deletion docs/about/architecture.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.md#coder-agent) within workspaces.
Templates are responsible for [creating and running agents](../templates/README.md#coder-agent) within workspaces.

## Service Bundling

Expand Down
2 changes: 1 addition & 1 deletion docs/admin/configure.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.md#coder-apps) on an absolute path. Set this to a wildcard
via the dashboard or running [coder_apps](../templates/README.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, you must use a single certificate for the
Expand Down
4 changes: 2 additions & 2 deletions docs/admin/high-availability.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.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/README.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.
Expand Down Expand Up @@ -57,6 +57,6 @@ Then, increase the number of pods.

## Up next

- [Networking](../networking.md)
- [Networking](../networking/README.md)
- [Kubernetes](../install/kubernetes.md)
- [Enterprise](../enterprise.md)
2 changes: 1 addition & 1 deletion docs/admin/provisioners.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -83,7 +83,7 @@ docker run --rm -it \

## Disable built-in provisioners

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).
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).

```sh
coder server --provisioner-daemons=0
Expand Down
24 changes: 12 additions & 12 deletions docs/enterprise.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,18 +4,18 @@ Coder is free to use and includes some features that are only accessible with a
[Contact Sales](https://coder.com/contact) for pricing or [get a free
trial](https://coder.com/trial).

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

> Previous plans to restrict OIDC and Git Auth features in OSS have been removed
> as of 2023-01-11
Expand Down
2 changes: 1 addition & 1 deletion docs/ides.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.md#browser-only-connections-enterprise).
> The `VS Code Desktop` button can be hidden by enabling [Browser-only connections](./networking/README.md#Browser-only).

### Manual Installation

Expand Down
2 changes: 1 addition & 1 deletion docs/install/binary.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.md)
- [Templates](../templates/README.md)
2 changes: 1 addition & 1 deletion docs/install/database.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -84,4 +84,4 @@ psql -U coder -c '\dn'
## Next steps

- [Configuring Coder](../admin/configure.md)
- [Templates](../templates.md)
- [Templates](../templates/README.md)
2 changes: 1 addition & 1 deletion docs/install/docker.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.md)
- [Templates](../templates/README.md)
2 changes: 1 addition & 1 deletion docs/install/install.sh.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.md)
- [Templates](../templates/README.md)
4 changes: 2 additions & 2 deletions docs/install/kubernetes.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -164,9 +164,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.md#creating-and-troubleshooting-templates) for more steps.
See [troubleshooting templates](../templates/README.md#troubleshooting-templates) for more steps.

## Next steps

- [Configuring Coder](../admin/configure.md)
- [Templates](../templates.md)
- [Templates](../templates/README.md)
18 changes: 9 additions & 9 deletions docs/install/offline.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.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.md#relayed-connections). | By default, Coder's built-in DERP relay can be used, or [custom relays](../networking.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/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) |

## Offline container images

Expand Down
2 changes: 1 addition & 1 deletion docs/install/packages.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,4 +38,4 @@ sudo systemctl restart coder
## Next steps

- [Configuring Coder](../admin/configure.md)
- [Templates](../templates.md)
- [Templates](../templates/README.md)
2 changes: 1 addition & 1 deletion docs/install/windows.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.md)
- [Templates](../templates/README.md)
6 changes: 3 additions & 3 deletions docs/networking/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.md#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`
Expand All @@ -39,7 +39,7 @@ the Coder server.
The coder servers relays dashboard-initiated connections between the user and
the workspace. Web terminal <-> workspace connections are an exception and may be direct.

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

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

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

### Relayed connections
Expand Down
Loading