fix broken links (#924)

Fix broken links and add ignore links to custom_conf due to known sphinx issue with anchors causing false positives

docs/canonicalk8s/custom_conf.py

@@ -137,7 +137,10 @@
 
 # Links to ignore when checking links
 linkcheck_ignore = [
-    'http://127.0.0.1:8000'
+    'http://127.0.0.1:8000',
+    'http://rocks.canonical.com',
+    'about',
+    'https://ceph.io/'
     ]
 
 # Pages on which to ignore anchors
@@ -166,7 +169,7 @@
     'canonical.custom-rst-roles',
     'canonical.terminal-output',
     'notfound.extension',
-    'sphinxcontrib.cairosvgconverter', 
+    'sphinxcontrib.cairosvgconverter',
     ]
 
 # Add custom required Python modules that must be added to the
@@ -231,3 +234,11 @@
 .. role:: h2
     :class: hclass2
 '''
+
+custom_linkcheck_anchors_ignore_for_url = [
+    'https://matrix.to',
+    'https://ubuntu.com/about/release-cycle',
+    'https://juju.is/docs/juju/relation',
+    'https://canonical.com/multipass/docs/tutorial',
+    'https://microk8s.io/docs/how-to-cis-harden'
+]

docs/src/snap/explanation/security.md

@@ -60,12 +60,11 @@ check the [roadmap][] for current areas of work.
 <!-- LINKS -->
 
 [Kubernetes Security documentation]: https://kubernetes.io/docs/concepts/security/overview/
-[snap documentation]: https://snapcraft.io/docs/security-sandboxing
+[snap documentation]: https://snapcraft.io/docs/security-policies
 [rocks-security]: https://canonical-rockcraft.readthedocs-hosted.com/en/latest/explanation/rockcraft/
 [roadmap]: ../reference/roadmap
 [Amazon Web Services security]: https://aws.amazon.com/security/
 [Google Cloud Platform security]:https://cloud.google.com/security/
-[Metal As A Service(MAAS) hardening]:https://maas.io/docs/snap/3.0/ui/hardening-your-maas-installation
+[Metal As A Service(MAAS) hardening]:https://maas.io/docs/how-to-enhance-maas-security
 [Microsoft Azure security]:https://docs.microsoft.com/en-us/azure/security/azure-security
 [VMware VSphere hardening guides]: https://www.vmware.com/security/hardening-guides.html
-

docs/src/snap/howto/install/multipass.md

@@ -113,9 +113,9 @@ multipass purge
 <!-- markdownlint-disable MD053 -->
 [Multipass]:https://multipass.run/
 [snap-support]: https://snapcraft.io/docs/installing-snapd
-[Multipass-options]: https://multipass.run/docs/tutorial#p-71169-create-a-customised-instance
+[Multipass-options]: https://canonical.com/multipass/docs/tutorial#p-71169-create-a-customised-instance
 [install instructions]: ./snap
 [Getting started]: ../../tutorial/getting-started
 [Multipass website]: https://multipass.run/docs
-[latest Window version]:https://multipass.run/download/windows
-[latest macOS version]:https://multipass.run/download/macos
+[latest Windows version]:https://canonical.com/multipass/download/windows
+[latest macOS version]:https://canonical.com/multipass/download/macos

docs/src/snap/howto/security/disa-stig-assessment.md

@@ -1060,10 +1060,7 @@ The final line of the output will be `PASS`.
 > Administrator on a per-organization basis.
 >
 > Instructions on how to configure an `--admission-control-config-file` for the
-> Kube API Server of the k8s-snap can be found at:
->
-> <!-- TODO: switch link to dedicated DISA Hardening page when published. -->
-> https://documentation.ubuntu.com/canonical-kubernetes/latest/src/snap/howto/cis-hardening/#configure-auditing
+> Kube API Server of the k8s-snap can be found in the [hardening guide page].
 >
 
 
@@ -6117,10 +6114,10 @@ test $? -eq 0 && echo PASS || echo FAIL
 The final line of the output will be `PASS`.
 
 <!-- Links -->
-[Hardening]:security/hardening.md
 [getting started]: ../../tutorial/getting-started
 [post-deployment hardening]: hardening.md
 [Kubernetes STIG]:https://www.stigviewer.com/stig/kubernetes/
+[hardening guide page]: hardening.md#set-event-rate-limits
 [V-242381]:https://www.stigviewer.com/stig/kubernetes/2024-06-10/finding/V-242381
 [V-242383]:https://www.stigviewer.com/stig/kubernetes/2024-06-10/finding/V-242383
 [V-242386]:https://www.stigviewer.com/stig/kubernetes/2024-06-10/finding/V-242386

docs/src/snap/howto/storage/ceph.md

@@ -328,10 +328,10 @@ Ceph documentation: [Intro to Ceph].
 
 <!-- LINKS -->
 
-[Ceph]: https://ceph.com/
+[Ceph]: https://ceph.io/
 [getting-started-guide]: ../../tutorial/getting-started.md
 [block-devices-and-kubernetes]: https://docs.ceph.com/en/latest/rbd/rbd-kubernetes/
 [placement groups]: https://docs.ceph.com/en/mimic/rados/operations/placement-groups/
-[Intro to Ceph]: https://docs.ceph.com/en/latest/start/intro/
+[Intro to Ceph]: https://docs.ceph.com/en/reef/start/
 [authorisation capabilities page]:[https://docs.ceph.com/en/latest/rados/operations/user-management/#authorization-capabilities]
 [example ConfigMap]:https://github.com/ceph/ceph-csi/blob/devel/examples/kms/vault/kms-config.yaml

docs/src/snap/howto/two-node-ha.md

@@ -407,7 +407,7 @@ To recover DRBD, use following procedure:
 
 ```
 # On the stale node:
-sudo drbdadm secondary r0 
+sudo drbdadm secondary r0
 sudo drbdadm disconnect r0
 sudo drbdadm -- --discard-my-data connect r0
 
@@ -425,6 +425,6 @@ sudo drbdadm connect r0
 [getting started]: ../tutorial/getting-started
 [add/remove nodes]: ../tutorial/add-remove-nodes
 [Pacemaker]: https://clusterlabs.org/pacemaker/
-[Corosync]: https://clusterlabs.org/corosync.html
+[Corosync]: https://corosync.github.io/corosync/
 [Pacemaker fencing]: https://clusterlabs.org/pacemaker/doc/2.1/Pacemaker_Explained/html/fencing.html
 [split brain]: https://en.wikipedia.org/wiki/Split-brain_(computing)