From 201e373646bfee41e44663d5879b544088916c4c Mon Sep 17 00:00:00 2001 From: Frederik Dudzik <5946811+doodzik@users.noreply.github.com> Date: Tue, 23 Apr 2024 17:07:25 -0400 Subject: [PATCH 1/2] fix broken links --- .github/workflows/weekly-docs.yaml | 5 +++++ docs/about/architecture.md | 4 ++-- docs/changelogs/v0.26.1.md | 2 +- examples/templates/devcontainer-docker/README.md | 2 +- examples/templates/devcontainer-kubernetes/README.md | 2 +- 5 files changed, 10 insertions(+), 5 deletions(-) diff --git a/.github/workflows/weekly-docs.yaml b/.github/workflows/weekly-docs.yaml index 9806564b67baa..afd52a006d14c 100644 --- a/.github/workflows/weekly-docs.yaml +++ b/.github/workflows/weekly-docs.yaml @@ -4,6 +4,11 @@ on: schedule: - cron: "0 9 * * 1" workflow_dispatch: # allows to run manually for testing + pull_request: + branches: + - main + paths: + - 'docs/**' jobs: check-docs: diff --git a/docs/about/architecture.md b/docs/about/architecture.md index 61b06d68d4f9f..af826ef784145 100644 --- a/docs/about/architecture.md +++ b/docs/about/architecture.md @@ -330,7 +330,7 @@ across multiple regions and diverse cloud platforms. - Since the _Registry_ is isolated from the internet, platform engineers are responsible for maintaining Workspace container images and conducting periodic updates of base Docker images. -- It is recommended to keep [Dev Containers](../templates/devcontainers.md) up +- It is recommended to keep [Dev Containers](../templates/dev-containers.md) up to date with the latest released [Envbuilder](https://github.com/coder/envbuilder) runtime. @@ -360,7 +360,7 @@ project-oriented [features](https://containers.dev/features) without requiring platform administrators to push altered Docker images. Learn more about -[Dev containers support](https://coder.com/docs/v2/latest/templates/devcontainers) +[Dev containers support](https://coder.com/docs/v2/latest/templates/dev-containers) in Coder. ![Architecture Diagram](../images/architecture-devcontainers.png) diff --git a/docs/changelogs/v0.26.1.md b/docs/changelogs/v0.26.1.md index 87f5938972aa5..9b42197f80285 100644 --- a/docs/changelogs/v0.26.1.md +++ b/docs/changelogs/v0.26.1.md @@ -2,7 +2,7 @@ ### Features -- [Devcontainer templates](https://coder.com/docs/v2/latest/templates/devcontainers) +- [Devcontainer templates](https://coder.com/docs/v2/latest/templates/dev-containers) for Coder (#8256) - The dashboard will warn users when a workspace is unhealthy (#8422) - Audit logs `resource_target` search query allows you to search by resource diff --git a/examples/templates/devcontainer-docker/README.md b/examples/templates/devcontainer-docker/README.md index 809ef8c0df7a8..973aafde38749 100644 --- a/examples/templates/devcontainer-docker/README.md +++ b/examples/templates/devcontainer-docker/README.md @@ -32,7 +32,7 @@ sudo -u coder docker ps ## Architecture -Coder supports devcontainers with [envbuilder](https://github.com/coder/envbuilder), an open source project. Read more about this in [Coder's documentation](https://coder.com/docs/v2/latest/templates/devcontainers). +Coder supports devcontainers with [envbuilder](https://github.com/coder/envbuilder), an open source project. Read more about this in [Coder's documentation](https://coder.com/docs/v2/latest/templates/dev-containers). This template provisions the following resources: diff --git a/examples/templates/devcontainer-kubernetes/README.md b/examples/templates/devcontainer-kubernetes/README.md index bb590456a8734..e17c3578a76c6 100644 --- a/examples/templates/devcontainer-kubernetes/README.md +++ b/examples/templates/devcontainer-kubernetes/README.md @@ -27,7 +27,7 @@ This template authenticates using a `~/.kube/config`, if present on the server, ## Architecture -Coder supports devcontainers with [envbuilder](https://github.com/coder/envbuilder), an open source project. Read more about this in [Coder's documentation](https://coder.com/docs/v2/latest/templates/devcontainers). +Coder supports devcontainers with [envbuilder](https://github.com/coder/envbuilder), an open source project. Read more about this in [Coder's documentation](https://coder.com/docs/v2/latest/templates/dev-containers). This template provisions the following resources: From 2c382d8d3171ce7aaedbf3e5a27fe05636ccdca9 Mon Sep 17 00:00:00 2001 From: Frederik Dudzik <5946811+doodzik@users.noreply.github.com> Date: Tue, 23 Apr 2024 17:35:36 -0400 Subject: [PATCH 2/2] fmt --- .github/workflows/weekly-docs.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/weekly-docs.yaml b/.github/workflows/weekly-docs.yaml index afd52a006d14c..64c2e9899df92 100644 --- a/.github/workflows/weekly-docs.yaml +++ b/.github/workflows/weekly-docs.yaml @@ -8,7 +8,7 @@ on: branches: - main paths: - - 'docs/**' + - "docs/**" jobs: check-docs: