docs: add custom spelling filter to check WireGuard spelling #16513
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
In the documentation, WireGuard should always be spelt with capital W and G. We also have a lowercase version coming from the documentation for Helm value, where "wireguard" is a value that one can pass to a dedicated option to select the encryption mode. How to enforce correct spell checks for WireGuard, to avoid to introduce occurrences with erroneous capitalisation? - If the spelling list contains "wireguard" or "Wireguard", the check will be case-insensitive and "Wireguard" will not trigger an error (false negatives). - If the spelling list contains "WireGuard" only, then the Helm value will trigger an error (false positive). We want to allow both "WireGuard" and "wireguard". This cannot be done via the spelling list, but can be implemented as a custom filter for Sphinx's spelling extension, in order to skip either of those spellings. Let's create this filter to make sure we capitalise the term correctly in the future. Signed-off-by: Quentin Monnet <quentin@isovalent.com>
qmonnet
added
area/documentation
joestringer
approved these changes
Jun 11, 2021
bmcustodio
approved these changes
Jun 14, 2021
qmonnet
added
the
ready-to-merge
qmonnet
added a commit
to qmonnet/cilium
that referenced
this pull request
Jul 5, 2021
We recently added a custom filter for spell checking, in order to have better control on the case for some specific terms. This custom filter is written as a Python function in a dedicated file, and it turns out that this file is pre-compiled when building the documentation. Let's add the relevant __pycache__ directory to the .gitignore in the documentation directory. Fixes: 8710477 ("docs: add custom spelling filter to check WireGuard spelling") Fixes: cilium#16513 Signed-off-by: Quentin Monnet <quentin@isovalent.com>
joestringer
pushed a commit
that referenced
this pull request
Jul 7, 2021
We recently added a custom filter for spell checking, in order to have better control on the case for some specific terms. This custom filter is written as a Python function in a dedicated file, and it turns out that this file is pre-compiled when building the documentation. Let's add the relevant __pycache__ directory to the .gitignore in the documentation directory. Fixes: 8710477 ("docs: add custom spelling filter to check WireGuard spelling") Fixes: #16513 Signed-off-by: Quentin Monnet <quentin@isovalent.com>
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.
In the documentation, WireGuard should always be spelt with capital
WandG. We also have a lowercase version coming from the documentation for Helm value, wherewireguardis a value that one can pass to a dedicated option to select the encryption mode.How to enforce correct spell checks for WireGuard, to avoid to introduce occurrences with erroneous capitalisation?
If the spelling list contains
wireguardorWireguard, the check will be case-insensitive andWireguardwill not trigger an error (false negatives).If the spelling list contains
WireGuardonly, then the Helm value will trigger an error (false positive).We want to allow both
WireGuardandwireguard. This cannot be done via the spelling list, but can be implemented as a custom filter for Sphinx's spelling extension, in order to skip either of those spellings. Let's create this filter to make sure we capitalise the term correctly in the future.