From f727b560fc781b2d9ca65e856e06fbfcb9266f69 Mon Sep 17 00:00:00 2001 From: Ammar Bandukwala Date: Sun, 23 Oct 2022 18:58:07 +0000 Subject: [PATCH 1/5] Verify that all docs links work --- .github/workflows/coder.yaml | 5 +++++ docs/quickstart.md | 6 +++--- 2 files changed, 8 insertions(+), 3 deletions(-) diff --git a/.github/workflows/coder.yaml b/.github/workflows/coder.yaml index e86e2af716514..23b059517a6a7 100644 --- a/.github/workflows/coder.yaml +++ b/.github/workflows/coder.yaml @@ -674,3 +674,8 @@ 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 diff --git a/docs/quickstart.md b/docs/quickstart.md index 98067a63619af..68310a99509a3 100644 --- a/docs/quickstart.md +++ b/docs/quickstart.md @@ -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 @@ -42,7 +42,7 @@ Connect to your workspace via SSH: coder ssh ``` -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) @@ -65,4 +65,4 @@ coder templates push gcp-linux # updates the template ## Up Next -Learn about [templates](../templates.md). +Learn about [templates](./templates.md). From 9b116bdaadf954c02ba5ddc803abd62bfc09f518 Mon Sep 17 00:00:00 2001 From: Ammar Bandukwala Date: Sun, 23 Oct 2022 19:06:28 +0000 Subject: [PATCH 2/5] fixup! Verify that all docs links work --- .github/workflows/coder.yaml | 1 + .github/workflows/mlc_config.json | 7 +++++++ docs/networking.md | 2 +- examples/web-server/caddy/README.md | 2 +- 4 files changed, 10 insertions(+), 2 deletions(-) create mode 100644 .github/workflows/mlc_config.json diff --git a/.github/workflows/coder.yaml b/.github/workflows/coder.yaml index 23b059517a6a7..7199f97ceea92 100644 --- a/.github/workflows/coder.yaml +++ b/.github/workflows/coder.yaml @@ -679,3 +679,4 @@ jobs: steps: - uses: actions/checkout@master - uses: gaurav-nelson/github-action-markdown-link-check@v1 + config-file: .github/workflows/mlc_config.json diff --git a/.github/workflows/mlc_config.json b/.github/workflows/mlc_config.json new file mode 100644 index 0000000000000..de1d855b64d20 --- /dev/null +++ b/.github/workflows/mlc_config.json @@ -0,0 +1,7 @@ +{ + "ignorePatterns": [ + { + "pattern": "^//localhost" + } + ] +} diff --git a/docs/networking.md b/docs/networking.md index d2c56f26130a7..679d3b6d36341 100644 --- a/docs/networking.md +++ b/docs/networking.md @@ -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` diff --git a/examples/web-server/caddy/README.md b/examples/web-server/caddy/README.md index 083ca914b639b..4a5168e7d3242 100644 --- a/examples/web-server/caddy/README.md +++ b/examples/web-server/caddy/README.md @@ -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. From db95a5223d3c3903106d542784f7e8a7db45900b Mon Sep 17 00:00:00 2001 From: Ammar Bandukwala Date: Sun, 23 Oct 2022 19:22:15 +0000 Subject: [PATCH 3/5] fixup! Verify that all docs links work --- .github/workflows/mlc_config.json | 8 +++++++- docs/CONTRIBUTING.md | 2 +- docs/admin/auth.md | 2 +- docs/dotfiles.md | 2 ++ docs/ides/web-ides.md | 6 ++---- 5 files changed, 13 insertions(+), 7 deletions(-) diff --git a/.github/workflows/mlc_config.json b/.github/workflows/mlc_config.json index de1d855b64d20..6f97df70cbc28 100644 --- a/.github/workflows/mlc_config.json +++ b/.github/workflows/mlc_config.json @@ -1,7 +1,13 @@ { "ignorePatterns": [ { - "pattern": "^//localhost" + "pattern": ":\/\/localhost" + }, + { + "pattern": ":\/\/.*.?example\\.com" + }, + { + "pattern": "developer.github.com" } ] } diff --git a/docs/CONTRIBUTING.md b/docs/CONTRIBUTING.md index 23d84b5fbe909..a7ec45940953c 100644 --- a/docs/CONTRIBUTING.md +++ b/docs/CONTRIBUTING.md @@ -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 diff --git a/docs/admin/auth.md b/docs/admin/auth.md index 82607d4612cbd..b9f7033dca33c 100644 --- a/docs/admin/auth.md +++ b/docs/admin/auth.md @@ -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. diff --git a/docs/dotfiles.md b/docs/dotfiles.md index 101232f25c72f..91eaf42950c6b 100644 --- a/docs/dotfiles.md +++ b/docs/dotfiles.md @@ -1,9 +1,11 @@ # Dotfiles + Coder offers the `coder dotfiles ` 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. + You can read more on dotfiles best practices [here](https://dotfiles.github.io). diff --git a/docs/ides/web-ides.md b/docs/ides/web-ides.md index ef7249df5cf1d..292d03c6c2f80 100644 --- a/docs/ides/web-ides.md +++ b/docs/ides/web-ides.md @@ -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. From 9e128d769acb95686cc0191fbb085437782f52b7 Mon Sep 17 00:00:00 2001 From: Ammar Bandukwala Date: Sun, 23 Oct 2022 19:22:49 +0000 Subject: [PATCH 4/5] fixup! Verify that all docs links work --- .github/workflows/coder.yaml | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/.github/workflows/coder.yaml b/.github/workflows/coder.yaml index 7199f97ceea92..277fdac39cc45 100644 --- a/.github/workflows/coder.yaml +++ b/.github/workflows/coder.yaml @@ -679,4 +679,5 @@ jobs: steps: - uses: actions/checkout@master - uses: gaurav-nelson/github-action-markdown-link-check@v1 - config-file: .github/workflows/mlc_config.json + with: + config-file: .github/workflows/mlc_config.json From 9ce064753c22c7370a891cb21f6c70b1a495867c Mon Sep 17 00:00:00 2001 From: Ammar Bandukwala Date: Sun, 23 Oct 2022 21:49:19 +0000 Subject: [PATCH 5/5] fixup! Verify that all docs links work --- .github/workflows/mlc_config.json | 3 +++ 1 file changed, 3 insertions(+) diff --git a/.github/workflows/mlc_config.json b/.github/workflows/mlc_config.json index 6f97df70cbc28..a50b31e7308e9 100644 --- a/.github/workflows/mlc_config.json +++ b/.github/workflows/mlc_config.json @@ -8,6 +8,9 @@ }, { "pattern": "developer.github.com" + }, + { + "pattern": "tailscale.com" } ] }