Skip to content

Commit 9eefd2a

Browse files
stirbymatifali
andauthored
chore(docs): correct broken links in restructure (#14989)
Co-authored-by: Muhammad Atif Ali <atif@coder.com>
1 parent 163f96b commit 9eefd2a

File tree

11 files changed

+26
-21
lines changed

11 files changed

+26
-21
lines changed

docs/CONTRIBUTING.md

+9-6
Original file line numberDiff line numberDiff line change
@@ -247,20 +247,23 @@ be applied selectively or to discourage anyone from contributing.
247247

248248
## Releases
249249

250-
Coder releases are initiated via [`./scripts/release.sh`](../scripts/release.sh)
250+
Coder releases are initiated via
251+
[`./scripts/release.sh`](https://github.com/coder/coder/blob/main/scripts/release.sh)
251252
and automated via GitHub Actions. Specifically, the
252-
[`release.yaml`](../.github/workflows/release.yaml) workflow. They are created
253-
based on the current [`main`](https://github.com/coder/coder/tree/main) branch.
253+
[`release.yaml`](https://github.com/coder/coder/blob/main/.github/workflows/release.yaml)
254+
workflow. They are created based on the current
255+
[`main`](https://github.com/coder/coder/tree/main) branch.
254256

255257
The release notes for a release are automatically generated from commit titles
256258
and metadata from PRs that are merged into `main`.
257259

258260
### Creating a release
259261

260262
The creation of a release is initiated via
261-
[`./scripts/release.sh`](../scripts/release.sh). This script will show a preview
262-
of the release that will be created, and if you choose to continue, create and
263-
push the tag which will trigger the creation of the release via GitHub Actions.
263+
[`./scripts/release.sh`](https://github.com/coder/coder/blob/main/scripts/release.sh).
264+
This script will show a preview of the release that will be created, and if you
265+
choose to continue, create and push the tag which will trigger the creation of
266+
the release via GitHub Actions.
264267

265268
See `./scripts/release.sh --help` for more information.
266269

docs/admin/infrastructure/validated-architectures/index.md

+2-1
Original file line numberDiff line numberDiff line change
@@ -324,7 +324,8 @@ could affect workspace users experience once the platform is live.
324324

325325
### Helm Chart Configuration
326326

327-
1. Reference our [Helm chart values file](../../../../helm/coder/values.yaml)
327+
1. Reference our
328+
[Helm chart values file](https://github.com/coder/coder/blob/main/helm/coder/values.yaml)
328329
and identify the required values for deployment.
329330
1. Create a `values.yaml` and add it to your version control system.
330331
1. Determine the necessary environment variables. Here is the

docs/admin/security/secrets.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
<blockquote class="info">
44
This article explains how to use secrets in a workspace. To authenticate the
5-
workspace provisioner, see <a href="/admin/auth">this</a>.
5+
workspace provisioner, see <a href="../users">this</a>.
66
</blockquote>
77

88
Coder is open-minded about how you get your secrets into your workspaces.

docs/admin/setup/index.md

+1-5
Original file line numberDiff line numberDiff line change
@@ -59,11 +59,7 @@ If you are providing TLS certificates directly to the Coder server, either
5959

6060
The Coder server can directly use TLS certificates with `CODER_TLS_ENABLE` and
6161
accompanying configuration flags. However, Coder can also run behind a
62-
reverse-proxy to terminate TLS certificates from LetsEncrypt, for example.
63-
64-
- [Apache](./web-server/apache/index.md)
65-
- [Caddy](./web-server/caddy/index.md)
66-
- [NGINX](./web-server/nginx/index.md)
62+
reverse-proxy to terminate TLS certificates from LetsEncrypt.
6763

6864
### Kubernetes TLS configuration
6965

docs/admin/templates/extending-templates/modules.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -61,7 +61,7 @@ In offline and restricted deploymnets, there are 2 ways to fetch modules.
6161

6262
### Artifactory
6363

64-
Air gapped users can clone the [coder/modules](htpps://github.com/coder/modules)
64+
Air gapped users can clone the [coder/modules](https://github.com/coder/modules)
6565
repo and publish a
6666
[local terraform module repository](https://jfrog.com/help/r/jfrog-artifactory-documentation/set-up-a-terraform-module/provider-registry)
6767
to resolve modules via [Artifactory](https://jfrog.com/artifactory/).

docs/install/cloud/ec2.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -82,7 +82,7 @@ creating VM-based workspaces.
8282

8383
![Modify IAM role](../../images/platforms/aws/aws-linux.png)
8484

85-
## Next steps
85+
### Next steps
8686

8787
- [IDEs with Coder](../../user-guides/workspace-access/index.md)
8888
- [Writing custom templates for Coder](../../admin/templates/index.md)

docs/install/index.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -62,7 +62,7 @@ To log in to an existing Coder deployment:
6262
coder login https://coder.example.com
6363
```
6464

65-
## Next up
65+
## Next steps
6666

67-
- [Create your first template](../start/first-template.md)
67+
- [Set up your first deployment](../start/coder-tour.md)
6868
- [Expose your control plane to other users](../admin/setup/index.md)

docs/install/kubernetes.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# Install Coder on Kubernetes
22

33
You can install Coder on Kubernetes using Helm. We run on most Kubernetes
4-
distributions, including [OpenShift](./other/openshift.md).
4+
distributions, including [OpenShift](./other.md).
55

66
## Requirements
77

docs/install/offline.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ environments. However, some changes to your configuration are necessary.
1414
| DERP | By default, Coder's built-in DERP relay can be used, or [Tailscale's public relays](../admin/networking/index.md#relayed-connections). | By default, Coder's built-in DERP relay can be used, or [custom relays](../admin/networking/index.md#custom-relays). |
1515
| PostgreSQL | If no [PostgreSQL connection URL](../reference/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](../reference/cli/server.md#--postgres-url) |
1616
| Telemetry | Telemetry is on by default, and [can be disabled](../reference/cli/server.md#--telemetry) | Telemetry [can be disabled](../reference/cli/server.md#--telemetry) |
17-
| Update check | By default, Coder checks for updates from [GitHub releases](https:/github.com/coder/coder/releases) | Update checks [can be disabled](../reference/cli/server.md#--update-check) |
17+
| Update check | By default, Coder checks for updates from [GitHub releases](https://github.com/coder/coder/releases) | Update checks [can be disabled](../reference/cli/server.md#--update-check) |
1818

1919
## Offline container images
2020

docs/manifest.json

+6-1
Original file line numberDiff line numberDiff line change
@@ -100,7 +100,7 @@
100100
"title": "Releases",
101101
"description": "Learn about the Coder release channels and schedule",
102102
"path": "./install/releases.md",
103-
"icon_path": "./images/icons/trash.svg"
103+
"icon_path": "./images/icons/star.svg"
104104
}
105105
]
106106
},
@@ -145,6 +145,11 @@
145145
"title": "Filebrowser",
146146
"description": "Access your workspace files",
147147
"path": "./user-guides/workspace-access/filebrowser.md"
148+
},
149+
{
150+
"title": "Web IDEs and Coder Apps",
151+
"description": "Access your workspace with IDEs in the browser",
152+
"path": "./user-guides/workspace-access/web-ides.md"
148153
}
149154
]
150155
},

docs/user-guides/workspace-access/jetbrains.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ manually setting up an SSH connection.
4040

4141
![Gateway Connect to Coder](../../images/gateway/plugin-connect-to-coder.png)
4242

43-
1. Enter your Coder deployment'ssetup/index.md
43+
1. Enter your Coder deployment's
4444
[Access Url](../../admin/setup/index.md#access-url) and click **Connect**.
4545

4646
Gateway opens your Coder deployment's `cli-auth` page with a session token.

0 commit comments

Comments
 (0)