From 33e5df5a46afbd14e687a4c80ef2a21c4605f8b0 Mon Sep 17 00:00:00 2001 From: Meg McRoberts Date: Tue, 14 Nov 2023 19:14:26 -0800 Subject: [PATCH 01/23] docs: add spell-checker to contribute/docs Signed-off-by: Meg McRoberts --- .../en/contribute/docs/spell-check/_index.md | 41 +++++++++++++++++++ 1 file changed, 41 insertions(+) create mode 100644 docs/content/en/contribute/docs/spell-check/_index.md diff --git a/docs/content/en/contribute/docs/spell-check/_index.md b/docs/content/en/contribute/docs/spell-check/_index.md new file mode 100644 index 0000000000..345d5aec5c --- /dev/null +++ b/docs/content/en/contribute/docs/spell-check/_index.md @@ -0,0 +1,41 @@ +--- +title: Spell checker +description: How to work with the spell checker +weight: 375 +--- + +All PRs that are pushed to a Keptn repository +are run through a spell checker that is based on +[check-spelling](https://github.com/check-spelling/check-spelling) +Github action. + +Note, however, that you are still responsible for reading your text carefully. +The tool does not flag if you used a real word that is not the right word, +if you misuse "setup" versus "set up", and so forth. + +## Handling Spell Checker errors + +If you get a Spell Checker error: + +1. Right-click the `details` link for Spell Checker. +1. If you do not want to read through the whole (and rather verbose) log, + type `unrecognized words` in the search box at the top. +1. This shows the word(s) that caused Spell Checker to fail. + + - If these are genuine misspellings, + correct the spelling in your local branch + or using the github editor + and push the new commit to resolve the errors. + + - If a word that is flagged is a legitimate word, + follow the instructions in the report + to propose adding it to our dictionary. + This request will be added to your PR for review + and, if approved, will be merged when the PR is merged. + + - If your PR includes a file that should not be spell-checked, + you can add it to the + [excludes.txt](https://github.com/check-spelling/check-spelling/blob/main/.github/actions/spelling/excludes.txt) file + as part of your PR. + It will be reviewed and, if approved, + merged as part of your PR. From b8dbede4f346df48d46fd16980e5575ada20074a Mon Sep 17 00:00:00 2001 From: Meg McRoberts Date: Sun, 26 Nov 2023 22:27:12 -0800 Subject: [PATCH 02/23] internals Signed-off-by: Meg McRoberts --- .../en/contribute/docs/spell-check/_index.md | 41 ++++++++++++++++++- 1 file changed, 40 insertions(+), 1 deletion(-) diff --git a/docs/content/en/contribute/docs/spell-check/_index.md b/docs/content/en/contribute/docs/spell-check/_index.md index 345d5aec5c..ff2038151a 100644 --- a/docs/content/en/contribute/docs/spell-check/_index.md +++ b/docs/content/en/contribute/docs/spell-check/_index.md @@ -5,7 +5,7 @@ weight: 375 --- All PRs that are pushed to a Keptn repository -are run through a spell checker that is based on +are run through a spell checker that is based on the [check-spelling](https://github.com/check-spelling/check-spelling) Github action. @@ -39,3 +39,42 @@ If you get a Spell Checker error: as part of your PR. It will be reviewed and, if approved, merged as part of your PR. + +For more details about handling errors that are found, see the +[Check-spelling docs](https://docs.check-spelling.dev/Showcase.html). + +## Implementation details + +For full technical details about the spell checker, see: + +* [check-spelling documentation](https://docs.check-spelling.dev/) +* [check-spelling/.github repository](https://github.com/check-spelling/check-spelling/tree/main/.github) + +The Keptn spell checker checks both documentation and code for spelling, +based on a set of dictionaries: + +* We use general English language and technical terminology + from dictionaries that are provided and maintained by check-spelling. + The configuration is specified in the + [check-spelling-configuration/README[(https://github.com/check-spelling/check-spelling/blob/main/.github/actions/spelling/README.md) + file. +* We also use the specialized technical dictionaries provided by check-spelling + for Kubernetes and Go. +* The + [spelling](https://github.com/keptn/lifecycle-toolkit/tree/main/.github/actions/spelling) + folder contains files that are specific to Keptn. + [expect.txt](https://github.com/keptn/lifecycle-toolkit/tree/main/.github/actions/spelling) + lists Keptn terms for both documentation and code. + +Check-spelling supports both American and British spelling +and both are allowed in the Keptn documentation. + +check-spelling provides a number of dictionaries for non-English libraries +but we do not currently use those. + +Note that Check-spelling does not check for proper capitalization of terms. +All dictionary terms are listed with lowercase letters. +Check-spelling recognizes capitalized versions of these words but, +if capitalized words are listed in a dictionary, +check-spelling rejects non-capitalized forms +which are common in code. From 18ec00273b8eb77a955400a266f9f0a70f1f0fc6 Mon Sep 17 00:00:00 2001 From: Meg McRoberts Date: Sun, 26 Nov 2023 22:28:18 -0800 Subject: [PATCH 03/23] markdownlint-fix Signed-off-by: Meg McRoberts --- docs/content/en/contribute/docs/spell-check/_index.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/docs/content/en/contribute/docs/spell-check/_index.md b/docs/content/en/contribute/docs/spell-check/_index.md index ff2038151a..ac3822b948 100644 --- a/docs/content/en/contribute/docs/spell-check/_index.md +++ b/docs/content/en/contribute/docs/spell-check/_index.md @@ -47,20 +47,20 @@ For more details about handling errors that are found, see the For full technical details about the spell checker, see: -* [check-spelling documentation](https://docs.check-spelling.dev/) -* [check-spelling/.github repository](https://github.com/check-spelling/check-spelling/tree/main/.github) +- [check-spelling documentation](https://docs.check-spelling.dev/) +- [check-spelling/.github repository](https://github.com/check-spelling/check-spelling/tree/main/.github) The Keptn spell checker checks both documentation and code for spelling, based on a set of dictionaries: -* We use general English language and technical terminology +- We use general English language and technical terminology from dictionaries that are provided and maintained by check-spelling. The configuration is specified in the [check-spelling-configuration/README[(https://github.com/check-spelling/check-spelling/blob/main/.github/actions/spelling/README.md) file. -* We also use the specialized technical dictionaries provided by check-spelling +- We also use the specialized technical dictionaries provided by check-spelling for Kubernetes and Go. -* The +- The [spelling](https://github.com/keptn/lifecycle-toolkit/tree/main/.github/actions/spelling) folder contains files that are specific to Keptn. [expect.txt](https://github.com/keptn/lifecycle-toolkit/tree/main/.github/actions/spelling) From 48bde6382468375e708af3ccd9f7866e779048f1 Mon Sep 17 00:00:00 2001 From: Meg McRoberts Date: Wed, 29 Nov 2023 15:12:24 -0800 Subject: [PATCH 04/23] Update docs/content/en/contribute/docs/spell-check/_index.md Signed-off-by: Meg McRoberts meg.mcroberts@dynatrace.com Co-authored-by: Moritz Wiesinger Signed-off-by: Meg McRoberts --- docs/content/en/contribute/docs/spell-check/_index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/content/en/contribute/docs/spell-check/_index.md b/docs/content/en/contribute/docs/spell-check/_index.md index ac3822b948..26e6d3ff7f 100644 --- a/docs/content/en/contribute/docs/spell-check/_index.md +++ b/docs/content/en/contribute/docs/spell-check/_index.md @@ -7,7 +7,7 @@ weight: 375 All PRs that are pushed to a Keptn repository are run through a spell checker that is based on the [check-spelling](https://github.com/check-spelling/check-spelling) -Github action. +GitHub action. Note, however, that you are still responsible for reading your text carefully. The tool does not flag if you used a real word that is not the right word, From 210573d51a25c1e441a91ab7370b0cc30bc02396 Mon Sep 17 00:00:00 2001 From: Meg McRoberts Date: Wed, 29 Nov 2023 15:13:03 -0800 Subject: [PATCH 05/23] Update docs/content/en/contribute/docs/spell-check/_index.md Signed-off-by: Meg McRoberts meg.mcroberts@dynatrace.com Co-authored-by: Moritz Wiesinger Signed-off-by: Meg McRoberts --- docs/content/en/contribute/docs/spell-check/_index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/content/en/contribute/docs/spell-check/_index.md b/docs/content/en/contribute/docs/spell-check/_index.md index 26e6d3ff7f..1b1360d39c 100644 --- a/docs/content/en/contribute/docs/spell-check/_index.md +++ b/docs/content/en/contribute/docs/spell-check/_index.md @@ -35,7 +35,7 @@ If you get a Spell Checker error: - If your PR includes a file that should not be spell-checked, you can add it to the - [excludes.txt](https://github.com/check-spelling/check-spelling/blob/main/.github/actions/spelling/excludes.txt) file + [excludes.txt](https://github.com/keptn/lifecycle-toolkit/blob/main/.github/actions/spelling/excludes.txt) file as part of your PR. It will be reviewed and, if approved, merged as part of your PR. From 3a013f1cdcfffd551695d14968b18b7b49151d86 Mon Sep 17 00:00:00 2001 From: Meg McRoberts Date: Wed, 29 Nov 2023 15:13:28 -0800 Subject: [PATCH 06/23] Update docs/content/en/contribute/docs/spell-check/_index.md Signed-off-by: Meg McRoberts meg.mcroberts@dynatrace.com Co-authored-by: Moritz Wiesinger Signed-off-by: Meg McRoberts --- docs/content/en/contribute/docs/spell-check/_index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/content/en/contribute/docs/spell-check/_index.md b/docs/content/en/contribute/docs/spell-check/_index.md index 1b1360d39c..0808a7cd43 100644 --- a/docs/content/en/contribute/docs/spell-check/_index.md +++ b/docs/content/en/contribute/docs/spell-check/_index.md @@ -41,7 +41,7 @@ If you get a Spell Checker error: merged as part of your PR. For more details about handling errors that are found, see the -[Check-spelling docs](https://docs.check-spelling.dev/Showcase.html). +[Check-spelling docs](https://docs.check-spelling.dev/). ## Implementation details From 9dbe51d3f7e03996251d02386d44b93ff45d300c Mon Sep 17 00:00:00 2001 From: Meg McRoberts Date: Wed, 29 Nov 2023 15:13:47 -0800 Subject: [PATCH 07/23] Update docs/content/en/contribute/docs/spell-check/_index.md Signed-off-by: Meg McRoberts meg.mcroberts@dynatrace.com Co-authored-by: Moritz Wiesinger Signed-off-by: Meg McRoberts --- docs/content/en/contribute/docs/spell-check/_index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/content/en/contribute/docs/spell-check/_index.md b/docs/content/en/contribute/docs/spell-check/_index.md index 0808a7cd43..c7a7ab9380 100644 --- a/docs/content/en/contribute/docs/spell-check/_index.md +++ b/docs/content/en/contribute/docs/spell-check/_index.md @@ -48,7 +48,7 @@ For more details about handling errors that are found, see the For full technical details about the spell checker, see: - [check-spelling documentation](https://docs.check-spelling.dev/) -- [check-spelling/.github repository](https://github.com/check-spelling/check-spelling/tree/main/.github) +- [check-spelling GitHub repository](https://github.com/check-spelling/check-spelling) The Keptn spell checker checks both documentation and code for spelling, based on a set of dictionaries: From ef702d34187c8397d059d2bfa4529c1afc618ef4 Mon Sep 17 00:00:00 2001 From: Meg McRoberts Date: Wed, 29 Nov 2023 15:14:15 -0800 Subject: [PATCH 08/23] Update docs/content/en/contribute/docs/spell-check/_index.md Signed-off-by: Meg McRoberts meg.mcroberts@dynatrace.com Co-authored-by: Moritz Wiesinger Signed-off-by: Meg McRoberts --- docs/content/en/contribute/docs/spell-check/_index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/content/en/contribute/docs/spell-check/_index.md b/docs/content/en/contribute/docs/spell-check/_index.md index c7a7ab9380..7c4e5d6b87 100644 --- a/docs/content/en/contribute/docs/spell-check/_index.md +++ b/docs/content/en/contribute/docs/spell-check/_index.md @@ -69,7 +69,7 @@ based on a set of dictionaries: Check-spelling supports both American and British spelling and both are allowed in the Keptn documentation. -check-spelling provides a number of dictionaries for non-English libraries +Check-spelling provides a number of dictionaries for non-English languages but we do not currently use those. Note that Check-spelling does not check for proper capitalization of terms. From f74d7cf2834a0cf2643d94e954404deda5a97205 Mon Sep 17 00:00:00 2001 From: Meg McRoberts Date: Wed, 29 Nov 2023 15:15:44 -0800 Subject: [PATCH 09/23] Update docs/content/en/contribute/docs/spell-check/_index.md Signed-off-by: Meg McRoberts meg.mcroberts@dynatrace.com Signed-off-by: Meg McRoberts --- docs/content/en/contribute/docs/spell-check/_index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/content/en/contribute/docs/spell-check/_index.md b/docs/content/en/contribute/docs/spell-check/_index.md index 7c4e5d6b87..928fc8c592 100644 --- a/docs/content/en/contribute/docs/spell-check/_index.md +++ b/docs/content/en/contribute/docs/spell-check/_index.md @@ -69,7 +69,7 @@ based on a set of dictionaries: Check-spelling supports both American and British spelling and both are allowed in the Keptn documentation. -Check-spelling provides a number of dictionaries for non-English languages +Check-spelling provides dictionaries for number of non-English languages but we do not currently use those. Note that Check-spelling does not check for proper capitalization of terms. From 936ae3a27ab6bd90515fe33085ebd30d395c70ca Mon Sep 17 00:00:00 2001 From: Meg McRoberts Date: Wed, 29 Nov 2023 15:19:23 -0800 Subject: [PATCH 10/23] Update docs/content/en/contribute/docs/spell-check/_index.md Signed-off-by: Meg McRoberts meg.mcroberts@dynatrace.com Signed-off-by: Meg McRoberts --- docs/content/en/contribute/docs/spell-check/_index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/content/en/contribute/docs/spell-check/_index.md b/docs/content/en/contribute/docs/spell-check/_index.md index 928fc8c592..1eada68a47 100644 --- a/docs/content/en/contribute/docs/spell-check/_index.md +++ b/docs/content/en/contribute/docs/spell-check/_index.md @@ -69,7 +69,7 @@ based on a set of dictionaries: Check-spelling supports both American and British spelling and both are allowed in the Keptn documentation. -Check-spelling provides dictionaries for number of non-English languages +Check-spelling provides dictionaries for a number of non-English languages but we do not currently use those. Note that Check-spelling does not check for proper capitalization of terms. From 984331fc22c8840bd4e1313e153b2592f7d971e4 Mon Sep 17 00:00:00 2001 From: Meg McRoberts Date: Tue, 12 Dec 2023 21:49:22 -0800 Subject: [PATCH 11/23] correct config info per mo` Signed-off-by: Meg McRoberts --- .../en/contribute/docs/spell-check/_index.md | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/docs/content/en/contribute/docs/spell-check/_index.md b/docs/content/en/contribute/docs/spell-check/_index.md index 1eada68a47..5d97de69eb 100644 --- a/docs/content/en/contribute/docs/spell-check/_index.md +++ b/docs/content/en/contribute/docs/spell-check/_index.md @@ -55,16 +55,16 @@ based on a set of dictionaries: - We use general English language and technical terminology from dictionaries that are provided and maintained by check-spelling. - The configuration is specified in the - [check-spelling-configuration/README[(https://github.com/check-spelling/check-spelling/blob/main/.github/actions/spelling/README.md) - file. -- We also use the specialized technical dictionaries provided by check-spelling - for Kubernetes and Go. -- The - [spelling](https://github.com/keptn/lifecycle-toolkit/tree/main/.github/actions/spelling) - folder contains files that are specific to Keptn. + The configuration is specified in files in the + [.github/actions/spelling](https://github.com/keptn/lifecycle-toolkit/tree/main/.github/actions/spelling) + directory. [expect.txt](https://github.com/keptn/lifecycle-toolkit/tree/main/.github/actions/spelling) lists Keptn terms for both documentation and code. +- We also use the specialized technical dictionaries provided by check-spelling + for Kubernetes and Go. + The dictionaries we use are specified in the + [.github/workflows/spell-checker.yml](https://github.com/keptn/lifecycle-toolkit/blob/main/.github/workflows/spell-checker.yml) + file. Check-spelling supports both American and British spelling and both are allowed in the Keptn documentation. From 47a3e8fe1134c7619e2adb082db5d0266cfa8161 Mon Sep 17 00:00:00 2001 From: Meg McRoberts Date: Tue, 19 Dec 2023 02:21:36 -0800 Subject: [PATCH 12/23] move file to docs-new Signed-off-by: Meg McRoberts --- docs-new/docs/contribute/docs/spell-check.md | 76 ++++++++++++++++++++ mkdocs.yml | 1 + 2 files changed, 77 insertions(+) create mode 100644 docs-new/docs/contribute/docs/spell-check.md diff --git a/docs-new/docs/contribute/docs/spell-check.md b/docs-new/docs/contribute/docs/spell-check.md new file mode 100644 index 0000000000..159cd2129a --- /dev/null +++ b/docs-new/docs/contribute/docs/spell-check.md @@ -0,0 +1,76 @@ +# Spell checker + +All PRs that are pushed to a Keptn repository +are run through a spell checker that is based on the +[check-spelling](https://github.com/check-spelling/check-spelling) +GitHub action. + +Note, however, that you are still responsible for reading your text carefully. +The tool does not flag if you used a real word that is not the right word, +if you misuse "setup" versus "set up", and so forth. + +## Handling Spell Checker errors + +If you get a Spell Checker error: + +1. Right-click the `details` link for Spell Checker. +1. If you do not want to read through the whole (and rather verbose) log, + type `unrecognized words` in the search box at the top. +1. This shows the word(s) that caused Spell Checker to fail. + + - If these are genuine misspellings, + correct the spelling in your local branch + or using the github editor + and push the new commit to resolve the errors. + + - If a word that is flagged is a legitimate word, + follow the instructions in the report + to propose adding it to our dictionary. + This request will be added to your PR for review + and, if approved, will be merged when the PR is merged. + + - If your PR includes a file that should not be spell-checked, + you can add it to the + [excludes.txt](https://github.com/keptn/lifecycle-toolkit/blob/main/.github/actions/spelling/excludes.txt) file + as part of your PR. + It will be reviewed and, if approved, + merged as part of your PR. + +For more details about handling errors that are found, see the +[Check-spelling docs](https://docs.check-spelling.dev/). + +## Implementation details + +For full technical details about the spell checker, see: + +- [check-spelling documentation](https://docs.check-spelling.dev/) +- [check-spelling GitHub repository](https://github.com/check-spelling/check-spelling) + +The Keptn spell checker checks both documentation and code for spelling, +based on a set of dictionaries: + +- We use general English language and technical terminology + from dictionaries that are provided and maintained by check-spelling. + The configuration is specified in files in the + [.github/actions/spelling](https://github.com/keptn/lifecycle-toolkit/tree/main/.github/actions/spelling) + directory. + [expect.txt](https://github.com/keptn/lifecycle-toolkit/tree/main/.github/actions/spelling) + lists Keptn terms for both documentation and code. +- We also use the specialized technical dictionaries provided by check-spelling + for Kubernetes and Go. + The dictionaries we use are specified in the + [.github/workflows/spell-checker.yml](https://github.com/keptn/lifecycle-toolkit/blob/main/.github/workflows/spell-checker.yml) + file. + +Check-spelling supports both American and British spelling +and both are allowed in the Keptn documentation. + +Check-spelling provides dictionaries for a number of non-English languages +but we do not currently use those. + +Note that Check-spelling does not check for proper capitalization of terms. +All dictionary terms are listed with lowercase letters. +Check-spelling recognizes capitalized versions of these words but, +if capitalized words are listed in a dictionary, +check-spelling rejects non-capitalized forms +which are common in code. diff --git a/mkdocs.yml b/mkdocs.yml index 606e7c8560..936f20c5e0 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -165,6 +165,7 @@ nav: - Contribution guidelines for documentation: docs/contribute/docs/contrib-guidelines-docs.md - Build Documentation Locally: docs/contribute/docs/local-building.md - Linter Requirements: docs/contribute/docs/linter-requirements.md + - Spell Checker: docs/contribute/docs/spell-check.md - Source File Structure: docs/contribute/docs/source-file-structure.md - Published Doc Structure: docs/contribute/docs/publish.md - Word list: docs/contribute/docs/word-list.md From fc14889009324b3b003e6076d90cd125fcf5293a Mon Sep 17 00:00:00 2001 From: Meg McRoberts Date: Tue, 19 Dec 2023 03:28:34 -0800 Subject: [PATCH 13/23] Update docs-new/docs/contribute/docs/spell-check.md Signed-off-by: Meg McRoberts meg.mcroberts@dynatrace.com Co-authored-by: Moritz Wiesinger Signed-off-by: Meg McRoberts --- docs-new/docs/contribute/docs/spell-check.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs-new/docs/contribute/docs/spell-check.md b/docs-new/docs/contribute/docs/spell-check.md index 159cd2129a..f079ff087f 100644 --- a/docs-new/docs/contribute/docs/spell-check.md +++ b/docs-new/docs/contribute/docs/spell-check.md @@ -1,4 +1,4 @@ -# Spell checker +# Spell Checker All PRs that are pushed to a Keptn repository are run through a spell checker that is based on the From 66f8e9aebf6837f64b398337971cdfed9cad4f54 Mon Sep 17 00:00:00 2001 From: Meg McRoberts Date: Tue, 19 Dec 2023 03:29:02 -0800 Subject: [PATCH 14/23] Update docs-new/docs/contribute/docs/spell-check.md Signed-off-by: Meg McRoberts meg.mcroberts@dynatrace.com Co-authored-by: Moritz Wiesinger Signed-off-by: Meg McRoberts --- docs-new/docs/contribute/docs/spell-check.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs-new/docs/contribute/docs/spell-check.md b/docs-new/docs/contribute/docs/spell-check.md index f079ff087f..7d1f3c662b 100644 --- a/docs-new/docs/contribute/docs/spell-check.md +++ b/docs-new/docs/contribute/docs/spell-check.md @@ -20,7 +20,7 @@ If you get a Spell Checker error: - If these are genuine misspellings, correct the spelling in your local branch - or using the github editor + or using the GitHub editor and push the new commit to resolve the errors. - If a word that is flagged is a legitimate word, From 6546551d43c157350e26d20d800803b36a81c73f Mon Sep 17 00:00:00 2001 From: Meg McRoberts Date: Tue, 19 Dec 2023 03:29:28 -0800 Subject: [PATCH 15/23] Update docs-new/docs/contribute/docs/spell-check.md Signed-off-by: Meg McRoberts meg.mcroberts@dynatrace.com Co-authored-by: Moritz Wiesinger Signed-off-by: Meg McRoberts --- docs-new/docs/contribute/docs/spell-check.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs-new/docs/contribute/docs/spell-check.md b/docs-new/docs/contribute/docs/spell-check.md index 7d1f3c662b..c904791169 100644 --- a/docs-new/docs/contribute/docs/spell-check.md +++ b/docs-new/docs/contribute/docs/spell-check.md @@ -56,8 +56,8 @@ based on a set of dictionaries: directory. [expect.txt](https://github.com/keptn/lifecycle-toolkit/tree/main/.github/actions/spelling) lists Keptn terms for both documentation and code. -- We also use the specialized technical dictionaries provided by check-spelling - for Kubernetes and Go. +- We also use the specialized technical dictionaries provided by check-spelling specific domains + or programming languages such as Kubernetes, Go or HTML. The dictionaries we use are specified in the [.github/workflows/spell-checker.yml](https://github.com/keptn/lifecycle-toolkit/blob/main/.github/workflows/spell-checker.yml) file. From 893b3fe49ad614eab0205aaa3ef9798ff068781c Mon Sep 17 00:00:00 2001 From: Meg McRoberts Date: Tue, 19 Dec 2023 03:29:56 -0800 Subject: [PATCH 16/23] Update docs-new/docs/contribute/docs/spell-check.md Signed-off-by: Meg McRoberts meg.mcroberts@dynatrace.com Co-authored-by: Moritz Wiesinger Signed-off-by: Meg McRoberts --- docs-new/docs/contribute/docs/spell-check.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs-new/docs/contribute/docs/spell-check.md b/docs-new/docs/contribute/docs/spell-check.md index c904791169..aeac002655 100644 --- a/docs-new/docs/contribute/docs/spell-check.md +++ b/docs-new/docs/contribute/docs/spell-check.md @@ -25,7 +25,7 @@ If you get a Spell Checker error: - If a word that is flagged is a legitimate word, follow the instructions in the report - to propose adding it to our dictionary. + to propose adding it to our [dictionary](https://github.com/keptn/lifecycle-toolkit/blob/main/.github/actions/spelling/expect.txt). This request will be added to your PR for review and, if approved, will be merged when the PR is merged. From 7d9521f7b906dd771d5172fad6c0cfe92254d36d Mon Sep 17 00:00:00 2001 From: Meg McRoberts Date: Tue, 19 Dec 2023 06:28:13 -0800 Subject: [PATCH 17/23] spelling error for testing Signed-off-by: Meg McRoberts --- docs-new/docs/contribute/docs/spell-check.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs-new/docs/contribute/docs/spell-check.md b/docs-new/docs/contribute/docs/spell-check.md index aeac002655..f301c207d4 100644 --- a/docs-new/docs/contribute/docs/spell-check.md +++ b/docs-new/docs/contribute/docs/spell-check.md @@ -1,6 +1,6 @@ # Spell Checker -All PRs that are pushed to a Keptn repository +All PRs that are pushed to a Kept repository are run through a spell checker that is based on the [check-spelling](https://github.com/check-spelling/check-spelling) GitHub action. From 33941641580500b0d7e2143f6175cb69f768b45b Mon Sep 17 00:00:00 2001 From: Meg McRoberts Date: Tue, 19 Dec 2023 06:39:26 -0800 Subject: [PATCH 18/23] another spelling error for testing Signed-off-by: Meg McRoberts --- docs-new/docs/contribute/docs/spell-check.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs-new/docs/contribute/docs/spell-check.md b/docs-new/docs/contribute/docs/spell-check.md index f301c207d4..47200e86f2 100644 --- a/docs-new/docs/contribute/docs/spell-check.md +++ b/docs-new/docs/contribute/docs/spell-check.md @@ -1,6 +1,6 @@ # Spell Checker -All PRs that are pushed to a Kept repository +All PRs that are pushed to a Keptn reprository are run through a spell checker that is based on the [check-spelling](https://github.com/check-spelling/check-spelling) GitHub action. From 4a5eeaba09c7dc3b99f3ee9791771e35c00c4e18 Mon Sep 17 00:00:00 2001 From: Meg McRoberts Date: Tue, 19 Dec 2023 06:52:11 -0800 Subject: [PATCH 19/23] point to job summary for errors Signed-off-by: Meg McRoberts --- docs-new/docs/contribute/docs/spell-check.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/docs-new/docs/contribute/docs/spell-check.md b/docs-new/docs/contribute/docs/spell-check.md index 47200e86f2..97492626c7 100644 --- a/docs-new/docs/contribute/docs/spell-check.md +++ b/docs-new/docs/contribute/docs/spell-check.md @@ -1,6 +1,6 @@ # Spell Checker -All PRs that are pushed to a Keptn reprository +All PRs that are pushed to a Keptn repository are run through a spell checker that is based on the [check-spelling](https://github.com/check-spelling/check-spelling) GitHub action. @@ -13,9 +13,9 @@ if you misuse "setup" versus "set up", and so forth. If you get a Spell Checker error: -1. Right-click the `details` link for Spell Checker. -1. If you do not want to read through the whole (and rather verbose) log, - type `unrecognized words` in the search box at the top. +1. Right-click the `details` link for Spell Checker + in the CI results section of your PR. +1. Search for "job summary" and click the link to that report. 1. This shows the word(s) that caused Spell Checker to fail. - If these are genuine misspellings, From 7dcebbc35bf8ba7ee67ea419459a09c5c994e9c7 Mon Sep 17 00:00:00 2001 From: Meg McRoberts Date: Thu, 21 Dec 2023 02:33:13 -0800 Subject: [PATCH 20/23] Update docs-new/docs/contribute/docs/spell-check.md Signed-off-by: Meg McRoberts meg.mcroberts@dynatrace.com Co-authored-by: Moritz Wiesinger Signed-off-by: Meg McRoberts --- docs-new/docs/contribute/docs/spell-check.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs-new/docs/contribute/docs/spell-check.md b/docs-new/docs/contribute/docs/spell-check.md index 97492626c7..1f402ec9f6 100644 --- a/docs-new/docs/contribute/docs/spell-check.md +++ b/docs-new/docs/contribute/docs/spell-check.md @@ -14,8 +14,8 @@ if you misuse "setup" versus "set up", and so forth. If you get a Spell Checker error: 1. Right-click the `details` link for Spell Checker - in the CI results section of your PR. -1. Search for "job summary" and click the link to that report. + in the checks for your PR. +1. Click on the Summary to get to the job summary. 1. This shows the word(s) that caused Spell Checker to fail. - If these are genuine misspellings, From 1066918ecbf7ba590ae27f18e0d9ebf5b1fdaea5 Mon Sep 17 00:00:00 2001 From: Meg McRoberts Date: Thu, 21 Dec 2023 06:22:59 -0800 Subject: [PATCH 21/23] Update docs-new/docs/contribute/docs/spell-check.md Signed-off-by: Meg McRoberts meg.mcroberts@dynatrace.com Co-authored-by: Moritz Wiesinger Signed-off-by: Meg McRoberts --- docs-new/docs/contribute/docs/spell-check.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs-new/docs/contribute/docs/spell-check.md b/docs-new/docs/contribute/docs/spell-check.md index 1f402ec9f6..59109c6648 100644 --- a/docs-new/docs/contribute/docs/spell-check.md +++ b/docs-new/docs/contribute/docs/spell-check.md @@ -13,7 +13,7 @@ if you misuse "setup" versus "set up", and so forth. If you get a Spell Checker error: -1. Right-click the `details` link for Spell Checker +1. Click the `details` link for Spell Checker in the checks for your PR. 1. Click on the Summary to get to the job summary. 1. This shows the word(s) that caused Spell Checker to fail. From 5d51c06a7608ee30802232077dcc648510b6660e Mon Sep 17 00:00:00 2001 From: Meg McRoberts Date: Thu, 21 Dec 2023 07:19:50 -0800 Subject: [PATCH 22/23] remove ref to community/slack Signed-off-by: Meg McRoberts --- docs/CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/CONTRIBUTING.md b/docs/CONTRIBUTING.md index 1aca6bef1c..dcf31f8c9b 100644 --- a/docs/CONTRIBUTING.md +++ b/docs/CONTRIBUTING.md @@ -20,7 +20,7 @@ to check the rendered documentation and then push your changes to the repository as a pull request. If you need help getting started, -feel free to ask for help on the `#help-contributing` or `#keptn-docs` channels on the [Keptn Slack](https://keptn.sh/community/#slack). +feel free to ask for help. We were all new to this once and are happy to help you! ## Guidelines for Contributing From 66bdf70452cb46cb7de92e4f456ee8c699ae8eeb Mon Sep 17 00:00:00 2001 From: odubajDT <93584209+odubajDT@users.noreply.github.com> Date: Fri, 5 Jan 2024 10:39:55 +0100 Subject: [PATCH 23/23] Apply suggestions from code review Signed-off-by: odubajDT <93584209+odubajDT@users.noreply.github.com> --- docs-new/docs/contribute/docs/spell-check.md | 2 +- docs/content/en/contribute/docs/spell-check/_index.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/docs-new/docs/contribute/docs/spell-check.md b/docs-new/docs/contribute/docs/spell-check.md index 59109c6648..76240db00b 100644 --- a/docs-new/docs/contribute/docs/spell-check.md +++ b/docs-new/docs/contribute/docs/spell-check.md @@ -54,7 +54,7 @@ based on a set of dictionaries: The configuration is specified in files in the [.github/actions/spelling](https://github.com/keptn/lifecycle-toolkit/tree/main/.github/actions/spelling) directory. - [expect.txt](https://github.com/keptn/lifecycle-toolkit/tree/main/.github/actions/spelling) + [expect.txt](https://github.com/keptn/lifecycle-toolkit/tree/main/.github/actions/spelling/expect.txt) lists Keptn terms for both documentation and code. - We also use the specialized technical dictionaries provided by check-spelling specific domains or programming languages such as Kubernetes, Go or HTML. diff --git a/docs/content/en/contribute/docs/spell-check/_index.md b/docs/content/en/contribute/docs/spell-check/_index.md index 5d97de69eb..49a9b3e8ed 100644 --- a/docs/content/en/contribute/docs/spell-check/_index.md +++ b/docs/content/en/contribute/docs/spell-check/_index.md @@ -58,7 +58,7 @@ based on a set of dictionaries: The configuration is specified in files in the [.github/actions/spelling](https://github.com/keptn/lifecycle-toolkit/tree/main/.github/actions/spelling) directory. - [expect.txt](https://github.com/keptn/lifecycle-toolkit/tree/main/.github/actions/spelling) + [expect.txt](https://github.com/keptn/lifecycle-toolkit/tree/main/.github/actions/spelling/expect.txt) lists Keptn terms for both documentation and code. - We also use the specialized technical dictionaries provided by check-spelling for Kubernetes and Go.