Skip to content

Commit 95f29a0

Browse files
authored
Capitalize Kubernetes objects (#200)
1 parent 5c608c3 commit 95f29a0

File tree

5 files changed

+15
-15
lines changed

5 files changed

+15
-15
lines changed

docs/installation.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -24,13 +24,13 @@ This guide walks you through how to install NGINX Kubernetes Gateway on a generi
2424
kubectl apply -k "github.com/kubernetes-sigs/gateway-api/config/crd?ref=v0.5.0"
2525
```
2626

27-
1. Create the nginx-gateway namespace:
27+
1. Create the nginx-gateway Namespace:
2828

2929
```
3030
kubectl apply -f deploy/manifests/namespace.yaml
3131
```
3232
33-
1. Create the njs-modules configmap:
33+
1. Create the njs-modules ConfigMap:
3434
3535
```
3636
kubectl create configmap njs-modules --from-file=internal/nginx/modules/src/httpmatches.js -n nginx-gateway
@@ -62,17 +62,17 @@ You can gain access to NGINX Kubernetes Gateway by creating a `NodePort` Service
6262
6363
### Create a NodePort Service
6464
65-
Create a service with type `NodePort`:
65+
Create a Service with type `NodePort`:
6666
6767
```
6868
kubectl apply -f deploy/manifests/service/nodeport.yaml
6969
```
7070
71-
A `NodePort` service will randomly allocate one port on every node of the cluster. To access NGINX Kubernetes Gateway, use an IP address of any node in the cluster along with the allocated port.
71+
A `NodePort` Service will randomly allocate one port on every Node of the cluster. To access NGINX Kubernetes Gateway, use an IP address of any Node in the cluster along with the allocated port.
7272
7373
### Create a LoadBalancer Service
7474
75-
Create a service with type `LoadBalancer` using the appropriate manifest for your cloud provider.
75+
Create a Service with type `LoadBalancer` using the appropriate manifest for your cloud provider.
7676
7777
- For GCP or Azure:
7878
@@ -108,4 +108,4 @@ Create a service with type `LoadBalancer` using the appropriate manifest for you
108108
109109
### Use NGINX Kubernetes Gateway
110110
111-
To get started, follow the tutorials in the [examples](../examples/) directory.
111+
To get started, follow the tutorials in the [examples](../examples) directory.

docs/running-on-kind.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,4 +30,4 @@ kubectl -n nginx-gateway port-forward <pod-name> 8080:80 8443:443
3030
> Note: NGINX will not listen on any ports until you configure a [Gateway](https://gateway-api.sigs.k8s.io/api-types/gateway/#gateway) resource with a valid listener.
3131
3232
## Use NGINX Kubernetes Gateway
33-
To get started, follow the tutorials in the [examples](../examples/) directory.
33+
To get started, follow the tutorials in the [examples](../examples) directory.

examples/advanced-routing/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
In this example we will deploy NGINX Kubernetes Gateway and configure advanced routing rules for a simple cafe application.
44
We will use `HTTPRoute` resources to route traffic to the cafe application based on a combination of the request method, headers, and query parameters.
55

6-
The cafe application consists of four services: `coffee-v1-svc`, `coffee-v2-svc`, `tea-svc`, and `tea-post-svc`. In the next section we will create the following routing rules for the cafe application:
6+
The cafe application consists of four Services: `coffee-v1-svc`, `coffee-v2-svc`, `tea-svc`, and `tea-post-svc`. In the next section we will create the following routing rules for the cafe application:
77
- For the path `/coffee` route requests with the header `version` set to `v2` or with the query param `TEST` set to `v2` to `coffee-v2-svc`, and all other requests to `coffee-v1-svc`.
88
- For the path `/tea` route POST requests to `tea-post-svc`, and all other requests, such as `GET` requests, to `tea-svc`.
99

@@ -27,7 +27,7 @@ The cafe application consists of four services: `coffee-v1-svc`, `coffee-v2-svc`
2727

2828
## 2. Deploy the Cafe Application
2929

30-
1. Create the coffee and the tea deployments and services:
30+
1. Create the coffee and the tea Deployments and Services:
3131

3232
```
3333
kubectl apply -f cafe.yaml

examples/cafe-example/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ In this example we deploy NGINX Kubernetes Gateway, a simple web application, an
2222

2323
## 2. Deploy the Cafe Application
2424

25-
1. Create the coffee and the tea deployments and services:
25+
1. Create the coffee and the tea Deployments and Services:
2626

2727
```
2828
kubectl apply -f cafe.yaml
@@ -53,7 +53,7 @@ In this example we deploy NGINX Kubernetes Gateway, a simple web application, an
5353

5454
## 4. Test the Application
5555

56-
To access the application, we will use `curl` to send requests to the `coffee` and `tea` services.
56+
To access the application, we will use `curl` to send requests to the `coffee` and `tea` Services.
5757

5858
To get coffee:
5959

examples/https-termination/README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ In this example we expand on the simple [cafe-example](../cafe-example) by addin
2222

2323
## 2. Deploy the Cafe Application
2424

25-
1. Create the coffee and the tea deployments and services:
25+
1. Create the coffee and the tea Deployments and Services:
2626

2727
```
2828
kubectl apply -f cafe.yaml
@@ -39,12 +39,12 @@ In this example we expand on the simple [cafe-example](../cafe-example) by addin
3939

4040
## 3. Configure HTTPS Termination and Routing
4141

42-
1. Create a secret with a TLS certificate and key:
42+
1. Create a Secret with a TLS certificate and key:
4343
```
4444
kubectl apply -f cafe-secret.yaml
4545
```
4646

47-
The TLS certificate and key in this secret are used to terminate the TLS connections for the cafe application.
47+
The TLS certificate and key in this Secret are used to terminate the TLS connections for the cafe application.
4848
**Important**: This certificate and key are for demo purposes only.
4949

5050
1. Create the `Gateway` resource:
@@ -70,7 +70,7 @@ In this example we expand on the simple [cafe-example](../cafe-example) by addin
7070
7171
## 4. Test the Application
7272
73-
To access the application, we will use `curl` to send requests to the `coffee` and `tea` services.
73+
To access the application, we will use `curl` to send requests to the `coffee` and `tea` Services.
7474
Since our certificate is self-signed, we'll use curl's `--insecure` option to turn off certificate verification.
7575

7676
To get coffee:

0 commit comments

Comments
 (0)