Skip to content

Commit befab04

Browse files
committed
feat: Update NGINX Gateway Fabric information architecture
Full description pending
1 parent c8ed6bd commit befab04

26 files changed

+35
-40
lines changed

content/includes/ngf/installation/install-gateway-api-experimental-features.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ kubectl kustomize "https://github.com/nginx/nginx-gateway-fabric/config/crd/gate
1717
To enable experimental features on NGINX Gateway Fabric:
1818

1919
Using Helm: Set `nginxGateway.gwAPIExperimentalFeatures.enable` to true. An example can be found
20-
in the [Installation with Helm]({{< ref "/ngf/installation/installing-ngf/helm.md#custom-installation-options" >}}) guide.
20+
in the [Installation with Helm]({{< ref "/ngf/install/helm.md#custom-installation-options" >}}) guide.
2121

2222
Using Kubernetes manifests: Add the `--gateway-api-experimental-features` command-line flag to the deployment manifest args.
23-
An example can be found in the [Installation with Kubernetes manifests]({{< ref "/ngf/installation/installing-ngf/manifests.md#3-deploy-nginx-gateway-fabric" >}}) guide.
23+
An example can be found in the [Installation with Kubernetes manifests]({{< ref "/ngf/install/manifests.md#3-deploy-nginx-gateway-fabric" >}}) guide.

content/includes/ngf/installation/nginx-plus/docker-registry-secret.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
docs: "DOCS-000"
33
---
44

5-
{{< note >}} If you would rather pull the NGINX Plus image and push to a private registry, you can skip this specific step and instead follow [this step]({{< ref "/ngf/installation/nginx-plus-jwt.md#pulling-an-image-for-local-use" >}}). {{< /note >}}
5+
{{< note >}} If you would rather pull the NGINX Plus image and push to a private registry, you can skip this specific step and instead follow [this step]({{< ref "/ngf/install/nginx-plus.md#pulling-an-image-for-local-use" >}}). {{< /note >}}
66

77
If the `nginx-gateway` namespace does not yet exist, create it:
88

content/ngf/get-started.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ docs: DOCS-000
1010
{{< important >}}
1111
This document is for trying out NGINX Gateway Fabric, and not intended for a production environment.
1212

13-
For standard deployments, you should read the [Install NGINX Gateway Fabric]({{< ref "/ngf/installation/installing-ngf" >}}) section.
13+
For standard deployments, you should read the [Install NGINX Gateway Fabric]({{< ref "/ngf/install/" >}}) section.
1414
{{< /important >}}
1515

1616
This is a guide for getting started with NGINX Gateway Fabric. It explains how to:
@@ -508,6 +508,6 @@ Request ID: 43882f2f5794a1ee05d2ea017a035ce3
508508

509509
## See also
510510

511-
- [Install NGINX Gateway Fabric]({{< ref "/ngf/installation/installing-ngf/" >}}), for additional ways to install NGINX Gateway Fabric
511+
- [Install NGINX Gateway Fabric]({{< ref "/ngf/install/" >}}), for additional ways to install NGINX Gateway Fabric
512512
- [How-to guides]({{< ref "/ngf/how-to/" >}}), for configuring your cluster
513513
- [Traffic management]({{< ref "/ngf/how-to/traffic-management/" >}}), for more in-depth traffic management configuration

content/ngf/how-to/control-plane-configuration.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ Learn how to dynamically update the NGINX Gateway Fabric control plane configura
1313

1414
NGINX Gateway Fabric can dynamically update the control plane configuration without restarting. The control plane configuration is stored in the NginxGateway custom resource, created during the installation of NGINX Gateway Fabric.
1515

16-
NginxGateway is deployed in the same namespace as the controller (Default: `nginx-gateway`). The resource's default name is based on your [installation method]({{< ref "/ngf/installation/installing-ngf" >}}):
16+
NginxGateway is deployed in the same namespace as the controller (Default: `nginx-gateway`). The resource's default name is based on your [installation method]({{< ref "/ngf/install/" >}}):
1717

1818
- Helm: `<release-name>-config`
1919
- Manifests: `nginx-gateway-config`

content/ngf/how-to/data-plane-configuration.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -313,7 +313,7 @@ of a few arguments. {{</ note >}}
313313

314314
### Run NGINX Gateway Fabric with NGINX in debug mode
315315

316-
To run NGINX Gateway Fabric with NGINX in debug mode, follow the [installation document]({{< ref "/ngf/installation/installing-ngf" >}}) with these additional steps:
316+
To run NGINX Gateway Fabric with NGINX in debug mode, after[installation]({{< ref "/ngf/install/" >}}), follow these additional steps:
317317

318318
Using Helm: Set `nginx.debug` to true.
319319

