diff --git a/Makefile b/Makefile index 42cac6338..094d1be03 100644 --- a/Makefile +++ b/Makefile @@ -244,3 +244,11 @@ live-docs: build-docs: @docker build --pull -t ingress-nginx/mkdocs build/mkdocs @docker run --rm -it -v ${PWD}:/docs ingress-nginx/mkdocs build + +.PHONY: misspell +misspell: + @go get github.com/client9/misspell/cmd/misspell + misspell \ + -locale US \ + -error \ + cmd/* internal/* deploy/* docs/* design/* test/* README.md diff --git a/docs/user-guide/nginx-configuration/annotations.md b/docs/user-guide/nginx-configuration/annotations.md index 75e96b760..24549f286 100644 --- a/docs/user-guide/nginx-configuration/annotations.md +++ b/docs/user-guide/nginx-configuration/annotations.md @@ -370,7 +370,7 @@ This annotation allows to return a permanent redirect instead of sending data to ### Permanent Redirect Code -This annotation allows you to modify the status code used for permanent redirects. For example `nginx.ingress.kubernetes.io/permanent-redirect-code: '308'` would return your permanet-redirect with a 308. +This annotation allows you to modify the status code used for permanent redirects. For example `nginx.ingress.kubernetes.io/permanent-redirect-code: '308'` would return your permanent-redirect with a 308. ### SSL Passthrough diff --git a/docs/user-guide/nginx-configuration/configmap.md b/docs/user-guide/nginx-configuration/configmap.md index d592f594a..979031c9a 100644 --- a/docs/user-guide/nginx-configuration/configmap.md +++ b/docs/user-guide/nginx-configuration/configmap.md @@ -471,7 +471,7 @@ Enables or disables the [PROXY protocol](https://www.nginx.com/resources/admin-g ## proxy-protocol-header-timeout -Sets the timeout value for receiving the proxy-protocol headers. The default of 5 seconds prevents the TLS passthrough handler from waiting indefinetly on a dropped connection. +Sets the timeout value for receiving the proxy-protocol headers. The default of 5 seconds prevents the TLS passthrough handler from waiting indefinitely on a dropped connection. _**default:**_ 5s ## use-gzip diff --git a/docs/user-guide/third-party-addons/modsecurity.md b/docs/user-guide/third-party-addons/modsecurity.md index 608dbca32..25265d96a 100644 --- a/docs/user-guide/third-party-addons/modsecurity.md +++ b/docs/user-guide/third-party-addons/modsecurity.md @@ -7,7 +7,7 @@ The [ModSecurity-nginx](https://github.com/SpiderLabs/ModSecurity-nginx) connect The default ModSecurity configuration file is located in `/etc/nginx/modsecurity/modsecurity.conf`. This is the only file located in this directory and contains the default recommended configuration. Using a volume we can replace this file with the desired configuration. To enable the ModSecurity feature we need to specify `enable-modsecurity: "true"` in the configuration configmap. ->__Note:__ the default configuration use detection only, because that minimises the chances of post-installation disruption. +>__Note:__ the default configuration use detection only, because that minimizes the chances of post-installation disruption. The file `/var/log/modsec_audit.log` contains the log of ModSecurity. diff --git a/internal/ingress/controller/store/store.go b/internal/ingress/controller/store/store.go index a0a6a6fac..e92fc3536 100644 --- a/internal/ingress/controller/store/store.go +++ b/internal/ingress/controller/store/store.go @@ -244,7 +244,7 @@ func New(checkOCSP bool, Component: "nginx-ingress-controller", }) - // k8sStore fulfils resolver.Resolver interface + // k8sStore fulfills resolver.Resolver interface store.annotations = annotations.NewAnnotationExtractor(store) store.listers.IngressAnnotation.Store = cache.NewStore(cache.DeletionHandlingMetaNamespaceKeyFunc)