[DX-286] Add spellcheck Github Action

.github/workflows/.spellcheck.yml

@@ -0,0 +1,27 @@
+name: Spellcheck
+
+on:
+  pull_request:
+    paths:
+      - '**/*.md'  # Trigger only if Markdown files change
+
+jobs:
+  run:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+
+      - name: Get all changed markdown files
+        uses: tj-actions/changed-files@v45
+        id: changed_files
+        with:
+          files: |
+            **.md
+
+      - name: Run Spellcheck
+        id: spellcheck
+        uses: rojopolis/spellcheck-github-actions@v0
+        with:
+          task_name: Markdown
+          source_files: ${{ steps.changed_files.outputs.all_changed_files }}

.spellcheck.yaml

@@ -1,18 +1,20 @@
 matrix:
-- name: Markdown
-  aspell:
-    lang: en
-  dictionary:
-    wordlists:
-    - .wordlist.txt
-    encoding: utf-8
-  pipeline:
-  - pyspelling.filters.markdown:
-  - pyspelling.filters.html:
-    comments: false
-    ignores:
-    - code
-    - pre
-  sources:
-  - '**/*.md'
-  default_encoding: utf-8
+  - name: Markdown
+    aspell:
+      aspell:
+        lang: en
+        d: en_US # American English
+    dictionary:
+      wordlists:
+        - .wordlist.txt  # Custom keywords to ignore
+      encoding: utf-8
+    pipeline:
+      - pyspelling.filters.markdown:
+          markdown_extensions:
+            - markdown.extensions.extra:
+      - pyspelling.filters.html:
+          comments: false
+          ignores:
+            - code
+            - pre
+    default_encoding: utf-8

.wordlist.txt

@@ -0,0 +1,124 @@
+Tyk
+Tyk-Dashboard
+Tyk-Gateway
+Tyk-Pump
+Tyk-Sync
+MDCB   
+TIB
+JWT
+JWK
+JWKs
+API
+APIs
+api
+apis
+Redis
+MongoDB
+Pump
+Tyk's
+enum
+schemas
+GraphQL
+graphql
+middleware
+JSON
+json
+elasticsearch
+tyk
+url
+http
+https
+tls
+TLS
+conf
+config
+init
+io
+sharded
+OpenAPI
+Swagger
+swagger
+memprofile
+mprof
+pprof
+Mutex
+mutexprof
+mutexprofile
+blockprof
+blockprofile
+goroutine
+goroutines
+dereference
+runtime
+DRL
+proxying
+unmarshal
+Github
+packagecloud
+analytics
+natively
+IDP
+UI
+OAuth2.0
+pem
+PEM
+JQ
+jq
+hmac
+HMAC
+SHA
+sha
+keyless
+IAM
+dev
+SSO
+sso
+SSL
+ssl
+CMS
+Quickstart
+Rebase
+rebase
+AWS
+MPL
+blockquote
+performant
+namespace
+Etcd
+uptime
+Proxied
+proxied
+AuthToken
+querystring
+httpbin
+Param
+param
+TCP
+microservice
+Golang
+Uptime
+uptime
+CoProcess
+JSVM
+coprocess
+TykMakeBatchRequest
+TykMakeHttpRequest
+crypto
+golang
+ELB
+cpuprofile
+profiler
+httpprofile
+mutex
+mutexes
+IoT
+stderr
+stdout
+sudo
+CSRF
+TykTechnologies
+CNAME
+balancer
+DataSources
+Datasource
+UDG

tyk-docs/content/tyk-environment-variables.md

@@ -11,7 +11,7 @@ aliases:
   - /configure/environment-variables/
 ---
 
-Please find the following links to all the configuration reference pages per product (Gateway, Dashboard, Pump, MDCB, Enterprise Developer Portal and Identity Broker)
+Plese find the following links to all the configuration reference pages per product (Gateway, Dashboard, Pump, MDCB, Enterprise Developer Portal and Identity Broker)
 Each page includes a list of all the config fields that can be used in the config file to set and tune the product.
 Every item in the lists includes the config name in JSON notation, the format as an environment variable, the field type and a short description.