content/ngf/how-to/monitoring/tracing.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -82,7 +82,7 @@ For all the possible configuration options for these resources, see the [API ref
8282

8383
### Install NGINX Gateway Fabric with global tracing configuration
8484

85-
{{< note >}}Ensure that you [install the Gateway API resources]({{< ref "/ngf/installation/installing-ngf/helm.md#installing-the-gateway-api-resources" >}}).{{< /note >}}
85+
{{< note >}} Ensure that you [install the Gateway API resources]({{< ref "/ngf/install/helm.md#installing-the-gateway-api-resources" >}}).{{< /note >}}
8686

8787
Referencing the previously deployed collector, create the following `values.yaml` file for installing NGINX Gateway Fabric:
8888

content/ngf/how-to/monitoring/troubleshooting.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -312,7 +312,7 @@ Verify that the port number (for example, `8080`) matches the port number you ha
312312
| Startup | NGINX Gateway Fabric fails to start. | Check logs for _nginx_ and _nginx-gateway_ containers. | Readiness probe failed. |
313313
| Resources not configured | Status missing on resources. | Check referenced resources. | Referenced resources do not belong to NGINX Gateway Fabric. |
314314
| NGINX errors | Reload failures on NGINX | Fix permissions for control plane. | Security context not configured. |
315-
| NGINX Plus errors | Failure to start; traffic interruptions | Set up the [NGINX Plus JWT]({{< ref "/ngf/installation/nginx-plus-jwt.md" >}}) | License is not configured or has expired. |
315+
| NGINX Plus errors | Failure to start; traffic interruptions | Set up the [NGINX Plus JWT]({{< ref "/ngf/install/nginx-plus.md" >}}) | License is not configured or has expired. |
316316
| Client Settings | Request entity too large error | Adjust client settings. Refer to [Client Settings Policy]({{< relref "../traffic-management/client-settings.md" >}}) | Payload is greater than the [`client_max_body_size`](https://nginx.org/en/docs/http/ngx_http_core_module.html#client_max_body_size) value.|
317317

318318
{{< /bootstrap-table >}}
@@ -396,7 +396,7 @@ nginx: [emerg] License file is required. Download JWT license from MyF5 and conf
396396
nginx: [emerg] license expired
397397
```
398398

399-
These errors could prevent NGINX Plus from starting or prevent traffic from flowing. To fix these issues, see the [NGINX Plus JWT]({{< ref "/ngf/installation/nginx-plus-jwt.md" >}}) guide.
399+
These errors could prevent NGINX Plus from starting or prevent traffic from flowing. To fix these issues, see the [NGINX Plus JWT]({{< ref "/ngf/install/nginx-plus.md" >}}) guide.
400400

401401
---
402402

content/ngf/how-to/traffic-management/advanced-routing.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ The goal is to create a set of rules that will result in client requests being s
2525

2626
## Before you begin
2727

28-
- [Install]({{< ref "/ngf/installation/" >}}) NGINX Gateway Fabric.
28+
- [Install]({{< ref "/ngf/install/" >}}) NGINX Gateway Fabric.
2929
- Save the public IP address and port of NGINX Gateway Fabric into shell variables:
3030

3131
```text
@@ -303,7 +303,7 @@ This request should receive a response from the `tea-post` pod. Any other type o
303303

304304
If you have any issues while sending traffic, try the following to debug your configuration and setup:
305305

306-
- Make sure you set the shell variables $GW_IP and $GW_PORT to the public IP and port of the NGINX Gateway Fabric service. Refer to the [Installation]({{< ref "/ngf/installation/" >}}) guides for more information.
306+
- Make sure you set the shell variables $GW_IP and $GW_PORT to the public IP and port of the NGINX Gateway Fabric service. Refer to the [Installation]({{< ref "/ngf/install/" >}}) guides for more information.
307307

308308
- Check the status of the Gateway:
309309

content/ngf/how-to/traffic-management/client-settings.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ For all the possible configuration options for `ClientSettingsPolicy`, see the [
3838

3939
## Before you begin
4040

41-
- [Install]({{< ref "/ngf/installation/" >}}) NGINX Gateway Fabric.
41+
- [Install]({{< ref "/ngf/install/" >}}) NGINX Gateway Fabric.
4242
- Save the public IP address and port of NGINX Gateway Fabric into shell variables:
4343

4444
```text

content/ngf/how-to/traffic-management/https-termination.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ In this guide, we will show how to configure HTTPS termination for your applicat
1919

2020
## Before you begin
2121

22-
- [Install]({{< ref "/ngf/installation/" >}}) NGINX Gateway Fabric.
22+
- [Install]({{< ref "/ngf/install/" >}}) NGINX Gateway Fabric.
2323
- Save the public IP address and port of NGINX Gateway Fabric into shell variables:
2424

2525
```text

0 commit comments

Comments
 (0)