Skip to content

Commit 8e0b611

Browse files
authored
docs: correcting typos(#4308)
1 parent f14e910 commit 8e0b611

File tree

9 files changed

+14
-14
lines changed

9 files changed

+14
-14
lines changed

docs/content/app-protect-waf/configuration.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -478,7 +478,7 @@ To access the application, curl the coffee and the tea services. We'll use the -
478478

479479
### Configuration Example of Virtual Server
480480

481-
Refer to github repo for [Virtual Server example](https://raw.githubusercontent.com/nginxinc/kubernetes-ingress/v3.2.1/examples/custom-resources/app-protect-waf/webapp.yaml).
481+
Refer to GitHub repo for [Virtual Server example](https://raw.githubusercontent.com/nginxinc/kubernetes-ingress/v3.2.1/examples/custom-resources/app-protect-waf/webapp.yaml).
482482

483483
```yaml
484484
apiVersion: k8s.nginx.org/v1

docs/content/configuration/policy-resource.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -143,7 +143,7 @@ When you reference more than one rate limit policy, NGINX Ingress Controller wil
143143

144144
### BasicAuth
145145

146-
The basic auth policy configures NGINX to authenticate cllient requests using the [HTTP Basic authentication scheme](https://developer.mozilla.org/en-US/docs/Web/HTTP/Authentication).
146+
The basic auth policy configures NGINX to authenticate client requests using the [HTTP Basic authentication scheme](https://developer.mozilla.org/en-US/docs/Web/HTTP/Authentication).
147147

148148
For example, the following policy will reject all requests that do not include a valid username/password combination in the HTTP header `Authentication`
149149

docs/content/installation/installation-with-helm.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -327,7 +327,7 @@ The following tables lists the configurable parameters of the NGINX Ingress Cont
327327
|`controller.extraContainers` | Extra (eg. sidecar) containers for the Ingress Controller pods. | [] |
328328
|`controller.resources` | The resources of the Ingress Controller pods. | requests: cpu=100m,memory=128Mi |
329329
|`controller.replicaCount` | The number of replicas of the Ingress Controller deployment. | 1 |
330-
|`controller.ingressClass` | A class of the Ingress Controller. An IngressClass resource with the name equal to the class must be deployed. Otherwise, the Ingress Controller will fail to start. The Ingress Controller only processes resources that belong to its class - i.e. have the "ingressClassName" field resource equal to the class. The Ingress Controller processes all the VirtualServer/VirtualServerRoute/TransportServer resources that do not have the "ingressClassName" field for all versions of kubernetes. | nginx |
330+
|`controller.ingressClass` | A class of the Ingress Controller. An IngressClass resource with the name equal to the class must be deployed. Otherwise, the Ingress Controller will fail to start. The Ingress Controller only processes resources that belong to its class - i.e. have the "ingressClassName" field resource equal to the class. The Ingress Controller processes all the VirtualServer/VirtualServerRoute/TransportServer resources that do not have the "ingressClassName" field for all versions of Kubernetes. | nginx |
331331
|`controller.setAsDefaultIngress` | New Ingresses without an `"ingressClassName"` field specified will be assigned the class specified in `controller.ingressClass`. | false |
332332
|`controller.watchNamespace` | Comma separated list of namespaces the Ingress Controller should watch for resources. By default the Ingress Controller watches all namespaces. Mutually exclusive with `controller.watchNamespaceLabel`. Please note that if configuring multiple namespaces using the Helm cli `--set` option, the string needs to wrapped in double quotes and the commas escaped using a backslash - e.g. `--set controller.watchNamespace="default\,nginx-ingress"`. | "" |
333333
|`controller.watchNamespaceLabel` | Configures the Ingress Controller to watch only those namespaces with label foo=bar. By default the Ingress Controller watches all namespaces. Mutually exclusive with `controller.watchNamespace`. | "" |

docs/content/installation/using-the-jwt-token-docker-secret.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -35,19 +35,19 @@ You will need the following information from [MyF5](https://my.f5.com) for these
3535
1. Choose your desired [NGINX Ingress Controller Image](https://docs.nginx.com/nginx-ingress-controller/technical-specifications/#images-with-nginx-plus).
3636
1. Log into the [MyF5 Portal](https://myf5.com/), navigate to your subscription details, and download the relevant .cert, .key and .JWT files.
3737
1. Create a Kubernetes secret using the JWT token. You should use `cat` to view the contents of the JWT token and store the output for use in later steps.
38-
1. Ensure there are no additional characters or extra whiespace that might have been accidently added. This will break authorization and prevent the NGINX Ingress Controller image from being downloaded.
38+
1. Ensure there are no additional characters or extra whitespace that might have been accidentally added. This will break authorization and prevent the NGINX Ingress Controller image from being downloaded.
3939
1. Modify your deployment (manifest or helm) to use the Kubernetes secret created in step three.
4040
1. Deploy NGINX Ingress Controller into your Kubernetes cluster and verify successful installation.
4141

4242
## Using the JWT token in a Docker Config Secret
4343

44-
1. Create a kubernetes `docker-registry` secret type on the cluster, using the JWT token as the username and `none` for password (Password is unused). The name of the docker server is `private-registry.nginx.com`.
44+
1. Create a Kubernetes `docker-registry` secret type on the cluster, using the JWT token as the username and `none` for password (Password is unused). The name of the docker server is `private-registry.nginx.com`.
4545

4646

4747
```shell
4848
kubectl create secret docker-registry regcred --docker-server=private-registry.nginx.com --docker-username=<JWT Token> --docker-password=none [-n nginx-ingress]
4949
```
50-
It is important that the `--docker-username=<JWT Token>` contains the contents of the token and is not pointing to the token itself. Ensure that when you copy the contents of the JWT token, there are no additional characters or extra whitepaces. This can invalidate the token and cause 401 errors when trying to authenticate to the registry.
50+
It is important that the `--docker-username=<JWT Token>` contains the contents of the token and is not pointing to the token itself. Ensure that when you copy the contents of the JWT token, there are no additional characters or extra whitespaces. This can invalidate the token and cause 401 errors when trying to authenticate to the registry.
5151

5252

5353
1. Confirm the details of the created secret by running:
@@ -86,7 +86,7 @@ If you are using `helm` for deployment, there are two main methods: using *sourc
8686

8787
### Helm Source
8888

89-
The [Helm installation page for NGINX Ingess Controller](https://docs.nginx.com/nginx-ingress-controller/installation/installation-with-helm/#managing-the-chart-via-sources) has a section describing how to use sources: these are the unique steps for Docker secrets using JWT tokens.
89+
The [Helm installation page for NGINX Ingress Controller](https://docs.nginx.com/nginx-ingress-controller/installation/installation-with-helm/#managing-the-chart-via-sources) has a section describing how to use sources: these are the unique steps for Docker secrets using JWT tokens.
9090

9191
1. Clone the NGINX [`kubernetes-ingress` repository](https://github.com/nginxinc/kubernetes-ingress).
9292
1. Navigate to the `deployments/helm-chart` folder of your local clone.
@@ -98,7 +98,7 @@ You must change a few lines NGINX Ingress Controller with NGINX Plus to be deplo
9898
1. Change the `repository` argument to the NGINX Ingress Controller image you intend to use.
9999
1. Add an argument to `imagePullSecretName` to allow Docker to pull the image from the private registry.
100100

101-
The following codeblock shows snippets of the parameters you will need to change, and an example of their contents:
101+
The following code block shows snippets of the parameters you will need to change, and an example of their contents:
102102

103103
```yaml
104104
## Deploys the Ingress Controller for NGINX Plus

docs/content/releases.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ FIXES:
4848
- [3798](https://github.com/nginxinc/kubernetes-ingress/pull/3798) Update VirtualServer template to generate an internal jwt auth location per policy applied.
4949
- [3844](https://github.com/nginxinc/kubernetes-ingress/pull/3844) Fix gunzip support for VS and add python tests.
5050
- [3870](https://github.com/nginxinc/kubernetes-ingress/pull/3870) Add Funcs() method to UpdateVirtualServerTemplate method. Thanks to [Bryan Hendryx](https://github.com/coolbry95).
51-
- [3933](https://github.com/nginxinc/kubernetes-ingress/pull/3933) fix --enternal-service flag when using serviceNameOverride. Thanks to [Tim N](https://github.com/timnee).
51+
- [3933](https://github.com/nginxinc/kubernetes-ingress/pull/3933) fix --external-service flag when using serviceNameOverride. Thanks to [Tim N](https://github.com/timnee).
5252

5353
CHANGES:
5454

@@ -368,7 +368,7 @@ FEATURES:
368368
- [2914](https://github.com/nginxinc/kubernetes-ingress/pull/2914) Support watching multiple namespaces.
369369
- [2884](https://github.com/nginxinc/kubernetes-ingress/pull/2884) Include year in logs.
370370
- [2993](https://github.com/nginxinc/kubernetes-ingress/pull/2993) Accept proxy protocol when TLS passthrough enabled.
371-
- [3041](https://github.com/nginxinc/kubernetes-ingress/pull/3041) Support external name service for TansportServer.
371+
- [3041](https://github.com/nginxinc/kubernetes-ingress/pull/3041) Support external name service for TransportServer.
372372
- [2939](https://github.com/nginxinc/kubernetes-ingress/pull/2939) Add support for wildcard hostname in VirtualServer.
373373

374374
IMPROVEMENTS:

docs/content/tutorials/ingress-path-regex-annotation.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ toc: true
99
## Customizing NGINX Ingress Controller with Path-Regex Annotations
1010

1111
We suggest reading the NGINX [documentation on resolve location priority](https://docs.nginx.com/nginx/admin-guide/web-server/web-server/#nginx-location-priority)
12-
to gain additional contenx about NGINX and NGINX Plus before using the ``path-regex`` annotation.
12+
to gain additional context about NGINX and NGINX Plus before using the ``path-regex`` annotation.
1313

1414
## Ingress Type
1515

docs/content/tutorials/nginx-ingress-istio.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ To begin, Istio needs to be installed into your cluster.
2727
## Install Istio
2828

2929
Link to Istio install guide:
30-
[Installing istio](https://istio.io/latest/docs/setup/install/)
30+
[Installing Istio](https://istio.io/latest/docs/setup/install/)
3131

3232
It is crucial to make sure you install Istio **BEFORE** installing NGINX Ingress Controller. This ensures that the Istio sidecar is injected correctly into the NGINX Ingress controller pod.
3333

docs/content/tutorials/nginx-ingress-osm.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -335,7 +335,7 @@ kubectl apply -f osm-nginx-client-cert.yaml
335335
336336
```
337337

338-
Ensure the secrets exisit in the `nginx-ingress` namespace:
338+
Ensure the secrets exist in the `nginx-ingress` namespace:
339339

340340
```console
341341
kubectl get secrets -n nginx-ingress

docs/content/tutorials/oidc-custom-configuration.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -61,7 +61,7 @@ oidc.conf:
6161
# Rest of configuration file truncated
6262
```
6363

64-
## Step 2 - Customising the default configuration
64+
## Step 2 - Customizing the default configuration
6565

6666
Once the contents of the `oidc.conf` file has been added to the ConfigMap, you are free to customize the contents of this ConfigMap.
6767
This example demonstrates adding a comment to the top of the file. The comment will be shown at the top of the `oidc.conf` file.

0 commit comments

Comments
 (0)