Skip to content

Verify that all docs links work #4710

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 5 commits into from
Oct 23, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
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
7 changes: 7 additions & 0 deletions .github/workflows/coder.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -674,3 +674,10 @@ jobs:
buildScriptName: "storybook:build"
projectToken: 695c25b6cb65
workingDir: "./site"
markdown-link-check:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@master
- uses: gaurav-nelson/github-action-markdown-link-check@v1
with:
config-file: .github/workflows/mlc_config.json
16 changes: 16 additions & 0 deletions .github/workflows/mlc_config.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
{
"ignorePatterns": [
{
"pattern": ":\/\/localhost"
},
{
"pattern": ":\/\/.*.?example\\.com"
},
{
"pattern": "developer.github.com"
},
{
"pattern": "tailscale.com"
}
]
}
2 changes: 1 addition & 1 deletion docs/CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -77,7 +77,7 @@ Use the following `make` commands and scripts in development:

### Documentation

Our style guide for authoring documentation can be found [./contributing/documentation.md](here).
Our style guide for authoring documentation can be found [here](./contributing/documentation.md).

### Backend

Expand Down
2 changes: 1 addition & 1 deletion docs/admin/auth.md
Original file line number Diff line number Diff line change
Expand Up @@ -78,7 +78,7 @@ Once complete, run `sudo service coder restart` to reboot Coder.
## SCIM (enterprise)

Coder supports user provisioning and deprovisioning via SCIM 2.0 with header
authentication. Upon deactivation, users are [suspended](userd.md#suspend-a-user)
authentication. Upon deactivation, users are [suspended](./users.md#suspend-a-user)
and are not deleted. [Configure](./configure.md) your SCIM application with an
auth key and supply it the Coder server.

Expand Down
2 changes: 2 additions & 0 deletions docs/dotfiles.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,11 @@
# Dotfiles

<!-- markdown-link-check-disable -->
Coder offers the `coder dotfiles <repo>` command which simplifies workspace
personalization. Our behavior is consistent with Codespaces, so
[their documentation](https://docs.github.com/en/codespaces/customizing-your-codespace/personalizing-codespaces-for-your-account#dotfiles)
explains how it loads your repo.
<!-- markdown-link-check-enable -->

You can read more on dotfiles best practices [here](https://dotfiles.github.io).

Expand Down
6 changes: 2 additions & 4 deletions docs/ides/web-ides.md
Original file line number Diff line number Diff line change
Expand Up @@ -197,11 +197,9 @@ resource "coder_app" "intellij" {

You can also reference/use to these pre-built templates with JetBrains projector:

- IntelliJ ([Docker](https://github.com/mark-theshark/v2-templates/tree/main/docker-with-intellij), [Kubernetes](https://github.com/mark-theshark/v2-templates/tree/main/pod-with-intellij))
- IntelliJ ([Docker](https://github.com/mark-theshark/v2-templates/tree/main/docker-with-intellij), [Kubernetes](https://github.com/sharkymark/v2-templates/tree/main/multi-projector-intellij))

- PyCharm ([Docker](https://github.com/mark-theshark/v2-templates/tree/main/docker-with-pycharm), [Kubernetes](https://github.com/mark-theshark/v2-templates/tree/main/pod-with-pycharm)

- GoLand ([Docker](https://github.com/mark-theshark/v2-templates/tree/main/docker-with-goland), [Kubernetes](https://github.com/mark-theshark/v2-templates/tree/main/pod-with-goland))
- PyCharm ([Docker](https://github.com/mark-theshark/v2-templates/tree/main/docker-with-pycharm), [Kubernetes](https://github.com/sharkymark/v2-templates/tree/main/multi-projector-pycharm)

> You need to have a valid `~/.kube/config` on your Coder host and a namespace on a Kubernetes cluster to use the Kubernetes pod template examples.

Expand Down
2 changes: 1 addition & 1 deletion docs/networking.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#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 Down
6 changes: 3 additions & 3 deletions docs/quickstart.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ possible way to use Coder.

## Generic Quickstart

Please [install Coder](../install) before proceeding with the steps below.
Please [install Coder](./install/index.md) before proceeding with the steps below.

## First time owner user setup

Expand Down Expand Up @@ -42,7 +42,7 @@ Connect to your workspace via SSH:
coder ssh <workspaceName>
```

To access your workspace in the Coder dashboard, navigate to the [configured access URL](../admin/configure#access-url),
To access your workspace in the Coder dashboard, navigate to the [configured access URL](./admin/configure.md#access-url),
and log in with the owner credentials provided to you by Coder.

![Coder Web UI with code-server](./images/code-server.png)
Expand All @@ -65,4 +65,4 @@ coder templates push gcp-linux # updates the template

## Up Next

Learn about [templates](../templates.md).
Learn about [templates](./templates.md).
2 changes: 1 addition & 1 deletion examples/web-server/caddy/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -94,7 +94,7 @@ This is an example configuration of how to use Coder with [caddy](https://caddys

## Generating wildcard certificates

By default, this configuration uses Caddy's [on-demand TLS](https://caddyserver.com/docs/caddyfile/options#on-demand-tls) to generate a certificate for each subdomain (e.g. `app1.coder.example.com`, `app2.coder.example.com`). When users visit new subdomains, such as accessing [ports on a workspace](../../networking/port-forwarding.md), the request will take an additional 5-30 seconds since a new certificate is being generated.
By default, this configuration uses Caddy's [on-demand TLS](https://caddyserver.com/docs/caddyfile/options#on-demand-tls) to generate a certificate for each subdomain (e.g. `app1.coder.example.com`, `app2.coder.example.com`). When users visit new subdomains, such as accessing [ports on a workspace](../../../docs/networking/port-forwarding.md), the request will take an additional 5-30 seconds since a new certificate is being generated.

For production deployments, we recommend configuring Caddy to generate a wildcard certificate, which requires an explicit DNS challenge and additional Caddy modules.

Expand Down