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.

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

Fix spelling for "WireGuard" #26764

Merged
merged 2 commits into from Jul 12, 2023
Merged

Conversation

qmonnet
Copy link
Member

@qmonnet qmonnet commented Jul 11, 2023

Late follow-up to #16293.

We had a custom filter for the spell checker in the docs, to ensure we'd never write "Wireguard" again. It's been broken since we added "wireguard" (considered case-insensitive) to the list of exceptions for the spell checker.

Let's fix this, and let's clean up the occurrences of "Wireguard" or "wireguard" where relevant in docs, comments, output strings that are not API.

@qmonnet qmonnet added area/documentation Impacts the documentation, including textual changes, sphinx, or other doc generation code. release-note/misc This PR makes changes that have no direct user impact. dont-merge/blocked Another PR must be merged before this one. labels Jul 11, 2023
@qmonnet qmonnet requested a review from gandro July 12, 2023 09:54
@qmonnet qmonnet marked this pull request as ready for review July 12, 2023 09:54
@qmonnet qmonnet requested review from a team as code owners July 12, 2023 09:54
@qmonnet
Copy link
Member Author

qmonnet commented Jul 12, 2023

/test

@qmonnet qmonnet removed the dont-merge/blocked Another PR must be merged before this one. label Jul 12, 2023
Let's fix the spelling ("WireGuard", and not with a different case)
where we can, in docs, comments or output strings that are not API.

Signed-off-by: Quentin Monnet <quentin@isovalent.com>
"WireGuard" should be spelt "WireGuard", not "wireguard" or "Wireguard".
We have a custom extension in the docs to ensure we never have the
latter, for example. But it's been broken for a while, because we also
added the lowercase "wireguard" entry to the list of spelling
exceptions, making it case-insensitive in the eyes of the spell-checker.
We need to remove this entry.

Fixes: 19cd3f3 ("helm: Add `encryption.wireguard.userspaceFallback` value")
Signed-off-by: Quentin Monnet <quentin@isovalent.com>
@qmonnet
Copy link
Member Author

qmonnet commented Jul 12, 2023

I forgot to update the cmd-ref

/test

Copy link
Member

@gandro gandro left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks!

@maintainer-s-little-helper maintainer-s-little-helper bot added the ready-to-merge This PR has passed all tests and received consensus from code owners to merge. label Jul 12, 2023
@nathanjsweet nathanjsweet merged commit 2b90e7f into cilium:main Jul 12, 2023
65 checks passed
@qmonnet qmonnet deleted the pr/fix-wg-spelling branch July 12, 2023 16:44
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/documentation Impacts the documentation, including textual changes, sphinx, or other doc generation code. ready-to-merge This PR has passed all tests and received consensus from code owners to merge. release-note/misc This PR makes changes that have no direct user impact.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

6 participants