docs: fix docs following #17526 #17570
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
nbusseneau
added
area/documentation
qmonnet
requested changes
Oct 11, 2021
Documentation/spelling_wordlist.txt
Outdated
| @@ -618,6 +620,7 @@ nat | |||
| natMax | |||
| natively | |||
| neighMax | |||
| neighbour | |||
There was a problem hiding this comment.
We have more occurrences of neighbor (US spelling) overall in the repo. Would you mind updating the description of the related option instead, to be more consistent and to avoid adding the British spelling to this list, please?
It seems we forgot to update `helm-values.rst` in cilium#17526, yielding issues when building documentation locally with `make render-docs`: ``` Please fix the following spelling mistakes: * Documentation/helm-reference.rst:876: (NeighDiscovery) * Documentation/helm-reference.rst:876: (arping) * Documentation/helm-reference.rst:877: (arping) * Documentation/helm-reference.rst:880: (NeighDiscovery) * Documentation/helm-reference.rst:881: (neighbour) * Documentation/helm-values.rst:876: (NeighDiscovery) * Documentation/helm-values.rst:876: (arping) * Documentation/helm-values.rst:877: (arping) * Documentation/helm-values.rst:880: (NeighDiscovery) * Documentation/helm-values.rst:881: (neighbour) If the words are not misspelled, run: Documentation/update-spelling_wordlist.sh NeighDiscovery arping neighbour ``` Since we already have more occurrences of `neighbor` (US spelling) in the repo, we replace `neighbour` with `neighbour` for consistency and then fix `helm-values.rst` + spelling wordlist. Signed-off-by: Nicolas Busseneau <nicolas@isovalent.com>
nbusseneau
force-pushed
the
pr/fix-docs
branch
from
18aa0b1
to
4b9b9a1
Compare
kaworu
approved these changes
Oct 12, 2021
|
This does not need to run any CI (docs only changes), and relevant reviews are in (other automated reviews are due to a typo fix, can be ignored). Marking as ready to merge. |
nbusseneau
added
the
ready-to-merge
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 seems we forgot to update
helm-values.rstin #17526, yielding issues when building documentation locally withmake render-docs:Since we already have more occurrences of
neighbor(US spelling) in the repo, we replaceneighbourwithneighborfor consistency and then fixhelm-values.rst+ spelling wordlist.