Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs spec check #707

Merged
merged 23 commits into from
Oct 2, 2024
Merged
Show file tree
Hide file tree
Changes from 5 commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 23 additions & 0 deletions .github/workflows/spelling-doc-checks.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
name: Documentation Spelling Check

on:
workflow_dispatch:
pull_request:
paths:
- 'docs/**'

concurrency:
group: ${{ github.workflow }}-${{ github.ref }}
cancel-in-progress: true

jobs:

spellsheck:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- name: Install aspell
run: sudo apt-get install aspell aspell-en
- name: Spell Check
run: make spelling
working-directory: docs/tools
1 change: 1 addition & 0 deletions docs/moonray/.sphinx/requirements.txt
Original file line number Diff line number Diff line change
@@ -1,2 +1,3 @@
git+https://github.com/canonical/canonical-sphinx@main#egg=canonical-sphinx
sphinx-autobuild
pyspelling
65 changes: 65 additions & 0 deletions docs/tools/.custom_wordlist.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,65 @@
apiserver
apparmor
AppArmor
autostart
aws
CAPI
cgroup
CIDRS
CIDRs
CNI
config
containerd
CoreDNS
CPUs
cpuset
daemonset
datastore
dbus
DNS
dqlite
etcd
GCP
ghcr
grafana
html
http
https
initialize
evilnick marked this conversation as resolved.
Show resolved Hide resolved
juju
kubeconfig
kubectl
kubelet
kubepods
kubernetes
libcontainer
lifecycle
linux
localhost
lxc
LXD
MAAS
multipass
evilnick marked this conversation as resolved.
Show resolved Hide resolved
nameservers
NGINX
OCI
Openstack
evilnick marked this conversation as resolved.
Show resolved Hide resolved
proc
RBAC
regsync
roadmap
Rockcraft
rw
snapd
stackexchange
sys
systemd
TLS
ubuntu
unix
VMs
VMWare
VSphere
www
yaml

2 changes: 1 addition & 1 deletion docs/tools/.sphinx/spellingcheck.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ matrix:
- .custom_wordlist.txt
output: .sphinx/.wordlist.dic
sources:
- _build/**/*.html
- ../_build/**/*.html
pipeline:
- pyspelling.filters.html:
comments: false
Expand Down
Loading