mirror of https://github.com/coder/coder.git
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
This commit is contained in:
Stephen Kirby
GitHub
parent
3014777d2a
commit
91a8b1b886
|
|
@ -4,8 +4,8 @@
|
|||
|
||||
We recommend using the [Nix](https://nix.dev/) package manager as it makes any
|
||||
pain related to maintaining dependency versions
|
||||
[just disappear](https://twitter.com/mitchellh/status/1491102567296040961). Once
|
||||
nix [has been installed](https://nixos.org/download.html) the development
|
||||
[disappear](https://nixos.org/guides/how-nix-works). Once nix
|
||||
[has been installed](https://nixos.org/download.html) the development
|
||||
environment can be _manually instantiated_ through the `nix-shell` command:
|
||||
|
||||
```shell
|
||||
|
|
|
|||
|
|
@ -105,4 +105,4 @@ Azure, Google Cloud, Kubernetes, and more.
|
|||
## Up next
|
||||
|
||||
- Learn about [Templates](./templates/index.md)
|
||||
- [Install Coder](./install/install.sh.md)
|
||||
- [Install Coder](./install/index.md#install-coder)
|
||||
|
|
|
|||
|
|
@ -36,7 +36,7 @@ users of which network their Coder deployment is on.
|
|||
|
||||
## OIDC Login Button Customization
|
||||
|
||||
[Use environment variables to customize](../auth#oidc-login-customization) the
|
||||
[Use environment variables to customize](./auth.md#oidc-login-customization) the
|
||||
text and icon on the OIDC button on the Sign In page.
|
||||
|
||||
## Support Links
|
||||
|
|
|
|||
|
|
@ -130,8 +130,8 @@ steps:
|
|||
|
||||
## System packages
|
||||
|
||||
If you've installed Coder via a [system package](../install/packages.md) Coder,
|
||||
you can configure the server by setting the following variables in
|
||||
If you've installed Coder via a [system package](../install/index.md) Coder, you
|
||||
can configure the server by setting the following variables in
|
||||
`/etc/coder.d/coder.env`:
|
||||
|
||||
```env
|
||||
|
|
|
|||
|
|
@ -11,7 +11,7 @@
|
|||
|
||||
- You can install Coder with
|
||||
[Homebrew](https://formulae.brew.sh/formula/coder#default) (#9414) (@aslilac).
|
||||
Our [install script](https://coder.com/docs/v2/latest/install/install.sh) will
|
||||
Our [install script](https://coder.com/docs/v2/latest/install#install-coder) will
|
||||
also use Homebrew, if present on your machine.
|
||||
- You can show/hide specific
|
||||
[display apps](https://registry.terraform.io/providers/coder/coder/latest/docs/resources/agent#nested-schema-for-display_apps)
|
||||
|
|
|
|||
|
|
@ -4,7 +4,7 @@
|
|||
|
||||
- Add metrics for workspace agent scripts (#11132) (@Emyrk)
|
||||
- Add a user-configurable theme picker (#11140) (@aslilac)
|
||||
|
||||
|
||||
> A [light theme](https://github.com/coder/coder/issues/8396) is coming soon
|
||||
- Various improvements to bulk delete flow (#11093) (@aslilac)
|
||||
|
||||
|
|
|
|||
|
|
@ -36,7 +36,7 @@ are backwards-compatible and have been tested significantly with the goal of imp
|
|||
- Add support for loading template variables from tfvars files (#11549) (@mtojek)
|
||||
- Expose support links as [env variables](https://coder.com/docs/v2/latest/cli/server#--support-links) (#11697) (@mtojek)
|
||||
- Allow custom icons in the "support links" navbar (#11629) (@mtojek)
|
||||
|
||||
|
||||
- Add additional fields to first time setup trial flow (#11533) (@coadler)
|
||||
- Manage provisioner tags in template editor (#11600) (@f0ssel)
|
||||
- Add `coder open vscode` CLI command (#11191) (@mafredri)
|
||||
|
|
|
|||
10
docs/faqs.md
10
docs/faqs.md
|
|
@ -17,8 +17,8 @@ In the UI, click the Deployment tab -> Licenses and upload the `jwt` license
|
|||
file.
|
||||
|
||||
> To add the license with the CLI, first
|
||||
> [install the Coder CLI](https://coder.com/docs/v2/latest/install/install.sh)
|
||||
> and server to the latest release.
|
||||
> [install the Coder CLI](./install/index.md#install-script) and server to the
|
||||
> latest release.
|
||||
|
||||
If the license is a text string:
|
||||
|
||||
|
|
@ -450,9 +450,9 @@ Starting Colima on a M3 Macbook Pro:
|
|||
colima start --arch x86_64 --cpu 4 --memory 8 --disk 10
|
||||
```
|
||||
|
||||
Colima will show the path to the docker socket so I have a
|
||||
[Coder template](./docker-code-server/main.tf) that prompts the Coder admin to
|
||||
enter the docker socket as a Terraform variable.
|
||||
Colima will show the path to the docker socket so we have a
|
||||
[community template](https://github.com/sharkymark/v2-templates/tree/main/docker-code-server)
|
||||
that prompts the Coder admin to enter the docker socket as a Terraform variable.
|
||||
|
||||
</details>
|
||||
|
||||
|
|
|
|||
|
|
@ -11,14 +11,14 @@ December 13, 2023
|
|||
---
|
||||
|
||||
This is a guide on how to make Coder guides, it is not listed on our
|
||||
[official guides page](coder.com/docs/v2/latest/guides) in the docs. This is
|
||||
intended for those who don't frequently contribute documentation changes to the
|
||||
[official guides page](https://coder.com/docs/v2/latest/guides) in the docs.
|
||||
Intended for those who don't frequently contribute documentation changes to the
|
||||
`coder/coder` repository.
|
||||
|
||||
## Content
|
||||
|
||||
Defer to our
|
||||
[Contributing/Documentation](coder.com/docs/v2/latest/contributing/documentation)
|
||||
[Contributing/Documentation](https://coder.com/docs/v2/latest/contributing/documentation)
|
||||
page for rules on technical writing.
|
||||
|
||||
### Adding Photos
|
||||
|
|
|
|||
|
|
@ -1,12 +1,12 @@
|
|||
Coder can be installed on many cloud providers using our
|
||||
[one-click install packages](https://github.com/coder/packages)
|
||||
|
||||
| Platform Name | Status | Documentation | Deploy |
|
||||
| --------------------- | ----------- | ------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| 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) |
|
||||
| AWS EKS | In progress | [Docs: Coder on Kubernetes](https://coder.com/docs/v2/latest/install/kubernetes) | [Deploy from AWS Marketplace](https://example.com) |
|
||||
| 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) |
|
||||
| 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) |
|
||||
| Railway.app | Live ✅ | [Blog: Run Coder on Railway.app](https://coder.com/blog/deploy-coder-on-railway-app) | [](https://railway.app/template/coder?referralCode=tfH8Uw) |
|
||||
| Heroku | Live ✅ | [Docs: Deploy Coder on Heroku](./heroku/README.md) | [](https://heroku.com/deploy?template=https://github.com/coder/packages) |
|
||||
| Render | Live ✅ | [Docs: Deploy Coder on Render](./render/README.md) | [](https://render.com/deploy?repo=https://github.com/coder/packages) |
|
||||
| Platform Name | Status | Documentation | Deploy |
|
||||
| --------------------- | ----------- | -------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| 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) |
|
||||
| AWS EKS | In progress | [Docs: Coder on Kubernetes](https://coder.com/docs/v2/latest/install/kubernetes) | [Deploy from AWS Marketplace](https://example.com) |
|
||||
| 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) |
|
||||
| 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) |
|
||||
| Railway.app | Live ✅ | [Blog: Run Coder on Railway.app](https://coder.com/blog/deploy-coder-on-railway-app) | [](https://railway.app/template/coder?referralCode=tfH8Uw) |
|
||||
| Heroku | Live ✅ | [Docs: Deploy Coder on Heroku](https://github.com/coder/packages/blob/main/heroku/README.md) | [](https://heroku.com/deploy?template=https://github.com/coder/packages) |
|
||||
| Render | Live ✅ | [Docs: Deploy Coder on Render](https://github.com/coder/packages/blob/main/render/README.md) | [](https://render.com/deploy?repo=https://github.com/coder/packages) |
|
||||
|
|
|
|||
|
|
@ -7,7 +7,7 @@ Docker is required. See the
|
|||
[official installation documentation](https://docs.docker.com/install/).
|
||||
|
||||
> Note that the below steps are only supported on a Linux distribution. If on
|
||||
> macOS, please [run Coder via the standalone binary](./binary.md).
|
||||
> macOS, please [run Coder via the standalone binary](./index.md#manual).
|
||||
|
||||
## Run Coder with the built-in database (quick)
|
||||
|
||||
|
|
|
|||
|
|
@ -38,7 +38,8 @@ curl -fsSL https://coder.com/install.sh | sh -s -- --help
|
|||
## Homebrew
|
||||
|
||||
To install Coder on Linux, you can use the [Homebrew](https://brew.sh/) package
|
||||
manager that uses our official [Homebrew tap](github.com/coder/homebrew-coder).
|
||||
manager that uses our official
|
||||
[Homebrew tap](https://github.com/coder/homebrew-coder).
|
||||
|
||||
```shell
|
||||
brew install coder/coder/coder
|
||||
|
|
@ -94,7 +95,8 @@ sudo apk add ./coder.apk
|
|||
|
||||
## Manual
|
||||
|
||||
Get the latest `.tar.gz` package from our GitHub releases page and install it
|
||||
Get the latest `.tar.gz` package from our
|
||||
[GitHub releases](https://github.com/coder/coder/releases/latest) and install it
|
||||
manually.
|
||||
|
||||
1. Download the
|
||||
|
|
|
|||
|
|
@ -3,8 +3,8 @@
|
|||
This guide is designed to get you up and running with a Coder proof-of-concept
|
||||
VM on AWS EC2 using a [Coder-provided AMI](https://github.com/coder/packages).
|
||||
If you are familiar with EC2 however, you can use our
|
||||
[install script](../install/install.sh.md) to run Coder on any popular Linux
|
||||
distribution.
|
||||
[install script](../install/index.md#install-coder) to run Coder on any popular
|
||||
Linux distribution.
|
||||
|
||||
## Requirements
|
||||
|
||||
|
|
|
|||
|
|
@ -46,7 +46,7 @@ come bundled with your Coder deployment.
|
|||
CODER_EXTERNAL_AUTH_1_ICON=/icon/google.svg
|
||||
```
|
||||
|
||||
- [**Support Links**](../admin/appearance#support-links):
|
||||
- [**Support Links**](../admin/appearance.md#support-links):
|
||||
|
||||
- Use icons for support links to make them recognizable. You can set the
|
||||
`icon` field for each link in `CODER_SUPPORT_LINKS` array.
|
||||
|
|
|
|||
Loading…
Reference in New Issue