More suggestions

Author: sjberman

README.md

@@ -68,7 +68,7 @@ The SBOM for the Docker image is available in the [GitHub Container](https://git
 
 For example to retrieve the SBOM for `linux/amd64` and analyze it using [grype](https://github.com/anchore/grype) you can run the following command:
 ```shell
-$ docker buildx imagetools inspect ghcr.io/nginxinc/nginx-kubernetes-gateway:edge --format '{{ json (index .SBOM "linux/amd64").SPDX }}' | grype
+docker buildx imagetools inspect ghcr.io/nginxinc/nginx-kubernetes-gateway:edge --format '{{ json (index .SBOM "linux/amd64").SPDX }}' | grype
 ```
 
 ## Contacts

conformance/README.md

@@ -52,17 +52,17 @@ update-nkg-manifest            Update the NKG deployment manifest image name and
 
 ### Step 1 - Create a kind Cluster
 
-```shell
+```makefile
 make create-kind-cluster
 ```
 ### Step 2 - Install Nginx Kubernetes Gateway to configured kind cluster
 
 #### *Option 1* Build and install Nginx Kubernetes Gateway from local to configured kind cluster
-```shell
+```makefile
 make install-nkg-local-build
 ```
 #### *Option 2* Install Nginx Kubernetes Gateway from local already built image to configured kind cluster
-```shell
+```makefile
 make install-nkg-local-no-build
 ```
 **Note:** You can optionally skip the actual *build* step. However, if choosing 
@@ -82,36 +82,36 @@ this option, the following step *must* be completed manually *before* the build
 #### *Option 3* Install Nginx Kubernetes Gateway from edge to configured kind cluster
 You can also skip the build NKG image step and prepare the environment to instead use the `edge` image
 
-```shell
+```makefile
 make install-nkg-edge
 ```
 
 ### Step 3 - Build conformance test runner image
-```shell
+```makefile
 make build-test-runner-image
 ```
 
 ### Step 4 - Run Gateway conformance tests
-```shell
+```makefile
 make run-conformance-tests
 ```
 
 ### Step 5 - Cleanup the conformance test fixtures and uninstall Nginx Kubernetes Gateway
-```shell
+```makefile
 make cleanup-conformance-tests
 ```
-```shell
+```makefile
 make uninstall-nkg
 ```
 
 ### Step 6 - Revert changes to the NKG deployment manifest
 **Optional** Not required if using `edge` image
 **Warning**: `make undo-image-update` will hard reset changes to the deploy/manifests/deployment.yaml file!
-```shell
+```makefile
 make undo-image-update
 ```
 
 ### Step 7 - Delete kind cluster
-```shell
+```makefile
 make delete-kind-cluster
 ```

conformance/provisioner/README.md

@@ -35,7 +35,7 @@ How to deploy:
    ```shell
    kubectl get pods -n nginx-gateway 
    ```
-   ```
+   ```console
    NAME                                         READY   STATUS    RESTARTS   AGE
    nginx-gateway-provisioner-6c9d9fdcb8-b2pf8   1/1     Running   0          11m
    ```

docs/building-the-image.md

@@ -13,14 +13,12 @@ Before you can build the NGINX Kubernetes Gateway, make sure you have the follow
 
    ```shell
    git clone https://github.com/nginxinc/nginx-kubernetes-gateway.git
-   ```
-   ```shell
    cd nginx-kubernetes-gateway
    ```
 
 1. Build the image:
 
-   ```shell
+   ```makefile
    make PREFIX=myregistry.example.com/nginx-kubernetes-gateway container
    ```
 

docs/developer/quickstart.md

@@ -26,11 +26,9 @@ Follow these steps to set up your development environment.
 
    ```shell
    git clone https://github.com/<YOUR-USERNAME>/nginx-kubernetes-gateway.git
-   ```
-   ```shell
    cd nginx-kubernetes-gateway
    ```
-   ```shell
+   ```makefile
    make deps
    ```
 
@@ -40,7 +38,7 @@ Follow these steps to set up your development environment.
 
 To build the binary, run the make build command from the project's root directory:
 
-```shell
+```makefile
 make build
 ```
 
@@ -50,7 +48,7 @@ This command will build the binary and output it to the `/build/.out` directory.
 
 To build an NGINX Kubernetes Gateway container image from source run the following make command:
 
-```shell
+```makefile
 make TAG=$(whoami) container
 ```
 
@@ -60,7 +58,7 @@ This will build the docker image `nginx-kubernetes-gateway:<your-user>`.
 
 1. Create a `kind` cluster:
 
-   ```shell
+   ```makefile
    make create-kind-cluster
    ```
 
@@ -91,7 +89,7 @@ To make sure NKG is running properly, try out the [examples](/examples).
 
 To run all the unit tests, run the make unit-test command from the project's root directory:
 
-```shell
+```makefile
 make unit-test
 ```
 
@@ -105,7 +103,7 @@ To run Gateway API conformance tests, please follow the instructions on [this](/
 
 To lint the code, run the following make command from the project's root directory:
 
-```shell
+```makefile
 make lint
 ```
 

docs/developer/testing.md

@@ -44,7 +44,7 @@ promoting efficient refactoring and continuous development.
 
 To run the unit tests, run the make unit-test command from the project's root directory:
 
-```shell
+```makefile
 make unit-test
 ```
 

docs/installation.md

@@ -66,7 +66,7 @@ This guide walks you through how to install NGINX Kubernetes Gateway on a generi
    ```shell
    kubectl get pods -n nginx-gateway
    ```
-   ```
+   ```console
    NAME                             READY   STATUS    RESTARTS   AGE
    nginx-gateway-5d4f4c7db7-xk2kq   2/2     Running   0          112s
    ```

docs/running-on-kind.md

@@ -11,7 +11,7 @@ This guide walks you through how to run NGINX Kubernetes Gateway on a [kind](htt
 
 Create a cluster with `kind`. You can follow their [instructions](https://kind.sigs.k8s.io/docs/user/quick-start/#creating-a-cluster), or run the following make command at the root of the repository:
 
-```shell
+```makefile
 make create-kind-cluster
 ```
 

examples/advanced-routing/README.md

@@ -38,7 +38,7 @@ The cafe application consists of four Services: `coffee-v1-svc`, `coffee-v2-svc`
    ```shell
    kubectl -n default get pods
    ```
-   ```
+   ```console
    NAME                         READY   STATUS    RESTARTS   AGE
    coffee-v1-75869cf7ff-vlfpq   1/1     Running   0          17m
    coffee-v2-67499ff985-2k6cc   1/1     Running   0          17m

examples/cafe-example/README.md

@@ -33,7 +33,7 @@ In this example we deploy NGINX Kubernetes Gateway, a simple web application, an
    ```shell
    kubectl -n default get pods
    ```
-   ```
+   ```console
    NAME                      READY   STATUS    RESTARTS   AGE
    coffee-6f4b79b975-2sb28   1/1     Running   0          12s
    tea-6fb46d899f-fm7zr      1/1     Running   0          12s

examples/cross-namespace-routing/README.md

@@ -34,7 +34,7 @@ in a different namespace from our HTTPRoutes.
    ```shell
    kubectl -n cafe get pods
    ```
-   ```
+   ```console
    NAME                      READY   STATUS    RESTARTS   AGE
    coffee-6f4b79b975-2sb28   1/1     Running   0          12s
    tea-6fb46d899f-fm7zr      1/1     Running   0          12s
@@ -113,7 +113,7 @@ You can also check the conditions of the HTTPRoutes `coffee` and `tea` to verify
 ```shell
 kubectl describe httproute coffee
 ```
-```
+```console
 Condtions:
       Message:               Backend ref to Service cafe/coffee not permitted by any ReferenceGrant
       Observed Generation:   1
@@ -126,7 +126,7 @@ Condtions:
 ```shell
 kubectl describe httproute tea
 ```
-```
+```console
 Condtions:
       Message:               Backend ref to Service cafe/tea not permitted by any ReferenceGrant
       Observed Generation:   1

examples/http-header-filter/README.md

@@ -34,7 +34,7 @@ headers to the request.
    ```shell
    kubectl -n default get pods
    ```
-   ```
+   ```console
    NAME                      READY   STATUS    RESTARTS   AGE
    headers-6f4b79b975-2sb28   1/1     Running   0          12s
    ```
@@ -63,7 +63,7 @@ is absent.
 ```shell
 curl -s --resolve echo.example.com:$GW_PORT:$GW_IP http://echo.example.com:$GW_PORT/headers -H "My-Cool-Header:my-client-value" -H "My-Overwrite-Header:dont-see-this"
 ```
-```
+```console
 Headers:
   header 'Accept-Encoding' is 'compress'
   header 'My-cool-header' is 'my-client-value, this-is-an-appended-value'

examples/https-termination/README.md

@@ -36,7 +36,7 @@ reference a Secret in a different Namespace.
    ```shell
    kubectl -n default get pods
    ```
-   ```
+   ```console
    NAME                      READY   STATUS    RESTARTS   AGE
    coffee-6f4b79b975-2sb28   1/1     Running   0          12s
    tea-6fb46d899f-fm7zr      1/1     Running   0          12s
@@ -110,7 +110,7 @@ To get a redirect for coffee:
 ```shell
 curl --resolve cafe.example.com:$GW_HTTP_PORT:$GW_IP http://cafe.example.com:$GW_HTTP_PORT/coffee --include
 ```
-```
+```console
 HTTP/1.1 302 Moved Temporarily
 ...
 Location: https://cafe.example.com:443/coffee
@@ -122,7 +122,7 @@ To get a redirect for tea:
 ```shell
 curl --resolve cafe.example.com:$GW_HTTP_PORT:$GW_IP http://cafe.example.com:$GW_HTTP_PORT/tea --include
 ```
-```
+```console
 HTTP/1.1 302 Moved Temporarily
 ...
 Location: https://cafe.example.com:443/tea
@@ -139,7 +139,7 @@ To get coffee:
 ```shell
 curl --resolve cafe.example.com:$GW_HTTPS_PORT:$GW_IP https://cafe.example.com:$GW_HTTPS_PORT/coffee --insecure
 ```
-```
+```console
 Server address: 10.12.0.18:80
 Server name: coffee-7586895968-r26zn
 ```
@@ -149,7 +149,7 @@ To get tea:
 ```shell
 curl --resolve cafe.example.com:$GW_HTTPS_PORT:$GW_IP https://cafe.example.com:$GW_HTTPS_PORT/tea --insecure
 ```
-```
+```console
 Server address: 10.12.0.19:80
 Server name: tea-7cd44fcb4d-xfw2x
 ```
@@ -167,7 +167,7 @@ Now, if we try to access the application over HTTPS, we will get a connection re
 ```shell
 curl --resolve cafe.example.com:$GW_HTTPS_PORT:$GW_IP https://cafe.example.com:$GW_HTTPS_PORT/coffee --insecure -vvv
 ```
-```
+```console
 ...
 curl: (7) Failed to connect to cafe.example.com port 443 after 0 ms: Connection refused
 ```
@@ -178,7 +178,7 @@ You can also check the conditions of the Gateway `https` Listener to verify the
 ```shell
  kubectl describe gateway gateway
 ```
-```
+```console
  Name:                    https
  Conditions:
    Last Transition Time:  2023-06-26T20:23:56Z

examples/traffic-splitting/README.md

@@ -34,7 +34,7 @@ We will use `HTTPRoute` resources to split traffic between two versions of the a
    ```shell
    kubectl -n default get pods
    ```
-   ```
+   ```console
    NAME                         READY   STATUS    RESTARTS   AGE
    coffee-v1-7c57c576b-rfjsh    1/1     Running   0          21m
    coffee-v2-698f66dc46-vcb6r   1/1     Running   0          21m
@@ -68,14 +68,14 @@ curl --resolve cafe.example.com:$GW_PORT:$GW_IP http://cafe.example.com:$GW_PORT
 
 80% of the responses will come from `coffee-v1`:
 
-```
+```console
 Server address: 10.12.0.18:80
 Server name: coffee-v1-7c57c576b-rfjsh
 ```
 
 20% of the responses will come from `coffee-v2`:
 
-```
+```console
 Server address: 10.12.0.19:80
 Server name: coffee-v2-698f66dc46-vcb6r
 ```