Add action to spell check docs and README

.github/workflows/.spellcheck.yml

@@ -0,0 +1,21 @@
+matrix:
+  - name: Markdown
+    expect_match: false
+    apsell:
+      mode: en
+    dictionary:
+      wordlists:
+        - .github/workflows/.wordlist.txt
+      output: wordlist.dic
+      encoding: utf-8
+    pipeline:
+      - pyspelling.filters.html:
+          comments: false
+          attributes:
+            - alt
+          ignores:
+            - 'code'
+            - 'pre'
+    sources:
+      - 'docs/*.adoc'
+      - 'docs/**/*.adoc'

.github/workflows/.wordlist.txt

@@ -0,0 +1,21 @@
+// Actual words to ignore
+
+analytics
+cas
+cbsh
+config
+Config
+connstr
+Couchbase
+csv
+CSV
+dev
+hostnames
+json
+JSON
+kv
+mydoc
+tls
+TLS
+toml
+upsert

.github/workflows/ci.yml

@@ -159,4 +159,15 @@ jobs:
       - uses: hustcer/setup-nu@main
         with:
           version: "*"
-      - run: nu docs/sample_config/prompt_tests.nu
+      - run: nu docs/sample_config/prompt_tests.nu
+
+  check-spelling:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+      - name: Check Spelling
+        uses: rojopolis/[email protected]
+        with:
+          config_path: .github/workflows/.spellcheck.yml
+          task_name: Markdown

docs/exporting-data.adoc

@@ -12,7 +12,7 @@ If you want to only store the document body then you can use `doc get <id> | get
 
 ===== To JSON
 
-From KeyValue
+From key-value
 ```
 > doc get airport_3719 --bucket travel-sample
 ╭───┬──────────────┬────────────────────────────────────┬─────────────────────┬───────┬─────────╮
@@ -152,7 +152,7 @@ To Multiple Documents
 
 ===== To CSV
 
-From KeyValue
+From key-value
 
 [options="nowrap"]
 ```

docs/importing-data.adoc

@@ -3,7 +3,7 @@
 Couchbase Shell supports loading data from a variety of formats and sources.
 
 The simplest way to import data is using `doc import` as covered in <<_loading_data_into_the_shell,Loading data into the shell>>.
-These recipes will cover more advanced usecases.
+These recipes will cover more advanced use cases.
 
 ==== A Note On Data format
 

docs/recipes.adoc

@@ -3,7 +3,7 @@
 :sectnums:
 
 Welcome to the recipes section of the Couchbase Shell `cbsh` documentation.
-Here you can find how powerful tasks can be performed by a combination of pipelined statements using `cbsh`.
+Here you can find how powerful tasks can be performed by a combining `cbsh` statements.
 
 include::recipes/register_cluster.adoc[]