docs - update docs workflow (#1059)

* add linkcheck to spellcheck workflow
* fix broken links
* add inclusive language to workflow
* rename files for clarity

Author: nhennigan

.github/workflows/docs-spelling-checks.yml .github/workflows/docs-checks.yml

@@ -1,4 +1,4 @@
-name: Documentation Spelling Check
+name: Documentation Checks
 
 on:
   workflow_dispatch:
@@ -9,16 +9,33 @@ permissions:
   contents: read
 
 jobs:
-  spell-check:
+  doc-checks:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v4
+      - name: Checkout
+        uses: actions/checkout@v4
+
       - name: Install vale
         run: sudo snap install vale
       - id: spell-check
         name: Spell Check
         run: vale --glob='*.{md,txt,rst}' .
         working-directory: docs/canonicalk8s
+
+      - name: Link Check
+        id: linkcheck-step
+        if: success() || failure()
+        uses: canonical/documentation-workflows/linkcheck@main
+        with:
+          working-directory: docs/canonicalk8s
+
+      - name: Inclusive Language Check
+        id: woke-step
+        if: success() || failure()
+        uses: canonical/documentation-workflows/inclusive-language@main
+        with:
+          working-directory: docs/canonicalk8s
+
       #  continue-on-error: true
       # - if: ${{ github.event_name == 'pull_request' && steps.spell-check.outcome == 'failure' }}
         # uses: actions/github-script@v6

.github/workflows/automatic-doc-checks.yml .github/workflows/moonray-doc-checks.yml

@@ -90,7 +90,7 @@ Use `juju status` to watch these units approach the active/idle state.
 
 [Installing]:    ./index
 [channels]:      ../../explanation/channels
-[credentials]:   https://juju.is/docs/juju/credentials
+[credentials]:   https://canonical-juju.readthedocs-hosted.com/en/latest/user/reference/credential/
 [juju]:          https://juju.is/docs/juju/install-juju
 [charm]:         https://juju.is/docs/juju/charmed-operator
 [localhost]:     install-lxd

docs/canonicalk8s/charm/howto/install/charm.md

@@ -211,7 +211,7 @@ to ensure that the cluster is fully functional.
 [backup-restore]:      ../../snap/howto/backup-restore
 [charmhub]:            https://charmhub.io/k8s
 [cluster-validation]:  ./validate
-[juju-docs]:           https://juju.is/docs/juju/upgrade-models
+[juju-docs]:           https://canonical-juju.readthedocs-hosted.com/en/latest/user/howto/manage-models/#manage-models
 [release-notes]:       ../reference/releases
 [upgrade-notes]:       ../reference/upgrade-notes
 [upstream-notes]:      https://github.com/kubernetes/kubernetes/blob/master/CHANGELOG/CHANGELOG-1.32.md#deprecation

docs/canonicalk8s/charm/howto/upgrade-minor.md

@@ -202,6 +202,6 @@ to ensure that the cluster is fully functional.
 [backup-restore]:     ../../snap/howto/backup-restore
 [charmhub]:            https://charmhub.io/k8s
 [cluster-validation]: ./validate
-[juju-docs]:          https://juju.is/docs/juju/upgrade-models
+[juju-docs]:          https://canonical-juju.readthedocs-hosted.com/en/latest/user/howto/manage-models/#manage-models
 [release-notes]:      ../reference/releases
 [upstream-notes]:     https://github.com/kubernetes/kubernetes/blob/master/CHANGELOG

docs/canonicalk8s/charm/howto/upgrade-patch.md

@@ -54,15 +54,13 @@ useful.
 
 As with previously released Kubernetes software from Canonical, we aim to
 satisfy the needs of various security compliance standards. This is a process
-that will take some time however. Please watch out for future announcements and
-check the [roadmap][] for current areas of work.
+that will take some time however.
 
 <!-- LINKS -->
 
 [Kubernetes Security documentation]: https://kubernetes.io/docs/concepts/security/overview/
 [snap documentation]: https://snapcraft.io/docs/security-policies
 [rocks-security]: https://documentation.ubuntu.com/rockcraft/en/latest/explanation/rockcraft.html
-[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/how-to-enhance-maas-security