Skip to content

Commit 91a8b1b

Browse files
stirbystirby
authored
chore: fix broken docs links (#11760)
* fixed broken install/packages.md link * fixed broken docs links * fixed admin/auth link * fixed example-guide links * replaced mitchell tweet with nix docs * make fmt * replaced private image with imgur
1 parent 3014777 commit 91a8b1b

File tree

14 files changed

+34
-32
lines changed

14 files changed

+34
-32
lines changed

‎docs/CONTRIBUTING.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,8 @@
44

55
We recommend using the [Nix](https://nix.dev/) package manager as it makes any
66
pain related to maintaining dependency versions
7-
[just disappear](https://twitter.com/mitchellh/status/1491102567296040961). Once
8-
nix [has been installed](https://nixos.org/download.html) the development
7+
[disappear](https://nixos.org/guides/how-nix-works). Once nix
8+
[has been installed](https://nixos.org/download.html) the development
99
environment can be _manually instantiated_ through the `nix-shell` command:
1010

1111
```shell

‎docs/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -105,4 +105,4 @@ Azure, Google Cloud, Kubernetes, and more.
105105
## Up next
106106

107107
- Learn about [Templates](./templates/index.md)
108-
- [Install Coder](./install/install.sh.md)
108+
- [Install Coder](./install/index.md#install-coder)

‎docs/admin/appearance.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ users of which network their Coder deployment is on.
3636

3737
## OIDC Login Button Customization
3838

39-
[Use environment variables to customize](../auth#oidc-login-customization) the
39+
[Use environment variables to customize](./auth.md#oidc-login-customization) the
4040
text and icon on the OIDC button on the Sign In page.
4141

4242
## Support Links

‎docs/admin/configure.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -130,8 +130,8 @@ steps:
130130

131131
## System packages
132132

133-
If you've installed Coder via a [system package](../install/packages.md) Coder,
134-
you can configure the server by setting the following variables in
133+
If you've installed Coder via a [system package](../install/index.md) Coder, you
134+
can configure the server by setting the following variables in
135135
`/etc/coder.d/coder.env`:
136136

137137
```env

‎docs/changelogs/v2.1.5.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@
1111

1212
- You can install Coder with
1313
[Homebrew](https://formulae.brew.sh/formula/coder#default) (#9414) (@aslilac).
14-
Our [install script](https://coder.com/docs/v2/latest/install/install.sh) will
14+
Our [install script](https://coder.com/docs/v2/latest/install#install-coder) will
1515
also use Homebrew, if present on your machine.
1616
- You can show/hide specific
1717
[display apps](https://registry.terraform.io/providers/coder/coder/latest/docs/resources/agent#nested-schema-for-display_apps)

‎docs/changelogs/v2.5.1.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

55
- Add metrics for workspace agent scripts (#11132) (@Emyrk)
66
- Add a user-configurable theme picker (#11140) (@aslilac)
7-
![Theme picker](https://github-production-user-asset-6210df.s3.amazonaws.com/22407953/290677070-14a5f3e3-b807-4091-851f-036821fca1a7.png)
7+
![Theme picker](https://i.imgur.com/rUAWz6B.png)
88
> A [light theme](https://github.com/coder/coder/issues/8396) is coming soon
99
- Various improvements to bulk delete flow (#11093) (@aslilac)
1010

‎docs/changelogs/v2.7.0.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ are backwards-compatible and have been tested significantly with the goal of imp
3636
- Add support for loading template variables from tfvars files (#11549) (@mtojek)
3737
- Expose support links as [env variables](https://coder.com/docs/v2/latest/cli/server#--support-links) (#11697) (@mtojek)
3838
- Allow custom icons in the "support links" navbar (#11629) (@mtojek)
39-
![Custom icons](https://private-user-images.githubusercontent.com/14044910/296802415-80e0f0a0-409f-43c9-9bf0-c915bf89eef2.png?jwt=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJnaXRodWIuY29tIiwiYXVkIjoicmF3LmdpdGh1YnVzZXJjb250ZW50LmNvbSIsImtleSI6ImtleTUiLCJleHAiOjE3MDU2ODAwOTAsIm5iZiI6MTcwNTY3OTc5MCwicGF0aCI6Ii8xNDA0NDkxMC8yOTY4MDI0MTUtODBlMGYwYTAtNDA5Zi00M2M5LTliZjAtYzkxNWJmODllZWYyLnBuZz9YLUFtei1BbGdvcml0aG09QVdTNC1ITUFDLVNIQTI1NiZYLUFtei1DcmVkZW50aWFsPUFLSUFWQ09EWUxTQTUzUFFLNFpBJTJGMjAyNDAxMTklMkZ1cy1lYXN0LTElMkZzMyUyRmF3czRfcmVxdWVzdCZYLUFtei1EYXRlPTIwMjQwMTE5VDE1NTYzMFomWC1BbXotRXhwaXJlcz0zMDAmWC1BbXotU2lnbmF0dXJlPTE0MTExYmEyMGMxMWFhNDlkMzczZjA1YmU2NzMyNjNlYWM1YzEwZDgyODEwOGM3MjMyZjY1YTM4NDg2NDYwZDMmWC1BbXotU2lnbmVkSGVhZGVycz1ob3N0JmFjdG9yX2lkPTAma2V5X2lkPTAmcmVwb19pZD0wIn0.YVtG5fBnwM5FbJ8zzkTXfYVSp7Ao0wrAkRSu2f66meM)
39+
![Custom icons](https://i.imgur.com/FvJ8mFH.png)
4040
- Add additional fields to first time setup trial flow (#11533) (@coadler)
4141
- Manage provisioner tags in template editor (#11600) (@f0ssel)
4242
- Add `coder open vscode` CLI command (#11191) (@mafredri)

‎docs/faqs.md

+5-5
Original file line numberDiff line numberDiff line change
@@ -17,8 +17,8 @@ In the UI, click the Deployment tab -> Licenses and upload the `jwt` license
1717
file.
1818

1919
> To add the license with the CLI, first
20-
> [install the Coder CLI](https://coder.com/docs/v2/latest/install/install.sh)
21-
> and server to the latest release.
20+
> [install the Coder CLI](./install/index.md#install-script) and server to the
21+
> latest release.
2222
2323
If the license is a text string:
2424

@@ -450,9 +450,9 @@ Starting Colima on a M3 Macbook Pro:
450450
colima start --arch x86_64 --cpu 4 --memory 8 --disk 10
451451
```
452452

453-
Colima will show the path to the docker socket so I have a
454-
[Coder template](./docker-code-server/main.tf) that prompts the Coder admin to
455-
enter the docker socket as a Terraform variable.
453+
Colima will show the path to the docker socket so we have a
454+
[community template](https://github.com/sharkymark/v2-templates/tree/main/docker-code-server)
455+
that prompts the Coder admin to enter the docker socket as a Terraform variable.
456456

457457
</details>
458458

‎docs/guides/example-guide.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -11,14 +11,14 @@ December 13, 2023
1111
---
1212

1313
This is a guide on how to make Coder guides, it is not listed on our
14-
[official guides page](coder.com/docs/v2/latest/guides) in the docs. This is
15-
intended for those who don't frequently contribute documentation changes to the
14+
[official guides page](https://coder.com/docs/v2/latest/guides) in the docs.
15+
Intended for those who don't frequently contribute documentation changes to the
1616
`coder/coder` repository.
1717

1818
## Content
1919

2020
Defer to our
21-
[Contributing/Documentation](coder.com/docs/v2/latest/contributing/documentation)
21+
[Contributing/Documentation](https://coder.com/docs/v2/latest/contributing/documentation)
2222
page for rules on technical writing.
2323

2424
### Adding Photos

‎docs/install/1-click.md

+9-9
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
Coder can be installed on many cloud providers using our
22
[one-click install packages](https://github.com/coder/packages)
33

4-
| Platform Name | Status | Documentation | Deploy |
5-
| --------------------- | ----------- | ------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------- |
6-
| AWS EC2 | Live ✅ | [Guide: AWS](https://coder.com/docs/v2/latest/platforms/aws) | [Deploy from AWS Marketplace](https://aws.amazon.com/marketplace/pp/prodview-5gxjyur2vc7rg?sr=0-2&ref_=beagle&applicationId=AWSMPContessa) |
7-
| AWS EKS | In progress | [Docs: Coder on Kubernetes](https://coder.com/docs/v2/latest/install/kubernetes) | [Deploy from AWS Marketplace](https://example.com) |
8-
| Google Compute Engine | Live ✅ | [Guide: Google Compute Engine](https://coder.com/docs/v2/latest/platforms/gcp) | [Deploy from GCP Marketplace](https://console.cloud.google.com/marketplace/product/coder-enterprise-market-public/coder-v2) |
9-
| Fly.io | Live ✅ | [Blog: Run Coder on Fly.io](https://coder.com/blog/remote-developer-environments-on-fly-io) | [Deploy Coder on FLy.io](https://coder.com/blog/remote-developer-environments-on-fly-io) |
10-
| Railway.app | Live ✅ | [Blog: Run Coder on Railway.app](https://coder.com/blog/deploy-coder-on-railway-app) | [![Deploy Coder on Railway](https://railway.app/button.svg)](https://railway.app/template/coder?referralCode=tfH8Uw) |
11-
| Heroku | Live ✅ | [Docs: Deploy Coder on Heroku](./heroku/README.md) | [![Deploy Coder on Heroku](https://www.herokucdn.com/deploy/button.svg)](https://heroku.com/deploy?template=https://github.com/coder/packages) |
12-
| Render | Live ✅ | [Docs: Deploy Coder on Render](./render/README.md) | [![Deploy to Render](https://render.com/images/deploy-to-render-button.svg)](https://render.com/deploy?repo=https://github.com/coder/packages) |
4+
| Platform Name | Status | Documentation | Deploy |
5+
| --------------------- | ----------- | -------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------- |
6+
| AWS EC2 | Live ✅ | [Guide: AWS](https://coder.com/docs/v2/latest/platforms/aws) | [Deploy from AWS Marketplace](https://aws.amazon.com/marketplace/pp/prodview-5gxjyur2vc7rg?sr=0-2&ref_=beagle&applicationId=AWSMPContessa) |
7+
| AWS EKS | In progress | [Docs: Coder on Kubernetes](https://coder.com/docs/v2/latest/install/kubernetes) | [Deploy from AWS Marketplace](https://example.com) |
8+
| Google Compute Engine | Live ✅ | [Guide: Google Compute Engine](https://coder.com/docs/v2/latest/platforms/gcp) | [Deploy from GCP Marketplace](https://console.cloud.google.com/marketplace/product/coder-enterprise-market-public/coder-v2) |
9+
| Fly.io | Live ✅ | [Blog: Run Coder on Fly.io](https://coder.com/blog/remote-developer-environments-on-fly-io) | [Deploy Coder on Fly.io](https://coder.com/blog/remote-developer-environments-on-fly-io) |
10+
| Railway.app | Live ✅ | [Blog: Run Coder on Railway.app](https://coder.com/blog/deploy-coder-on-railway-app) | [![Deploy Coder on Railway](https://railway.app/button.svg)](https://railway.app/template/coder?referralCode=tfH8Uw) |
11+
| Heroku | Live ✅ | [Docs: Deploy Coder on Heroku](https://github.com/coder/packages/blob/main/heroku/README.md) | [![Deploy Coder on Heroku](https://www.herokucdn.com/deploy/button.svg)](https://heroku.com/deploy?template=https://github.com/coder/packages) |
12+
| Render | Live ✅ | [Docs: Deploy Coder on Render](https://github.com/coder/packages/blob/main/render/README.md) | [![Deploy to Render](https://render.com/images/deploy-to-render-button.svg)](https://render.com/deploy?repo=https://github.com/coder/packages) |

‎docs/install/docker.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ Docker is required. See the
77
[official installation documentation](https://docs.docker.com/install/).
88

99
> Note that the below steps are only supported on a Linux distribution. If on
10-
> macOS, please [run Coder via the standalone binary](./binary.md).
10+
> macOS, please [run Coder via the standalone binary](./index.md#manual).
1111
1212
## Run Coder with the built-in database (quick)
1313

‎docs/install/index.md

+4-2
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,8 @@ curl -fsSL https://coder.com/install.sh | sh -s -- --help
3838
## Homebrew
3939

4040
To install Coder on Linux, you can use the [Homebrew](https://brew.sh/) package
41-
manager that uses our official [Homebrew tap](github.com/coder/homebrew-coder).
41+
manager that uses our official
42+
[Homebrew tap](https://github.com/coder/homebrew-coder).
4243

4344
```shell
4445
brew install coder/coder/coder
@@ -94,7 +95,8 @@ sudo apk add ./coder.apk
9495

9596
## Manual
9697

97-
Get the latest `.tar.gz` package from our GitHub releases page and install it
98+
Get the latest `.tar.gz` package from our
99+
[GitHub releases](https://github.com/coder/coder/releases/latest) and install it
98100
manually.
99101

100102
1. Download the

‎docs/platforms/aws.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,8 @@
33
This guide is designed to get you up and running with a Coder proof-of-concept
44
VM on AWS EC2 using a [Coder-provided AMI](https://github.com/coder/packages).
55
If you are familiar with EC2 however, you can use our
6-
[install script](../install/install.sh.md) to run Coder on any popular Linux
7-
distribution.
6+
[install script](../install/index.md#install-coder) to run Coder on any popular
7+
Linux distribution.
88

99
## Requirements
1010

‎docs/templates/icons.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@ come bundled with your Coder deployment.
4646
CODER_EXTERNAL_AUTH_1_ICON=/icon/google.svg
4747
```
4848
49-
- [**Support Links**](../admin/appearance#support-links):
49+
- [**Support Links**](../admin/appearance.md#support-links):
5050
5151
- Use icons for support links to make them recognizable. You can set the
5252
`icon` field for each link in `CODER_SUPPORT_LINKS` array.

0 commit comments

Comments
 (0)