Skip to content

Commit

Permalink
docs: fix docs following #17526
Browse files Browse the repository at this point in the history
It seems we forgot to update `helm-values.rst` in #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>
  • Loading branch information
nbusseneau committed Oct 11, 2021
1 parent 6a722d3 commit 4b9b9a1
Show file tree
Hide file tree
Showing 4 changed files with 12 additions and 2 deletions.
8 changes: 8 additions & 0 deletions Documentation/helm-values.rst

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 2 additions & 0 deletions Documentation/spelling_wordlist.txt
Expand Up @@ -94,6 +94,7 @@ Minikube
Monnet
Mythbusters
NativeRoutingCIDR
NeighDiscovery
Netronome
NewProto
Nic
Expand Down Expand Up @@ -154,6 +155,7 @@ app
apps
archs
arithmetics
arping
artii
asm
assignees
Expand Down
2 changes: 1 addition & 1 deletion install/kubernetes/cilium/README.md
Expand Up @@ -270,7 +270,7 @@ contributors across the globe, there is almost always someone available to help.
| keepDeprecatedProbes | bool | `false` | Keep the deprecated probes when deploying Cilium DaemonSet |
| kubeProxyReplacementHealthzBindAddr | string | `""` | healthz server bind address for the kube-proxy replacement. To enable set the value to '0.0.0.0:10256' for all ipv4 addresses and this '[::]:10256' for all ipv6 addresses. By default it is disabled. |
| l2NeighDiscovery.arping-refresh-period | string | `"5m"` | Set period for arping |
| l2NeighDiscovery.enabled | bool | `true` | Enable L2 neighbour discovery in the agent |
| l2NeighDiscovery.enabled | bool | `true` | Enable L2 neighbor discovery in the agent |
| l7Proxy | bool | `true` | Enable Layer 7 network policy. |
| livenessProbe.failureThreshold | int | `10` | failure threshold of liveness probe |
| livenessProbe.periodSeconds | int | `30` | interval between checks of the liveness probe |
Expand Down
2 changes: 1 addition & 1 deletion install/kubernetes/cilium/values.yaml
Expand Up @@ -969,7 +969,7 @@ readinessProbe:
kubeProxyReplacementHealthzBindAddr: ""

l2NeighDiscovery:
# -- Enable L2 neighbour discovery in the agent
# -- Enable L2 neighbor discovery in the agent
enabled: true
# -- Set period for arping
arping-refresh-period: "5m"
Expand Down

0 comments on commit 4b9b9a1

Please sign in to comment.