Skip to content

Commit 10238bf

Browse files
committed
Add docs feedback
1 parent 9cc7484 commit 10238bf

File tree

1 file changed

+7
-6
lines changed

1 file changed

+7
-6
lines changed

site/content/how-to/traffic-management/snippets.md

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -42,6 +42,8 @@ Snippets have the following disadvantages:
4242
{{< note >}} If you end up using Snippets and run into situations where an NGINX directive fails to be applied, please create an issue in the
4343
[NGINX Gateway Fabric Github repository](https://github.com/nginxinc/nginx-gateway-fabric). {{< /note >}}
4444

45+
---
46+
4547
## Setup
4648

4749
- To enable Snippets, [install]({{< relref "/installation/" >}}) NGINX Gateway Fabric with these modifications:
@@ -52,7 +54,7 @@ Snippets have the following disadvantages:
5254
- Save the public IP address and port of NGINX Gateway Fabric into shell variables:
5355

5456
```text
55-
GW_IP=XXX.YYY.ZZZ.III
57+
GW_IP=<ip address>
5658
GW_PORT=<port number>
5759
```
5860

@@ -192,7 +194,7 @@ spec:
192194
EOF
193195
```
194196

195-
Verify that the coffee HTTPRoute's has been configured correctly:
197+
Verify that the coffee HTTPRoute has been configured correctly:
196198

197199
```shell
198200
kubectl describe httproutes.gateway.networking.k8s.io coffee
@@ -298,7 +300,6 @@ Status:
298300
Events: <none>
299301
```
300302

301-
302303
Update the tea HTTPRoute to reference the `SnippetsFilter`:
303304

304305
```yaml
@@ -330,7 +331,7 @@ spec:
330331
EOF
331332
```
332333

333-
Verify that the tea HTTPRoute's has been configured correctly:
334+
Verify that the tea HTTPRoute has been configured correctly:
334335

335336
```shell
336337
kubectl describe httproutes.gateway.networking.k8s.io tea
@@ -379,12 +380,12 @@ for i in `seq 1 10`; do curl --resolve cafe.example.com:$GW_PORT:$GW_IP http://c
379380
You should see all successful responses from the tea Pod, but they should be spaced apart roughly one second each as
380381
expected through the rate limiting configuration.
381382

382-
You've now used the `SnippetsFilter` resource to configure two distinct rate limiting rules to different backend applications through the use of Snippets.
383+
This indicates that you've successfully used Snippets with the `SnippetsFilter` resource to configure two distinct rate limiting rules to different backend applications.
383384
For an alternative method of modifying the NGINX configuration NGINX Gateway Fabric generates through Gateway API resources, check out
384385
our supported [first-class policies]({{< relref "overview/custom-policies.md" >}}) which don't carry many of the aforementioned disadvantages of Snippets.
385386

386387
---
387388

388-
## Further reading
389+
## See also
389390

390391
- [API reference]({{< relref "reference/api.md" >}}): all configuration fields for the `SnippetsFilter` API.

0 commit comments

Comments
 (0)