Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

De-duplicates the extension and CI word lists. #2044

Merged
merged 1 commit into from
Oct 19, 2023
Merged

De-duplicates the extension and CI word lists. #2044

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
59 changes: 3 additions & 56 deletions .vscode/settings.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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"
},
}
8 changes: 4 additions & 4 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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)

Expand Down
9 changes: 6 additions & 3 deletions cspell.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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"
],
Expand Down
1 change: 1 addition & 0 deletions dictionary-octopus.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
astro