Merge pull request #2044 from OctopusDeploy/sf/unified-cspell-config

De-duplicates the extension and CI word lists.

.vscode/settings.json

@@ -1,59 +1,6 @@
 {
     "markdown.validate.enabled": false,
-    "cSpell.words": [
-        "astro",
-        "auditability",
-        "Cloudsmith",
-        "comms",
-        "cutover",
-        "Datacenter",
-        "deployers",
-        "deregistering",
-        "DTUs",
-        "DWORD",
-        "eksctl",
-        "Frontmatter",
-        "globbing",
-        "healthcheck",
-        "HKLM",
-        "Lifecycles",
-        "Liquibase",
-        "NETBIOS",
-        "Netscaler",
-        "NTDS",
-        "NTLM",
-        "nupkg",
-        "Octo",
-        "octopusdeploy",
-        "octopusservernodes",
-        "octoserver",
-        "Octoshared",
-        "passout",
-        "Payara",
-        "Pitstop",
-        "pkcs",
-        "Postgre",
-        "Println",
-        "procexp",
-        "querystring",
-        "Redgate",
-        "remoting",
-        "Reprioritize",
-        "Robo",
-        "runbook",
-        "runbooks",
-        "Sakila",
-        "snapshotted",
-        "Springboot",
-        "sqlcmd",
-        "sqlvolume",
-        "struct",
-        "subfolders",
-        "tasklog",
-        "tasklogs",
-        "tsconfigs",
-        "unversioned",
-        "Websphere",
-        "Wildfly"
-    ]
+    "files.associations": {
+        "*.mdx": "markdown"
+    },
 }

README.md

@@ -37,9 +37,9 @@ The most common failures are:
 - A new image is referenced with the wrong path
 - An internal link has a bad address
 
-### Spell-check
+### Spell check
 
-You can run the spell-check locally using:
+You can run the spell check locally using:
 
 ```
 pnpm spellcheck
@@ -52,9 +52,9 @@ For each error detected, you'll need to decide whether to:
 - Correct your spelling, or
 - Propose an addition to the custom dictionary
 
-For example, if you added `MySQL` to an article and it was flagged as an unknown word, you could propose the addition of `MySQL` by adding it word list in the file `cspell.json`.
+For example, if you added `MySQL` to an article and it was flagged as an unknown word, you could propose the addition of `MySQL` by adding it word list in the file `dictionary-octopus.txt`.
 
-Some consideration should be given as to whether it should be `MySQL` or `MySql` and just a single entry should be added to `cspell.json` to promote consistency.
+Some consideration should be given as to whether it should be `MySQL` or `MySql` and just a single entry should be added to `dictionary-octopus.txt` to promote consistency.
 
 ## Deploying to preview environment (Octopus Developers)
 

cspell.json

@@ -1,9 +1,12 @@
 {
     "version": "0.2",
     "language": "en",
-    "words": [
-        "astro"
-    ],
+    "dictionaries": ["dictionary-octopus"],
+    "dictionaryDefinitions": [{
+            "name": "dictionary-octopus",
+            "path": "./dictionary-octopus.txt",
+            "addWords": false
+    }],
     "flagWords": [
         "hte"
     ],

dictionary-octopus.txt

@@ -0,0 +1 @@
+astro