From 2b499d9c860d7965ad495d4d332477155659432d Mon Sep 17 00:00:00 2001 From: Jedidiah Park <6612147+kjpark@users.noreply.github.com> Date: Mon, 6 Dec 2021 08:46:33 -0500 Subject: [PATCH] Fix spelling in documentation and top-level files (#8009) * fix typos in docs * fix typos in top-level files --- CONTRIBUTING.md | 2 +- RELEASE.md | 4 ++-- docs/developer-guide/code-overview.md | 2 +- docs/developer-guide/getting-started.md | 2 +- docs/user-guide/monitoring.md | 2 +- docs/user-guide/nginx-configuration/annotations.md | 2 +- docs/user-guide/nginx-configuration/configmap.md | 2 +- 7 files changed, 8 insertions(+), 8 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 170396aaa..e73f49fcd 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -36,7 +36,7 @@ All changes must be code reviewed. Coding conventions and standards are explaine Ingress Nginx collaborators may add "/lgtm" (Looks Good To Me) to indicate that a PR is acceptable. Any change requires at least one LGTM. No pull requests can be merged until at least one Ingress Nginx collaborator signs off with an LGTM. Adding the "/lgtm" comment result in the prow bot adding the `lgtm` label. Note that a pull request still needs an `approve` label from one of the owners. -Reviewers or members who want to become reviewers according to the [k8s membership ladder](https://github.com/kubernetes/community/blob/master/community-membership.md), coud actively search for [pull requests that need a review](https://github.com/kubernetes/ingress-nginx/pulls?q=is%3Aopen+is%3Apr+label%3Atriage%2Faccepted). +Reviewers or members who want to become reviewers according to the [k8s membership ladder](https://github.com/kubernetes/community/blob/master/community-membership.md), could actively search for [pull requests that need a review](https://github.com/kubernetes/ingress-nginx/pulls?q=is%3Aopen+is%3Apr+label%3Atriage%2Faccepted). ## Support Channels diff --git a/RELEASE.md b/RELEASE.md index cf3dfc1c7..32c64d0dd 100644 --- a/RELEASE.md +++ b/RELEASE.md @@ -22,7 +22,7 @@ ### d. Merge -- Merging will fire cloudbuild, which will result in images beeing promoted to the [staging container registry](https://console.cloud.google.com/gcr/images/k8s-staging-ingress-nginx). +- Merging will fire cloudbuild, which will result in images being promoted to the [staging container registry](https://console.cloud.google.com/gcr/images/k8s-staging-ingress-nginx). ### e. Make sure cloudbuild is a success @@ -68,7 +68,7 @@ ### d. Merge -- Merging will fire cloudbuild, which will result in images beeing promoted to the [staging container registry](https://console.cloud.google.com/gcr/images/k8s-staging-ingress-nginx). +- Merging will fire cloudbuild, which will result in images being promoted to the [staging container registry](https://console.cloud.google.com/gcr/images/k8s-staging-ingress-nginx). ### e. Make sure cloudbuild is a success diff --git a/docs/developer-guide/code-overview.md b/docs/developer-guide/code-overview.md index b5d22e068..6f4beb9c9 100644 --- a/docs/developer-guide/code-overview.md +++ b/docs/developer-guide/code-overview.md @@ -103,7 +103,7 @@ Describe here `kubectl plugin`, `dbg`, `waitshutdown` and cover the hack scripts ## Deploy files -This directory contains the `yaml` deploy files used as examples or references in the docs to deploy Ingress NGINX and other componentes. +This directory contains the `yaml` deploy files used as examples or references in the docs to deploy Ingress NGINX and other components. Those files are in [deploy](https://github.com/kubernetes/ingress-nginx/tree/main/deploy) directory. diff --git a/docs/developer-guide/getting-started.md b/docs/developer-guide/getting-started.md index d63f6e6e8..8d500f147 100644 --- a/docs/developer-guide/getting-started.md +++ b/docs/developer-guide/getting-started.md @@ -29,7 +29,7 @@ Start a local Kubernetes cluster using [kind](https://kind.sigs.k8s.io/), build ```console make dev-env ``` -- If you are working on the v1.x.x version of this controler, and you want to create a cluster with kubernetes version 1.22, then please visit the [documentation for kind](https://kind.sigs.k8s.io/docs/user/configuration/#a-note-on-cli-parameters-and-configuration-files), and look for how to set a custom image for the kind node (image: kindest/node...), in the kind config file. +- If you are working on the v1.x.x version of this controller, and you want to create a cluster with kubernetes version 1.22, then please visit the [documentation for kind](https://kind.sigs.k8s.io/docs/user/configuration/#a-note-on-cli-parameters-and-configuration-files), and look for how to set a custom image for the kind node (image: kindest/node...), in the kind config file. ### Testing diff --git a/docs/user-guide/monitoring.md b/docs/user-guide/monitoring.md index 1c454827e..05d6a3f87 100644 --- a/docs/user-guide/monitoring.md +++ b/docs/user-guide/monitoring.md @@ -166,5 +166,5 @@ According to the above example, this URL will be http://10.192.0.3:31086 - This will open the currently deployed service grafana in the default editor configured in your shell (vi/nvim/nano/other) - scroll down to line 34 that looks like "type: NodePort" - change it to look like "type: ClusterIP". Save and exit. - - create a ingress reource with backend as "grafana" and port as "3000" + - create a ingress resource with backend as "grafana" and port as "3000" - Similarly, you can edit the service "prometheus-server" and add a ingress resource. diff --git a/docs/user-guide/nginx-configuration/annotations.md b/docs/user-guide/nginx-configuration/annotations.md index 721e17c32..481356936 100755 --- a/docs/user-guide/nginx-configuration/annotations.md +++ b/docs/user-guide/nginx-configuration/annotations.md @@ -775,7 +775,7 @@ nginx.ingress.kubernetes.io/enable-opentracing: "true" ### Opentracing Trust Incoming Span The option to trust incoming trace spans can be enabled or disabled globally through the ConfigMap but this will -sometimes need to be overriden to enable it or disable it for a specific ingress (e.g. only enable on a private endpoint) +sometimes need to be overridden to enable it or disable it for a specific ingress (e.g. only enable on a private endpoint) ```yaml nginx.ingress.kubernetes.io/opentracing-trust-incoming-span: "true" diff --git a/docs/user-guide/nginx-configuration/configmap.md b/docs/user-guide/nginx-configuration/configmap.md index f048d4bcd..b217eee49 100755 --- a/docs/user-guide/nginx-configuration/configmap.md +++ b/docs/user-guide/nginx-configuration/configmap.md @@ -1267,7 +1267,7 @@ _**default:**_ "false" ## ssl-reject-handshake -Set to reject SSL handshake to an unknown virtualhost. This paramter helps to mitigate the fingerprinting using default certificate of ingress. +Set to reject SSL handshake to an unknown virtualhost. This parameter helps to mitigate the fingerprinting using default certificate of ingress. _**default:**_ "false" _References:_