From b29cebde9d2c224c9b433d0fa536111d251802a2 Mon Sep 17 00:00:00 2001
From: Ashley Dumaine <ashley.dumaine@gmail.com>
Date: Thu, 11 Apr 2024 12:19:43 -0400
Subject: [PATCH] use markdownlinkcheck and fix links

---
 .github/workflows/gh-pages.yml        |  6 ------
 .github/workflows/link-checker.yml    | 28 +++++++++++++++++++++++++++
 .markdownlinkcheck.json               |  7 +++++++
 docs/src/reference/reference.md       |  2 +-
 docs/src/topics/etcd.md               |  4 +++-
 docs/src/topics/flavors/dual-stack.md |  2 +-
 6 files changed, 40 insertions(+), 9 deletions(-)
 create mode 100644 .github/workflows/link-checker.yml
 create mode 100644 .markdownlinkcheck.json

diff --git a/.github/workflows/gh-pages.yml b/.github/workflows/gh-pages.yml
index 30e78b016..7e656480b 100644
--- a/.github/workflows/gh-pages.yml
+++ b/.github/workflows/gh-pages.yml
@@ -38,12 +38,6 @@ jobs:
         uses: actions/upload-pages-artifact@v3
         with:
           path: 'docs/book'
-      - name: Check broken links
-        uses: ruzickap/action-my-broken-link-checker@v2
-        with:
-          url: https://${{ github.repository_owner }}.github.io/${{ github.event.repository.name }}
-          pages_path: docs/book
-          cmd_params: '--buffer-size=8192 --max-connections=10 --color=always --skip-tls-verification --header="User-Agent:curl/7.54.0" --timeout=20'
 
   deploy-page:
     needs: generate-docs
diff --git a/.github/workflows/link-checker.yml b/.github/workflows/link-checker.yml
new file mode 100644
index 000000000..7407f6eb4
--- /dev/null
+++ b/.github/workflows/link-checker.yml
@@ -0,0 +1,28 @@
+name: Check for broken links
+
+on:
+  push:
+    branches:
+      - '*'
+    paths:
+      - 'README.md'
+      - 'docs/**'
+
+permissions:
+  contents: read
+
+jobs:
+  markdown-link-check:
+    name: Broken Links
+    runs-on: ubuntu-latest
+    steps:
+    - name: Harden Runner
+      uses: step-security/harden-runner@v2
+      with:
+        egress-policy: audit
+
+    - uses: actions/checkout@v4
+    - uses: gaurav-nelson/github-action-markdown-link-check@v1
+      with:
+        use-quiet-mode: 'yes'
+        config-file: .markdownlinkcheck.json
diff --git a/.markdownlinkcheck.json b/.markdownlinkcheck.json
new file mode 100644
index 000000000..d406de4da
--- /dev/null
+++ b/.markdownlinkcheck.json
@@ -0,0 +1,7 @@
+{
+    "timeout": "5s",
+    "retryOn429": true,
+    "retryCount": 5,
+    "fallbackRetryDelay": "30s",
+    "aliveStatusCodes": [200]
+}
diff --git a/docs/src/reference/reference.md b/docs/src/reference/reference.md
index 5bf870049..774358341 100644
--- a/docs/src/reference/reference.md
+++ b/docs/src/reference/reference.md
@@ -1,4 +1,4 @@
 # Reference
 
 For reference documentation for CAPL API types, please refer to
-the [godocs](https://pkg.go.dev/github.com/linode/cluster-api-provider-linode@v0.0.0-20240201213736-1a737bd24eca/api/v1alpha1)
+the [godocs](https://pkg.go.dev/github.com/linode/cluster-api-provider-linode)
diff --git a/docs/src/topics/etcd.md b/docs/src/topics/etcd.md
index 5601c2211..788baf045 100644
--- a/docs/src/topics/etcd.md
+++ b/docs/src/topics/etcd.md
@@ -19,7 +19,9 @@ The pod will need the bucket details like the name, region, endpoints and access
 bucket-details secret that is created when the OBJ bucket gets created.
 
 ### Enabling SSE
-Users can also enable SSE(Server_side encryption) by passing a SSE AES-256 Key as an env var. All env vars [here](../../../templates/addons/etcd-backup-restore/etcd-backup-restore.yaml) on the pod can be controlled during the provisioning process.
+Users can also enable SSE (Server-side encryption) by passing a SSE AES-256 Key as an env var. All env vars
+[here](https://github.com/linode/cluster-api-provider-linode/blob/main/templates/addons/etcd-backup-restore/etcd-backup-restore.yaml)
+on the pod can be controlled during the provisioning process.
 
 > [!WARNING]  
 > This is currently under development and will be available for use once the upstream [PR](https://github.com/gardener/etcd-backup-restore/pull/719) is merged and an official image is made available
diff --git a/docs/src/topics/flavors/dual-stack.md b/docs/src/topics/flavors/dual-stack.md
index c2e96c95a..26e3d1306 100644
--- a/docs/src/topics/flavors/dual-stack.md
+++ b/docs/src/topics/flavors/dual-stack.md
@@ -4,7 +4,7 @@
 |---------------|--------|--------------|-----------------------|------|------|
 | Kubeadm       | Cilium | Ubuntu 22.04 | No                    | Yes  | Yes  |
 ## Prerequisites
-[Quickstart](../topics/getting-started.md) completed
+[Quickstart](../getting-started.md) completed
 ## Usage
 1. Generate cluster yaml
     ```bash