docs: Ignore Helm values, update spelling list #26759
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Updating the list of exceptions for spellchecking each time we add a Helm value is painfull, and hardly useful at all. It's trivial to mark these strings as ignored to the spell-checker when building the reference, so let's just do that. Signed-off-by: Quentin Monnet <quentin@isovalent.com>
qmonnet
added
area/documentation
We have accumulated a number of words in the spelling list over time,
and some of them are no longer necessary (especially now that we ignore
Helm value names from the Helm reference). Let's trim down the list.
The following process was applied:
1. Empty the list of spelling exceptions
2. Run 'make html' to get the command to add missing words
(update-spelling_wordlist.sh)
3. Run that command to add all words
4. Remove all entries starting with an upper case from the list, as
some of them are unnecessary given that they have a corresponding
lowercase entry (which is case-insensitive)
5. Re-run 'make html' to get the command to add the exceptions that
are still missing
6. Run that command
7. Manually edit the file to make sure we don't change/add existing
entries (no Git addition)
8. Re-add names of contributors that are recognised locally, but
that CI fails to recognise because it doesn't have the Git
history
Signed-off-by: Quentin Monnet <quentin@isovalent.com>
qmonnet
force-pushed
the
pr/fix-spelling-list
branch
from
9f27216
to
4d67416
Compare
This was referenced Jul 11, 2023
lambdanis
approved these changes
Jul 11, 2023
qmonnet
added
the
ready-to-merge
jibi
added
needs-backport/1.12
needs-backport/1.13
aanm
added
backport-pending/1.14
maintainer-s-little-helper
bot
moved this from Needs backport from main
to Backport pending to v1.14
in 1.14.0
gandro
added
backport-done/1.14
maintainer-s-little-helper
bot
moved this from Backport pending to v1.14
to Backport done to v1.14
in 1.14.0
This should be addressed by the change in this PR on Documentation/check-build.sh. Unless the rstcheck version in 1.13 is too old? I'll look into it and backport. |
7 tasks
qmonnet
added
backport-pending/1.13
maintainer-s-little-helper
bot
moved this from Needs backport from main
to Backport pending to v1.13
in 1.13.5
maintainer-s-little-helper
bot
moved this from Needs backport from main
to Backport pending to v1.13
in 1.13.5
11 tasks
maintainer-s-little-helper
bot
moved this from Needs backport from main
to Backport pending to v1.12
in 1.12.12
qmonnet
added
backport-done/1.12
maintainer-s-little-helper
bot
moved this from Backport pending to v1.12
to Backport done to v1.12
in 1.12.12
aanm
added
needs-backport/1.13
maintainer-s-little-helper
bot
moved this from Backport pending to v1.13
to Needs backport from main
in 1.13.5
aanm
added
backport-pending/1.13
qmonnet
added
backport-done/1.13
|
Turns out this was more complex than I thought; but backports to 1.12, 1.13, 1.14 are now all done. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
It's a pain for developers to have to update the spelling list each time they add a new Helm value. Let's ignore these when running the spell-checker. Then we can also update (trim down) the list of exceptions.