Skip to content

Commit

Permalink
build(docs): auto alphabetize .spelling file (#12521)
Browse files Browse the repository at this point in the history
Signed-off-by: Anton Gilgur <agilgur5@gmail.com>
(cherry picked from commit df79ce4)
  • Loading branch information
agilgur5 committed May 11, 2024
1 parent 2071a90 commit 4dd50bf
Show file tree
Hide file tree
Showing 3 changed files with 41 additions and 35 deletions.
4 changes: 2 additions & 2 deletions .github/workflows/docs.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -32,8 +32,8 @@ jobs:
# Use the same make target both locally and on CI to make it easier to debug failures.
- name: Build & Lint docs
run: make docs
# If markdownlint fixes issues, files will be changed. If so, fail the build.
- name: Check if markdownlint --fix made changes
# If linters auto-fix issues, files will be changed. If so, fail the build.
- name: Check if linters made changes
run: git diff --exit-code
# Upload the site so reviewers see it.
- name: Upload Docs Site
Expand Down
70 changes: 37 additions & 33 deletions .spelling
Original file line number Diff line number Diff line change
@@ -1,8 +1,4 @@
# markdown-spellcheck spelling configuration file
# Format - lines beginning # are comments
# global dictionary is at the start, file overrides afterwards
# one word per line, to define a file override use ' - filename'
# where filename is relative to this configuration file
# markdown-spellcheck dictionary
000s
0s
100Mi
Expand Down Expand Up @@ -35,10 +31,6 @@ ArgoLabs
Artifactory
BlackRock
Breitgand
Codespaces
Couler
ClusterRoles
ClusterRoleBinding
CRD
CRDs
CloudSQL
Expand All @@ -53,24 +45,25 @@ CronWorkflows
DataDog
Dataflow
DevOps
Devenv
Dex
EditorConfig
EtcD
EventRouter
Generator
GitOps
Github
Golang
goroutine
goroutines
Grafana
Grammarly
Hadoop
Heptio
Homebrew
IAM-based
IPs
InitContainer
InsideBoard
Invocators
IAM-based
Istio
Jemison
JetBrains
Expand All @@ -82,10 +75,11 @@ Killercoda
KubectlExec
Kubeflow
Kustomize
LDFlags
Lifecycle-Hook
LitmusChaos
metadata
MLOps
Makefile
MinIO
Minikube
MySQL
Expand All @@ -96,7 +90,7 @@ Node.JS.
OAuth
OAuth2
Okta
parameterizing
OpenAPI
PDBs
PProf
PVCs
Expand All @@ -105,26 +99,30 @@ Ploomber
Postgres
Roadmap
RoleBinding
s3
SDKs
SageMaker
ServiceAccount
Sharding
shortcodes
Singer.io
Snyk
Sumit
Tekton
Traefik
Triaging
TripAdvisor
UI
VSCode
Valasek
Webhooks
Welch
WorkflowTemplate
WorkflowTemplates
a.m.
anded
apis
architecting
argo
argoproj
args
async
auth
Expand All @@ -137,7 +135,11 @@ config
cpu
cron
daemoned
dependabot
dev
devenv
dockershim
docs
dropdown
e.g.
e2e
Expand All @@ -148,31 +150,42 @@ errored
expr
fibonacci
finalizer
gitops
goroutine
goroutines
govaluate
gzipped
Generator
i.e.
idempotence
instantiator
instantiators
jenkins
k3d
k3s
k8s-jobs
kube
kube-apiserver
kube-scheduler
kubectl
kubelet
kubernetes
liveness
localhost
maxFailures
maxSuccess
memoization
memoized
memoizing
metadata
minikube
mutex
namespace
namespaces
natively
OpenAPI
nix.conf
non-member
p.m.
parameterizing
params
pprof
pre-commit
Expand All @@ -181,16 +194,19 @@ repo
roadmap
runtime
runtimes
s3
sandboxed
shortcodes
stateful
stderr
triaged
un-reconciled
v1
v1.0
v1.1
v1.2
v1.3
v1.24
v1.3
v2
v2.0
v2.1
Expand Down Expand Up @@ -218,23 +234,11 @@ v3.4
v3.4.
v3.5
validator
vendored
versioned
versioning
webHDFS
webhook
webhooks
workflow-controller-configmap
WorkflowTemplate
WorkflowTemplates
yaml
idempotence
kube-scheduler
kube-apiserver
kubectl
Makefile
Devenv
devenv
vendored
nix.conf
LDFlags
dev
dependabot
2 changes: 2 additions & 0 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -685,6 +685,8 @@ endif
docs-spellcheck: /usr/local/bin/mdspell
# check docs for spelling mistakes
mdspell --ignore-numbers --ignore-acronyms --en-us --no-suggestions --report $(shell find docs -name '*.md' -not -name upgrading.md -not -name README.md -not -name fields.md -not -name upgrading.md -not -name swagger.md -not -name executor_swagger.md -not -path '*/cli/*')
# alphabetize spelling file -- ignore first line (comment), then sort the rest case-sensitive and remove duplicates
$(shell cat .spelling | awk 'NR<2{ print $0; next } { print $0 | "sort" }' | uniq | tee .spelling > /dev/null)

/usr/local/bin/markdown-link-check:
# update this in Nix when upgrading it here
Expand Down

0 comments on commit 4dd50bf

Please sign in to comment.