(docs): Switch from PySpelling to Vale for spellchecking

docs/.custom_wordlist.txt

@@ -1,221 +1,23 @@
-# Leave a blank line at the end of this file to support concatenation
-anbox
-AnyConnect
-ApplicationFirewall
-ARP
-autostart
-backend
+# Leave a black line at the bottom
 backend's
-backends
-BBCcode
 boolean
-bootpd
-BPF
-cal
-cdimages
-CIFS
-Citrix
-cjk
-cloneN
-CloudFlare
-cloudflared
-CommonMark
-conf
-config
 CPU
-cpu
 CPUs
-cpus
-cryptographically
-CSV
-customisations
-customized
-Cygwin
-de
 dev
-DHCP
-DNS
-dnscrypt
-dnsmasq
-dvipng
 echoless
-ESET
 ethernet
-facto
-Fi
-filesystem
-fonts
-freefont
-GiB
-GID
-github
-GPG
-GUI
-gui
-gyre
-hacky
-hardcoded
-https
 Hyperkit
-ICMP
-ing
-init
-init's
-IP
-ip
 IPs
-ips
-IPv
-iUDP
-jellyfin
 Junos
 Kaspersky
-KiB
-Kudu
-lang
-latexmk
-launchd
-libexec
-libvirt
-lifecycle
-liger
-localhost
-lsof
-macOS
-macOS's
-MACs
-mDNSResponder
-mentorship
-metallb
-MiB
-microk
-Microk
-Microk8s
-Minikube
-minikube
 misconfiguration
-mr
-mscho
-multipass
-Multipass
-Multipass's
-multipassd
-netplan
-Netplan
-Netscaler
-NetworkManager
-NGINX
-nginx
-nic
 NIC
 NICs
-nilgai
-numpad
-OpenConnect
-OpenGL
-OpenSSL
-OpenVPN
-otf
 overallocate
 passwordless
-plantuml
-plist
 Portainer
-Portainer's
-PowerShell
-provisioner
-provisioners
-PsExec
-PSTools
-QCOW
-QEMU
-RDP
-Remmina
-repo
-resolv
-SHA
-SMB
-snapshotN
-socketfilterfw
-SonicWall
-SourceForge
-SSHFS
-subnet
-sudo
 Symantec
-TCP
 teardown
-tex
-texlive
-TLS
-TOC
-trumpetfish
-Tunnelblick
-ubuntu
-Ubuntu
-UDP
-UEFI
-UID
-umount
-unalias
 unmount
-Unmounting
 unmounts
-userspace
-usr
-UTF
-utils
-VcXsrv
-VirtualBox
-VirtualBox's
-vm
-VM
-VM's
-vmnet
-VMs
-VNC
-VPN
 VPNs
-WCAG
-whipsnake
-Wi
-xetex
-xindy
-XLaunch
-Xming
-XOrg
-XQuartz
-
-aaryan
-andreitoterman
-bagustris
-bo
-candlerb
-dan
-davidekete
-georgeliaojia
-gzanchi
-henryschreineriii
-itecompro
-luisp
-makin
-naynayu
-ng
-nhart
-nottrobin
-pitifulpete
-porwal
-QuantumLibet
-ricab
-ros
-roscigno
-saviq
-sergiusens
-sharder
-shuuji
-sowasred
-sparkiegeek
-sven
-tmihoc
-townsend
-undefynd

docs/.sphinx/.wordlist.txt

@@ -61,4 +61,4 @@ UI
 UUID
 VM
 webhook
-YAML
+YAML

docs/.sphinx/get_vale_conf.py

@@ -5,7 +5,6 @@
 
 DIR = os.getcwd()
 
-
 def main():
     if os.path.exists(f"{DIR}/.sphinx/styles/Canonical"):
         print("Vale directory exists")
@@ -23,6 +22,22 @@ def main():
         file.write(download.text)
         file.close()
 
+    # Update dictionary
+    if os.path.exists(f"{DIR}/.sphinx/styles/config/dictionaries"):
+        print("Dictionary directory exists")
+    else:
+        os.makedirs(f"{DIR}/.sphinx/styles/config/dictionaries")
+    url = (
+        "https://api.github.com/repos/canonical/praecepta/"
+        + "contents/styles/config/dictionaries"
+    )
+    r = requests.get(url)
+    for item in r.json():
+        download = requests.get(item["download_url"])
+        file = open(".sphinx/styles/config/dictionaries/" + item["name"], "w")
+        file.write(download.text)
+        file.close()
+
     if os.path.exists(f"{DIR}/.sphinx/styles/config/vocabularies/Canonical"):
         print("Vocab directory exists")
     else:
@@ -50,4 +65,4 @@ def main():
 
 
 if __name__ == "__main__":
-    main()
+    main()

docs/Makefile

