diff --git a/.vscode/settings.json b/.vscode/settings.json index d9c6152bd1..226d74511d 100644 --- a/.vscode/settings.json +++ b/.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" + }, } \ No newline at end of file diff --git a/README.md b/README.md index 713b96c6e4..aed48fd38c 100644 --- a/README.md +++ b/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) diff --git a/cspell.json b/cspell.json index 7e4f253b37..90cf6e0b9f 100644 --- a/cspell.json +++ b/cspell.json @@ -1,13 +1,12 @@ { "version": "0.2", "language": "en", - "words": [ - "astro", - "cutover", - "octopusdeploy", - "runbook", - "runbooks" - ], + "dictionaries": ["dictionary-octopus"], + "dictionaryDefinitions": [{ + "name": "dictionary-octopus", + "path": "./dictionary-octopus.txt", + "addWords": false + }], "flagWords": [ "hte" ], @@ -18,4 +17,4 @@ "pnpm-lock.yaml", "node_modules/**" ] -} \ No newline at end of file +} diff --git a/dictionary-octopus.txt b/dictionary-octopus.txt new file mode 100644 index 0000000000..8213e9234d --- /dev/null +++ b/dictionary-octopus.txt @@ -0,0 +1,5 @@ +astro +cutover +octopusdeploy +runbook +runbooks \ No newline at end of file