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.

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
Show file tree
Hide file tree
Changes from 1 commit
Commits
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
Next Next commit
fixing a lot of broken links
  • Loading branch information
matifali committed Apr 14, 2023
commit df8864a3b72d4b595e33d78dc584d2facd315a9c
2 changes: 1 addition & 1 deletion docs/README.md
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
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/ides.md
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
6 changes: 3 additions & 3 deletions docs/networking/README.md
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
2 changes: 1 addition & 1 deletion docs/platforms/aws.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
2 changes: 1 addition & 1 deletion docs/platforms/azure.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
4 changes: 2 additions & 2 deletions docs/platforms/docker.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand All @@ -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)
2 changes: 1 addition & 1 deletion docs/platforms/google-cloud-platform.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
2 changes: 1 addition & 1 deletion docs/platforms/other.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
2 changes: 1 addition & 1 deletion docs/secrets.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down
8 changes: 3 additions & 5 deletions docs/workspaces.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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
Expand Down