@@ -17,6 +17,7 @@ ALLFILES        =  *.rst **/*.rst
 METRICSDIR      = $(SOURCEDIR)/.sphinx/metrics
 REQPDFPACKS     = latexmk fonts-freefont-otf texlive-latex-recommended texlive-latex-extra texlive-fonts-recommended texlive-font-utils texlive-lang-cjk texlive-xetex plantuml xindy tex-gyre dvipng
 CONFIRM_SUDO    ?= N
+VALE_CONFIG     = $(SPHINXDIR)/vale.ini
 
 # Put it first so that "make" without argument is like "make help".
 help:
@@ -61,6 +62,14 @@ $(VENVDIR):
 	@. $(VENV); pip list --local --format=freeze > $(VENVDIR)/pip_list.txt
 	@touch $(VENVDIR)
 
+vale-install: install
+	@. $(VENV); test -d $(SPHINXDIR)/venv/lib/python*/site-packages/vale || pip install rst2html vale
+	@. $(VENV); test -f $(VALE_CONFIG) || python3 $(SPHINXDIR)/get_vale_conf.py
+	@echo '.Name=="Canonical.400-Enforce-inclusive-terms"' > $(SPHINXDIR)/styles/woke.filter
+	@echo '.Level=="error" and .Name!="Canonical.500-Repeated-words" and .Name!="Canonical.000-US-spellcheck"' > $(SPHINXDIR)/styles/error.filter
+	@echo '.Name=="Canonical.000-US-spellcheck"' > $(SPHINXDIR)/styles/spelling.filter
+	@. $(VENV); find $(SPHINXDIR)/venv/lib/python*/site-packages/vale/vale_bin -size 195c -exec vale --version \;
+
 woke-install:
 	@type woke >/dev/null 2>&1 || \
 	{ \
@@ -124,10 +133,17 @@ clean-doc:
 	git clean -fx "$(BUILDDIR)"
 	rm -rf $(SPHINXDIR)/.doctrees
 
-spellcheck: spellcheck-install
-	. $(VENV) ; python3 -m pyspelling -c $(SPHINXDIR)/spellingcheck.yaml -j $(shell nproc)
+vale-spelling: vale-install
+	@cat $(SPHINXDIR)/styles/config/vocabularies/Canonical/accept.txt > $(SPHINXDIR)/styles/config/vocabularies/Canonical/accept_backup.txt
+	@cat $(SPHINXDIR)/.wordlist.txt $(SOURCEDIR)/.custom_wordlist.txt >> $(SPHINXDIR)/styles/config/vocabularies/Canonical/accept.txt
+	@echo "Running Vale against $(TARGET). To change target set TARGET= with make command"
+	@. $(VENV); vale --config="$(VALE_CONFIG)" --filter='$(SPHINXDIR)/styles/spelling.filter' --glob='*.{md,rst}' $(TARGET)
+	@cat $(SPHINXDIR)/styles/config/vocabularies/Canonical/accept_backup.txt > $(SPHINXDIR)/styles/config/vocabularies/Canonical/accept.txt && rm $(SPHINXDIR)/styles/config/vocabularies/Canonical/accept_backup.txt
+
+
+spellcheck: vale-spelling
 
-spelling: html spellcheck
+spelling: clean-doc vale-spelling # clean built html and Use Vale for spelling check
 
 linkcheck: install
 	. $(VENV) ; $(SPHINXBUILD) -b linkcheck "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) || { grep --color -F "[broken]" "$(BUILDDIR)/output.txt"; exit 1; }
@@ -140,16 +156,11 @@ woke: woke-install
 pa11y: pa11y-install html
 	find $(BUILDDIR) -name *.html -print0 | xargs -n 1 -0 $(PA11Y)
 
-vale: install
-	@. $(VENV); test -d $(SPHINXDIR)/venv/lib/python*/site-packages/vale || pip install vale
-	@. $(VENV); test -f $(SPHINXDIR)/vale.ini || python3 $(SPHINXDIR)/get_vale_conf.py
-	@. $(VENV); find $(SPHINXDIR)/venv/lib/python*/site-packages/vale/vale_bin -size 195c -exec vale --config "$(SPHINXDIR)/vale.ini" $(TARGET) > /dev/null \;
+vale: vale-install
 	@cat $(SPHINXDIR)/styles/config/vocabularies/Canonical/accept.txt > $(SPHINXDIR)/styles/config/vocabularies/Canonical/accept_backup.txt
 	@cat $(SPHINXDIR)/.wordlist.txt $(SOURCEDIR)/.custom_wordlist.txt >> $(SPHINXDIR)/styles/config/vocabularies/Canonical/accept.txt
-	@echo ""
 	@echo "Running Vale against $(TARGET). To change target set TARGET= with make command"
-	@echo ""
-	@. $(VENV); vale --config "$(SPHINXDIR)/vale.ini" --glob='*.{md,rst}' $(TARGET) || true
+	@. $(VENV); vale --config="$(VALE_CONFIG)" --filter='$(SPHINXDIR)/styles/error.filter' --glob='*.{md,rst}' $(TARGET)
 	@cat $(SPHINXDIR)/styles/config/vocabularies/Canonical/accept_backup.txt > $(SPHINXDIR)/styles/config/vocabularies/Canonical/accept.txt && rm $(SPHINXDIR)/styles/config/vocabularies/Canonical/accept_backup.txt
 
 pdf-prep: install

docs/how-to-guides/manage-instances/run-a-docker-container-in-multipass.md

@@ -199,4 +199,4 @@ You can now access your Ghost blog by going to the published port indicated in t
 
 There it is, your blog running within a Docker container inside Multipass!
 
-For next steps, try out Portainer’s other App Templates (Step 5), or check out [Docker Hub](https://hub.docker.com/search?type=image) for more containers to try. If you want to try out container orchestration, [Microk8s](https://microk8s.io/) or Multipass’ [Minikube](https://minikube.sigs.k8s.io/docs/) blueprint are great places to start.
+For next steps, try out Portainer’s other App Templates (Step 5), or check out [Docker Hub](https://hub.docker.com/search?type=image) for more containers to try. If you want to try out container orchestration, [Microk8s](https://microk8s.io/) or Multipass’ [`Minikube`](https://minikube.sigs.k8s.io/docs/) blueprint are great places to start.