This is an automated email from the ASF dual-hosted git repository.
adoroszlai pushed a commit to branch HDDS-9225-website-v2
in repository https://gitbox.apache.org/repos/asf/ozone-site.git
The following commit(s) were added to refs/heads/HDDS-9225-website-v2 by this
push:
new fc6172ba HDDS-11970. Ignore markdown code blocks in cspell (#118)
fc6172ba is described below
commit fc6172bab8b9617f97b9981508b9e68181d67a70
Author: Ethan Rose <[email protected]>
AuthorDate: Sat Dec 21 00:02:04 2024 -0500
HDDS-11970. Ignore markdown code blocks in cspell (#118)
---
CONTRIBUTING.md | 2 +-
cspell.yaml | 20 ++++++++++++++++++++
.../04-project/02-release-guide.md | 6 ------
3 files changed, 21 insertions(+), 7 deletions(-)
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index a99e1778..56cb21b7 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -190,7 +190,7 @@ Docusaurus provides many options for laying out
documentation pages and their me
#### Spelling
-The file names and content of all markdown pages are checked for spelling
mistakes using [cspell](https://cspell.org/) as part of GitHub actions.
Spelling can also be checked locally by running the script
[.github/scripts/spelling.sh](.github/scripts/spelling.sh). This requires you
to have pnpm's dev dependencies installed on your machine for cspell to work
(run `pnpm install --dev`).
+As part of the GitHub Actions CI, all markdown pages will be checked for
spelling mistakes using [cspell](https://cspell.org/). Markdown code blocks are
excluded from spelling checks. Spelling can also be checked locally by running
the script [.github/scripts/spelling.sh](.github/scripts/spelling.sh). This
requires you to have pnpm's dev dependencies installed on your machine for
cspell to work (run `pnpm install --dev`).
**If spell check fails for words that are correct but not recognized:**
diff --git a/cspell.yaml b/cspell.yaml
index 68515b9f..13ed0cc4 100644
--- a/cspell.yaml
+++ b/cspell.yaml
@@ -33,6 +33,26 @@ import:
- "@cspell/dict-shell/cspell-ext.json"
- "@cspell/dict-docker/cspell-ext.json"
+languageSettings:
+- languageId:
+ - markdown
+ - mdx
+ ignoreRegExpList:
+ - markdown_code_block
+ - markdown_inline_code
+
+patterns:
+- name: markdown_code_block
+ pattern: |
+ /
+ ^(\s*`{3,}).* # match the ```
+ [\s\S]*? # the block of code
+ ^\1 # end of the block
+ /gmx
+- name: markdown_inline_code
+ pattern: |
+ `[^`]*`
+
flagWords:
# Write "quasi-closed" instead of "quasi closed".
- quasi
diff --git a/docs/08-developer-guide/04-project/02-release-guide.md
b/docs/08-developer-guide/04-project/02-release-guide.md
index 9d796859..717d02f6 100644
--- a/docs/08-developer-guide/04-project/02-release-guide.md
+++ b/docs/08-developer-guide/04-project/02-release-guide.md
@@ -1,11 +1,5 @@
---
sidebar_label: Release Manager Guide
-
-# Custom words specific to this page:
-# cSpell:ignore protoroot codesigningkey lockdir pinentry gpgconf
orgapacheozone
-
-# On this page, ignore CLI options used with -D or -P.
-# cSpell:ignoreRegExp -(D|P)[a-z\.,]+([\s]|=)
---
# Apache Release Manager Guide
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
