Merge pull request #494 from yiannistri/493-ci-check-links

ci: Check for broken links in MD files

.github/workflows/pr-md-link-check.yml

@@ -0,0 +1,16 @@
+name: PR check Markdown links
+
+on: [pull_request, workflow_dispatch]
+
+# Remove all permissions from GITHUB_TOKEN except metadata.
+permissions: {}
+
+jobs:
+  markdown-link-check:
+    name: Broken Links
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v4
+    - run: |
+        npm install -g [email protected]
+        find . -name \*.md -print0 | xargs -0 -n1 markdown-link-check --quiet --config .markdown-link-check.json

.markdown-link-check.json

@@ -0,0 +1,7 @@
+{
+    "ignorePatterns": [
+        {
+          "pattern": "^http://localhost:3000/$"
+        }
+      ]
+}

README.md

@@ -18,4 +18,4 @@ Please see our [book](https://rancher.github.io/cluster-api-provider-rke2/) for
 
 ## How to contribute?
 
-See our [contributor guide](https://rancher.github.io/cluster-api-provider-rke2/03_developer/00.html) for more details on how to get involved.
+See our [contributor guide](https://rancher.github.io/cluster-api-provider-rke2/04_developer/00.html) for more details on how to get involved.

docs/book/src/03_examples/01_aws.md

@@ -14,7 +14,7 @@ clusterctl init --bootstrap rke2 --control-plane rke2 --infrastructure aws
 
 ## Create a workload cluster
 
-Before creating a workload clusters, it is required to build an AMI for the RKE2 version that is going to be installed on the cluster. You can follow the steps in the [image-builder README](../../image-builder/README.md#aws) to build the AMI.
+Before creating a workload clusters, it is required to build an AMI for the RKE2 version that is going to be installed on the cluster. You can follow the steps in the [image-builder README](https://github.com/rancher/cluster-api-provider-rke2/tree/main/image-builder#aws) to build the AMI.
 
 You will need to set the following environment variables:
 

docs/old/RKE2 Cluster API Provider - Data Type definitions.md

@@ -12,11 +12,11 @@ Therefore a particular attention has to be given to the kinds of manifests the e
 
 RKE2 is a very configurable Kubernetes distribution. The main ways to configure RKE2 are as follows:
 
-- config.yaml file (default location at /etc/rancher/rke2/): configuration options for RKE2 that are described in this [documentation page]([Server Configuration Reference - RKE2 - Rancher's Next Generation Kubernetes Distribution](https://docs.rke2.io/install/install_options/server_config/))
+- config.yaml file (default location at /etc/rancher/rke2/): configuration options for RKE2 that are described in this [documentation page]([Server Configuration Reference - RKE2 - Rancher's Next Generation Kubernetes Distribution](https://docs.rke2.io/reference/server_config))
 
 - registries.yaml (default location at /etc/rancher/rke2/): Container Image registry configuration for the cluster (mirrors, rewrites, etc.), documentation available in this [RKE2 Documentation page](https://docs.rke2.io/install/containerd_registry_configuration)
 
-- Environement variables for versions, etc. (options documented [here]([Overview - RKE2 - Rancher's Next Generation Kubernetes Distribution](https://docs.rke2.io/install/install_options/install_options/#configuring-the-linux-installation-script)))
+- Environment variables for versions, etc. (options documented [here]([Overview - RKE2 - Rancher's Next Generation Kubernetes Distribution](https://docs.rke2.io/install/configuration#configuring-the-linux-installation-script)))
 
 - Possibly automatically deploy manifests in `/var/lib/rancher/rke2/server/manifests/`