From d1108dc19654e5f9300fbabf77080e844f7b96be Mon Sep 17 00:00:00 2001
From: Jonas Bardino <bardino@nbi.ku.dk>
Date: Tue, 2 Apr 2024 16:43:23 +0200
Subject: [PATCH] Add a simple spellchecker to weed out common typos etc. in
 the docs.

---
 .github/workflows/ci.yml         |  2 ++
 .github/workflows/spellcheck.yml | 31 +++++++++++++++++++++++++++++++
 .spellcheck-wordlist.txt         | 17 +++++++++++++++++
 .spellcheck.yml                  | 27 +++++++++++++++++++++++++++
 4 files changed, 77 insertions(+)
 create mode 100644 .github/workflows/spellcheck.yml
 create mode 100644 .spellcheck-wordlist.txt
 create mode 100644 .spellcheck.yml

diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
index 903334a3..fb0f89fa 100644
--- a/.github/workflows/ci.yml
+++ b/.github/workflows/ci.yml
@@ -12,6 +12,8 @@ on:
       - 'doc/**'
       - '1.gocd.yml'
       - '.gitignore'
+      - '.spellcheck.yml'
+      - '.spellcheckwordlist.txt'
 
   push:
     branches:
diff --git a/.github/workflows/spellcheck.yml b/.github/workflows/spellcheck.yml
new file mode 100644
index 00000000..6abfa84f
--- /dev/null
+++ b/.github/workflows/spellcheck.yml
@@ -0,0 +1,31 @@
+name: Spell Checking
+on:
+  pull_request:
+    types:
+      - opened
+      - reopened
+      - synchronize
+    branches:
+      - master
+    paths-ignore:
+      - '**/*.py'
+      - '**/*.yml'
+      - '.gitignore'
+
+  push:
+    branches:
+      - master
+    tags:
+      - v**
+
+jobs:
+  check-spelling:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Check out repository contents
+        uses: actions/checkout@v3
+      - name: Check Spelling of docs
+        uses: rojopolis/spellcheck-github-actions@0.36.0
+        with:
+          config_path: .spellcheck.yml
+          task_name: Markdown
diff --git a/.spellcheck-wordlist.txt b/.spellcheck-wordlist.txt
new file mode 100644
index 00000000..ed77d7bc
--- /dev/null
+++ b/.spellcheck-wordlist.txt
@@ -0,0 +1,17 @@
+MiGrid
+MiG
+ERDA
+SIF
+HPC
+docker
+podman
+ansible
+centos
+rocky
+sftp
+ftps
+webdavs
+openid
+seafile
+jupyter
+duplicati
diff --git a/.spellcheck.yml b/.spellcheck.yml
new file mode 100644
index 00000000..d04e8eb0
--- /dev/null
+++ b/.spellcheck.yml
@@ -0,0 +1,27 @@
+matrix:
+- name: Markdown
+  expect_match: false
+  aspell:
+    mode: en
+  dictionary:
+    wordlists:
+    - .spellcheck-wordlist.txt
+    output: wordlist.dic
+    encoding: utf-8
+  pipeline:
+  - pyspelling.filters.markdown:
+      markdown_extensions:
+      - markdown.extensions.extra:
+  - pyspelling.filters.html:
+      comments: false
+      attributes:
+      - alt
+      ignores:
+      - ':matches(code, pre)'
+      - 'code'
+      - 'pre'
+      - 'blockquote'
+  sources:
+  - '*.md'
+  - 'doc/source/**/*.md'
+  default_encoding: utf-8