Skip to content

Commit

Permalink
Spellcheck fixes (#749)
Browse files Browse the repository at this point in the history
Corrected typos in docs and created more extensive custom_wordslist
change spellcheck to manual launch rather than on every pull request
  • Loading branch information
nhennigan authored Nov 15, 2024
1 parent 81bb027 commit 79f3145
Show file tree
Hide file tree
Showing 50 changed files with 834 additions and 150 deletions.
28 changes: 14 additions & 14 deletions .github/workflows/docs-spelling-checks.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,9 @@ name: Documentation Spelling Check

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

jobs:
spell-check:
Expand All @@ -16,15 +16,15 @@ jobs:
- id: spell-check
name: Spell Check
run: make spelling
working-directory: docs/tools
working-directory: docs/canonicalk8s
continue-on-error: true
- if: ${{ github.event_name == 'pull_request' && steps.spell-check.outcome == 'failure' }}
uses: actions/github-script@v6
with:
script: |
github.rest.issues.createComment({
issue_number: context.issue.number,
owner: context.repo.owner,
repo: context.repo.repo,
body: 'Hi, looks like pyspelling job found some issues, you can check it [here](${{ github.server_url }}/${{ github.repository }}/actions/runs/${{ github.run_id }})'
})
# - if: ${{ github.event_name == 'pull_request' && steps.spell-check.outcome == 'failure' }}
# uses: actions/github-script@v6
# with:
# script: |
# github.rest.issues.createComment({
# issue_number: context.issue.number,
# owner: context.repo.owner,
# repo: context.repo.repo,
# body: 'Hi, looks like pyspelling job found some issues, you can check it [here](${{ github.server_url }}/${{ github.repository }}/actions/runs/${{ github.run_id }})'
# })
266 changes: 266 additions & 0 deletions docs/moonray/.custom_wordlist.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,266 @@
adapter's
adapters
allocatable
allocator
AlwaysPullImages
api
apiserver
apparmor
AppArmor
args
ARP
asn
ASN
autostart
autosuspend
aws
backend
backported
balancers
benoitblanchon
bgp
BGP
bootloader
CABPCK
CACPCK
capi
CAPI
CAs
Center
ceph
Ceph
cephcsi
cephx
cgroup
cgroups
cidr
CIDR
cidrs
CIDRs
CK8sControlPlane
CLI
CLIs
CloudFormation
ClusterAPI
clusterctl
ClusterRole
ClusterRoleBinding
CMK
CNI
Commenter
config
configMap
ConfigMap
containerd
CoreDNS
Corosync
CPUs
cpuset
crt
csi
CSI
CSRs
cyclictest
daemonset
DaemonSet
datastore
datastores
dbus
de
deallocation
deployable
discoverable
DMA
dns
DNS
DPDK
DRBD
drv
dqlite
EAL
EasyRSA
enp
enum
etcd
EventRateLimit
failover
gapped
GCP
ghcr
Gi
github
GPLv
Graber
Graber's
grafana
haircommander
Harbor
hostname
hostpath
HPC
html
http
https
HugePage
HugePages
iavf
init
initialise
integrations
io
IOMMU
IOV
ip
IPv
IPv4
IPv6
IRQs
Jinja
jitter
juju
Juju's
KMS
kube
kube-apiserver
kube-controller-manager
kube-proxy
kube-scheduler
kube-system
kubeconfig
kubectl
kubelet
kubepods
kubernetes
latencies
Latencies
libcontainer
lifecycle
linux
Lite's
LoadBalancer
localhost
Lookaside
lookups
loopback
LPM
lxc
LxcSecurity
LXD
MAAS
macOS
Maskable
MCE
MetalLB
Microbot
MicroCluster
MicroK
MicroK8s
MinIO
modprobe
Moonray
mq
mtu
MTU
multicast
MULTICAST
Multipass
Multus
nameservers
Netplan
NetworkAttachmentDefinition
NFD
NFV
nginx
NGINX
NIC
NMI
nodeport
nohz
NUMA
numactl
OCI
OOM
OpenStack
OSDs
ParseDuration
passthrough
passwordless
pci
PEM
performant
PID
PMD
PMDs
PPA
proc
programmatically
provisioner
PRs
PV
qdisc
qlen
QoS
RADOS
rbac
RBAC
RBD
rc
RCU
README
regctl
regsync
roadmap
Rockcraft
rollout
runtimes
rw
sandboxed
SANs
scalable
SCHED
sControlPlane
sd
SELinux
ServiceAccount
Snapcraft
snapd
SR-IOV
stackexchange
stgraber
STONITH
StorageClass
sudo
sys
systemd
taskset
Telco
throughs
tickless
TLB
tls
TLS
toml
TSC
TTL
ttyS
ubuntu
unix
unschedulable
unsquashed
Velero
vf
VF
vfio
VFIO
VFs
virtualised
VLAN
VMs
VMware
VNFs
VPCs
VSphere
WIP
www
yaml
YAMLs
Loading

0 comments on commit 79f3145

Please sign in to comment.