External link checker + Dead link fixes (#34)

* Dead link checker
* Fix dead external links

Signed-off-by: Derek Nola <[email protected]>

.github/workflows/test-deploy.yml

@@ -18,7 +18,7 @@ jobs:
 
       - name: Install dependencies
         run: yarn install --frozen-lockfile
-      - name: Check internal links
-        run: yarn run remark --quiet --frail docs/
+      - name: Check links
+        run: yarn run remark --use remark-validate-links --use remark-lint-no-dead-urls  --frail ./docs
       - name: Test build website
         run: yarn build

docs/backup_restore.md

@@ -18,7 +18,7 @@ To configure the snapshot interval or the number of retained snapshots, refer to
 
 In RKE2, snapshots are stored on each etcd node. If you have multiple etcd or etcd + control-plane nodes, you will have multiple copies of local etcd snapshots.
 
-You can take a snapshot manually while RKE2 is running with the `etcd-snapshot` subcommand. For example: `rke2 etcd-snapshot save --name pre-upgrade-snapshot`. See the full list of etcd-snapshot subcommands at the [subcommands page](https://docs.rke2.io/reference/subcommands#etcd-snapshot)
+You can take a snapshot manually while RKE2 is running with the `etcd-snapshot` subcommand. For example: `rke2 etcd-snapshot save --name pre-upgrade-snapshot`. See the full list of etcd-snapshot subcommands at the [subcommands page](reference/subcommands.md#etcd-snapshot)
 
 ## Cluster Reset
 
@@ -95,7 +95,7 @@ rke2 server \
 systemctl start rke2-server
 ```
 
-6. You can continue to add new server and worker nodes to cluster per standard [RKE2 HA installation documentation](https://docs.rke2.io/install/ha/#3-launch-additional-server-nodes).
+6. You can continue to add new server and worker nodes to cluster per standard [RKE2 HA installation documentation](install/ha.md#3-launch-additional-server-nodes).
 
 
 ### Other Notes on Restoring a Snapshot

docs/install/airgap.md

@@ -2,15 +2,15 @@
 title: Air-Gap Install
 ---
 
-**Important:** If your node has NetworkManager installed and enabled, [ensure that it is configured to ignore CNI-managed interfaces.](https://docs.rke2.io/known_issues/#networkmanager)
+**Important:** If your node has NetworkManager installed and enabled, [ensure that it is configured to ignore CNI-managed interfaces.](../known_issues.md#networkmanager)
 
 RKE2 can be installed in an air-gapped environment with two different methods. You can either deploy via the `rke2-airgap-images` tarball release artifact, or by using a private registry.
 
 All files mentioned in the steps can be obtained from the assets of the desired released rke2 version [here](https://github.com/rancher/rke2/releases).
 
-If running on an air-gapped node with SELinux enabled, you must manually install the necessary SELinux policy RPM before performing these steps. See our [RPM Documentation](https://docs.rke2.io/install/methods/#rpm) to determine what you need.
+If running on an air-gapped node with SELinux enabled, you must manually install the necessary SELinux policy RPM before performing these steps. See our [RPM Documentation](../install/methods.md#rpm) to determine what you need.
 
-If running on an air-gapped node running SELinux, CentOS, or RHEL 8, with SELinux enabled, the following are required dependencies when doing an [RPM install](https://docs.rke2.io/install/methods/#rpm):
+If running on an air-gapped node running SELinux, CentOS, or RHEL 8, with SELinux enabled, the following are required dependencies when doing an [RPM install](../install/methods.md#rpm):
 
     Installing dependencies:
     container-selinux
@@ -78,4 +78,4 @@ curl -sfL https://get.rke2.io --output install.sh
 ```bash
 INSTALL_RKE2_ARTIFACT_PATH=/root/rke2-artifacts sh install.sh
 ```
-3. Enable and run the service as outlined [here.](https://docs.rke2.io/install/quickstart/#2-enable-the-rke2-server-service)
+3. Enable and run the service as outlined [here.](quickstart.md#2-enable-the-rke2-server-service)

docs/install/network_options.md

@@ -62,7 +62,7 @@ Canal requires the iptables or xtables-nft package to be installed on the node.
 Canal is currently not supported on clusters with Windows nodes.
 :::
 
-Please check [Known issues and Limitations](https://docs.rke2.io/known_issues/) if you experience IP allocation problems
+Please check [Known issues and Limitations](../known_issues.md) if you experience IP allocation problems 
 
 </TabItem>
 <TabItem value="Cilium CNI plugin" default>

docs/introduction.md

@@ -8,7 +8,7 @@ title: "Introduction"
 
 RKE2, also known as RKE Government, is Rancher's next-generation Kubernetes distribution.
 
-It is a fully [conformant Kubernetes distribution](https://landscape.cncf.io/selected=rke-government) that focuses on security and compliance within the U.S. Federal Government sector.
+It is a fully [conformant Kubernetes distribution](https://landscape.cncf.io/card-mode?selected=rke-government) that focuses on security and compliance within the U.S. Federal Government sector.
 
 To meet these goals, RKE2 does the following:
 

docs/networking.md

@@ -18,7 +18,7 @@ CoreDNS is deployed by default when starting the server. To disable, run each se
 
 If you don't install CoreDNS, you will need to install a cluster DNS provider yourself.
 
-CoreDNS is deployed with the [autoscaler](https://github.com/kubernetes-incubator/cluster-proportional-autoscaler) by default. To disable it or change its config, use the [HelmChartConfig](https://docs.rke2.io/helm/#customizing-packaged-components-with-helmchartconfig) resource.
+CoreDNS is deployed with the [autoscaler](https://github.com/kubernetes-incubator/cluster-proportional-autoscaler) by default. To disable it or change its config, use the [HelmChartConfig](helm.md#customizing-packaged-components-with-helmchartconfig) resource.
 
 ### NodeLocal DNSCache
 

docs/security/about_hardened_images.md

@@ -4,7 +4,7 @@ title: About Hardened Images
 
 RKE2 hardened images are scanned for vulnerabilities at build time, and additional security protections have been added to decrease potential weaknesses:
 * Images are not simply mirrored from upstream builds. The images are built from source on top of a hardened minimal base image, which is currently [SLE Base Container Image (BCI)](https://www.suse.com/products/base-container-images/).
-* Any binaries that are written in Go are compiled using a FIPS 140-2 compliant build process. For more information on this compiler, refer [here](https://docs.rke2.io/security/fips_support/#use-of-fips-compatible-go-compiler).
+* Any binaries that are written in Go are compiled using a FIPS 140-2 compliant build process. For more information on this compiler, refer [here](../security/fips_support.md#use-of-fips-compatible-go-compiler).
 
 You will know if an image has been hardened as above by the image name. RKE2 publishes image lists with each release. Refer [here](https://github.com/rancher/rke2/releases/download/v1.23.14%2Brke2r1/rke2-images-all.linux-amd64.txt) for an example of a published image list.
 

docs/security/secrets_encryption.md

@@ -45,7 +45,7 @@ Once enabled any created secret will be encrypted with this key. Note that if yo
 ## Secrets Encryption Tool
 _Available as of v1.21.8+rke2r1_
 
-RKE2 contains a utility [subcommand](https://docs.rke2.io/subcommands/#secrets-encrypt) `secrets-encrypt`, which allows administrators to perform the following tasks:
+RKE2 contains a utility [subcommand](../reference/subcommands.md#secrets-encrypt) `secrets-encrypt`, which allows administrators to perform the following tasks:
 
 - Adding new encryption keys
 - Rotating and deleting encryption keys

package.json

@@ -23,6 +23,7 @@
     "react": "^17.0.2",
     "react-dom": "^17.0.2",
     "remark-cli": "^11.0.0",
+    "remark-lint-no-dead-urls": "^1.1.0",
     "remark-validate-links": "^12.1.0"
   },
   "devDependencies": {