shishantbiswas/coder
1
0
Fork 0
mirror of https://github.com/coder/coder.git synced 2026-06-02 20:48:20 +00:00
Code Issues Packages Projects Releases Wiki Activity

fix(docs): fix broken docs (#7138)

Browse Source 
* 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
This commit is contained in:
Muhammad Atif Ali
2023-04-14 19:11:51 +03:00
committed by GitHub
parent 9ec16d4454
commit 0e50afe4cf
26 changed files with 55 additions and 57 deletions
Download Patch File Download Diff File Expand all files Collapse all files
.github/workflows/mlc_config.json
+2 -1
View File
@@ -18,5 +18,6 @@
{
"pattern": "tailscale.com"
}
]
],
"aliveStatusCodes": [200, 0]
}
docs/README.md
+1 -1
View File
@@ -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
docs/about/architecture.md
+1 -1
View File
@@ -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
docs/admin/configure.md
+1 -1
View File
@@ -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
docs/admin/high-availability.md
+2 -2
View File
@@ -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.
@@ -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)
docs/admin/provisioners.md
+1 -1
View File
@@ -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
docs/enterprise.md
+12 -12
View File
@@ -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
docs/ides.md
+1 -1
View File
@@ -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
docs/install/binary.md
+1 -1
View File
@@ -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)
docs/install/database.md
+1 -1
View File
@@ -84,4 +84,4 @@ psql -U coder -c '\dn'
## Next steps
- [Configuring Coder](../admin/configure.md)
- [Templates](../templates.md)
- [Templates](../templates/README.md)
docs/install/docker.md
+1 -1
View File
@@ -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)
docs/install/install.sh.md
+1 -1
View File
@@ -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)
docs/install/kubernetes.md
+2 -2
View File
@@ -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)
docs/install/offline.md
+9 -9
View File
@@ -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
docs/install/packages.md
+1 -1
View File
@@ -38,4 +38,4 @@ sudo systemctl restart coder
## Next steps
- [Configuring Coder](../admin/configure.md)
- [Templates](../templates.md)
- [Templates](../templates/README.md)
docs/install/windows.md
+1 -1
View File
@@ -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)
docs/networking/README.md
+3 -3
View File
@@ -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`
@@ -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
@@ -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
docs/platforms/aws.md
+1 -1
View File
@@ -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.md)
- [Writing custom templates for Coder](../templates/README.md)
- [Configure the Coder server](../admin/configure.md)
- [Use your own domain + TLS](../admin/configure.md#tls--reverse-proxy)
docs/platforms/azure.md
+1 -1
View File
@@ -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.md)
- [Learn more about template configuration](../templates/README.md)
- [Configure more IDEs](../ides/web-ides.md)
docs/platforms/docker.md
+2 -2
View File
@@ -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.md#creating-and-troubleshooting-templates) for more steps.
Ensure you have an externally-reachable `CODER_ACCESS_URL` set. See [troubleshooting templates](../templates/README.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.md)
- [Learn more about template configuration](../templates/README.md)
- [Configure more IDEs](../ides/web-ides.md)
docs/platforms/google-cloud-platform.md
+1 -1
View File
@@ -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.md)
- [Learn more about template configuration](../templates/README.md)
- [Configure more IDEs](../ides/web-ides.md)
docs/platforms/other.md
+1 -1
View File
@@ -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.md)
- [Writing custom templates](../templates/README.md)
docs/secrets.md
+1 -1
View File
@@ -20,7 +20,7 @@ Often, this workflow is simply:
1. Your users write them to a persistent file after
they've built their workspace
[Template parameters](./templates.md#parameters) are a dangerous way to accept secrets.
[Template parameters](./templates/parameters.md) are a dangerous way to accept secrets.
We show parameters in cleartext around the product. Assume anyone with view
access to a workspace can also see its parameters.
docs/templates/README.md
Vendored
+3 -4
View File
@@ -4,8 +4,7 @@ Templates are written in [Terraform](https://www.terraform.io/) and describe the
infrastructure for workspaces (e.g., docker_container, aws_instance,
kubernetes_pod).
In most cases, a small group of users (team leads or Coder administrators) [have
permissions](./admin/users.md#roles) to create and manage templates. Then, other
In most cases, a small group of users (team leads or Coder administrators) [have permissions](../admin/users.md#roles) to create and manage templates. Then, other
users provision their [workspaces](../workspaces.md) from templates using the UI
or CLI.
@@ -403,7 +402,7 @@ resource "coder_agent" "main" {
## Template permissions (enterprise)
Template permissions can be used to give users and groups access to specific
templates. [Learn more about RBAC](./admin/rbac.md).
templates. [Learn more about RBAC](../admin/rbac.md) to learn how to manage
## Community Templates
@@ -415,4 +414,4 @@ You can see a list of community templates by our users
- Learn about [Authentication & Secrets](./authentication.md)
- Learn about [Change Management](./change-management.md)
- Learn about [Resource Metadata](./resource-metadata.md)
- Learn about [Workspaces](./workspaces.md)
- Learn about [Workspaces](../workspaces.md)
docs/templates/resource-persistence.md
Vendored
+1 -1
View File
@@ -87,4 +87,4 @@ resource "docker_volume" "home_volume" {
## Up next
- [Templates](../templates.md)
- [Templates](../templates/README.md)
docs/workspaces.md
+3 -5
View File
@@ -5,8 +5,7 @@ for software development.
## Create workspaces
Each Coder user has their own workspaces created from [shared
templates](./templates.md):
Each Coder user has their own workspaces created from [shared templates](./templates/README.md):
```console
# create a workspace from the template; specify any variables
@@ -18,13 +17,12 @@ coder show <workspace-name>
## IDEs
Coder [supports multiple IDEs](ides.md) for use with your workspaces.
Coder [supports multiple IDEs](./ides.md) for use with your workspaces.
## Workspace lifecycle
Workspaces in Coder are started and stopped, often based on whether there was
any activity or if there was a [template
update](./templates.md#start/stop) available.
any activity or if there was a [template update](./templates/README.md#Start/stop) available.
Resources are often destroyed and re-created when a workspace is restarted,
though the exact behavior depends on the template. For more