From e55708d2f2c1d0255f86a771f9bd72608c453185 Mon Sep 17 00:00:00 2001 From: Alan Dooley Date: Wed, 4 Jun 2025 16:28:00 +0100 Subject: [PATCH 1/4] Update production documentation URLs for 2.0 release This commit updates links to documentation where relevant to reflect changes to the information architecture as part of the release. It also addresses a small link issue for NGINX Agent that was noticed. --- CONTRIBUTING.md | 2 +- README.md | 4 ++-- deploy/README.md | 2 +- design/control-data-plane-separation/design.md | 2 +- docs/developer/quickstart.md | 2 +- examples/advanced-routing/README.md | 2 +- examples/cafe-example/README.md | 2 +- examples/client-settings-policy/README.md | 2 +- examples/cross-namespace-routing/README.md | 2 +- examples/grpc-routing/README.md | 2 +- examples/http-request-header-filter/README.md | 2 +- examples/http-response-header-filter/README.md | 2 +- examples/https-termination/README.md | 2 +- examples/snippets-filter/README.md | 2 +- examples/traffic-splitting/README.md | 2 +- examples/upstream-settings-policy/README.md | 2 +- 16 files changed, 17 insertions(+), 17 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 5428414b42..f94c248526 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -32,7 +32,7 @@ Reserve GitHub issues for feature requests and bugs rather than general question ## Getting Started -Follow our [Installation Instructions](https://docs.nginx.com/nginx-gateway-fabric/installation/) to get the NGINX Gateway Fabric up and running. +Follow our [Installation Instructions](https://docs.nginx.com/nginx-gateway-fabric/install/) to get the NGINX Gateway Fabric up and running. ### Project Structure diff --git a/README.md b/README.md index d2abca13d6..f0125ed53a 100644 --- a/README.md +++ b/README.md @@ -25,7 +25,7 @@ NGINX Gateway Fabric uses [NGINX Agent](https://github.com/nginx/agent) to confi ## Getting Started 1. [Get started using a kind cluster](https://docs.nginx.com/nginx-gateway-fabric/get-started/). -2. [Install](https://docs.nginx.com/nginx-gateway-fabric/installation/) NGINX Gateway Fabric. +2. [Install](https://docs.nginx.com/nginx-gateway-fabric/install/) NGINX Gateway Fabric. 3. Deploy various [examples](examples). 4. Read our [How-to guides](https://docs.nginx.com/nginx-gateway-fabric/how-to/). @@ -136,4 +136,4 @@ Please read our [Contributing guide](CONTRIBUTING.md) if you'd like to contribut If your team needs dedicated support for NGINX Gateway Fabric in your environment, or you would like to leverage our [advanced NGINX Plus features](https://docs.nginx.com/nginx-gateway-fabric/overview/nginx-plus/), you can reach out [here](https://www.f5.com/content/f5-com/en_us/products/get-f5). -To try NGINX Gateway Fabric with NGINX Plus, you can start your free [30-day trial](https://www.f5.com/trials), then follow the [installation guide](https://docs.nginx.com/nginx-gateway-fabric/installation/installing-ngf/helm/) for installing with NGINX Plus. +To try NGINX Gateway Fabric with NGINX Plus, you can start your free [30-day trial](https://www.f5.com/trials), then follow the [installation guide](https://docs.nginx.com/nginx-gateway-fabric/install/helm/) for installing with NGINX Plus. diff --git a/deploy/README.md b/deploy/README.md index ade7d43ff1..3d34274162 100644 --- a/deploy/README.md +++ b/deploy/README.md @@ -12,4 +12,4 @@ use the following command to apply the manifests: kubectl kustomize | kubectl apply -f - ``` -For more information on how to deploy NGINX Gateway Fabric and the Gateway API CRDs see the [installation guide](https://docs.nginx.com/nginx-gateway-fabric/installation/installing-ngf/manifests/). +For more information on how to deploy NGINX Gateway Fabric and the Gateway API CRDs see the [installation guide](https://docs.nginx.com/nginx-gateway-fabric/install/manifests/). diff --git a/design/control-data-plane-separation/design.md b/design/control-data-plane-separation/design.md index 905bc5c834..0699a28303 100644 --- a/design/control-data-plane-separation/design.md +++ b/design/control-data-plane-separation/design.md @@ -713,7 +713,7 @@ have a use case for runtime configuration at the moment. [agent-config]: https://github.com/nginx/agent/blob/ea3a1b4df5d7ecf95bd3d9297d26e420f5e1dd57/sdk/proto/agent.pb.go#L320 -[cli]: https://docs.nginx.com/nginx-management-suite/nginx-agent/install-nginx-agent/#nginx-agent-cli-flags-usage +[cli]: https://docs.nginx.com/nginx-agent/configuration/configuration-overview/#cli-flags--environment-variables ## Edge Cases diff --git a/docs/developer/quickstart.md b/docs/developer/quickstart.md index 697acf5036..0b835da9d2 100644 --- a/docs/developer/quickstart.md +++ b/docs/developer/quickstart.md @@ -121,7 +121,7 @@ This will build the docker images `nginx-gateway-fabric:` and `nginx- > Note: You will need a valid NGINX Plus license certificate and key named `nginx-repo.crt` and `nginx-repo.key` in the > root of this repo to build the NGINX Plus image. -> You will also need a valid NGINX Plus JSON Web Token (JWT) to deploy NGF with NGINX Plus. That JWT should be stored in the `license.jwt` file in the root of the `nginx-gateway-fabric/` directory. See the [documentation](https://docs.nginx.com/nginx-gateway-fabric/installation/nginx-plus-jwt/) for instructions on how to download and set up the JWT. +> You will also need a valid NGINX Plus JSON Web Token (JWT) to deploy NGF with NGINX Plus. That JWT should be stored in the `license.jwt` file in the root of the `nginx-gateway-fabric/` directory. See the [documentation](https://docs.nginx.com/nginx-gateway-fabric/install/nginx-plus/) for instructions on how to download and set up the JWT. > Additionally, you need to set the NGINX Plus usage endpoint in your environment. For development and testing, export `PLUS_USAGE_ENDPOINT=`. To build the NGINX Gateway Fabric and NGINX Plus container images from source run the following make command: diff --git a/examples/advanced-routing/README.md b/examples/advanced-routing/README.md index fc1cb56e69..feb4e884a3 100644 --- a/examples/advanced-routing/README.md +++ b/examples/advanced-routing/README.md @@ -1,3 +1,3 @@ # Advanced Routing -This directory contains the YAML files used in the [Advanced Routing](https://docs.nginx.com/nginx-gateway-fabric/how-to/traffic-management/advanced-routing/) guide. +This directory contains the YAML files used in the [Advanced Routing](https://docs.nginx.com/nginx-gateway-fabric/traffic-management/advanced-routing/) guide. diff --git a/examples/cafe-example/README.md b/examples/cafe-example/README.md index d10f871e05..6357da5d51 100644 --- a/examples/cafe-example/README.md +++ b/examples/cafe-example/README.md @@ -7,7 +7,7 @@ to route traffic to that application using HTTPRoute resources. ## 1. Deploy NGINX Gateway Fabric -1. Follow the [installation instructions](https://docs.nginx.com/nginx-gateway-fabric/installation/) to deploy NGINX Gateway Fabric. +1. Follow the [installation instructions](https://docs.nginx.com/nginx-gateway-fabric/install/) to deploy NGINX Gateway Fabric. ## 2. Deploy the Cafe Application diff --git a/examples/client-settings-policy/README.md b/examples/client-settings-policy/README.md index 4b192f0850..53db514e03 100644 --- a/examples/client-settings-policy/README.md +++ b/examples/client-settings-policy/README.md @@ -1,3 +1,3 @@ # Client Settings Policy -This directory contains the YAML files used in the [ClientSettingsPolicy](https://docs.nginx.com/nginx-gateway-fabric/how-to/traffic-management/client-settings/) guide. +This directory contains the YAML files used in the [ClientSettingsPolicy](https://docs.nginx.com/nginx-gateway-fabric/traffic-management/client-settings/) guide. diff --git a/examples/cross-namespace-routing/README.md b/examples/cross-namespace-routing/README.md index 9e98908a63..663081b060 100644 --- a/examples/cross-namespace-routing/README.md +++ b/examples/cross-namespace-routing/README.md @@ -7,7 +7,7 @@ in a different namespace from our HTTPRoutes. ## 1. Deploy NGINX Gateway Fabric -1. Follow the [installation instructions](https://docs.nginx.com/nginx-gateway-fabric/installation/) to deploy NGINX Gateway Fabric. +1. Follow the [installation instructions](https://docs.nginx.com/nginx-gateway-fabric/install/) to deploy NGINX Gateway Fabric. ## 2. Deploy the Cafe Application diff --git a/examples/grpc-routing/README.md b/examples/grpc-routing/README.md index 3f294978ce..c3fab9dbcf 100644 --- a/examples/grpc-routing/README.md +++ b/examples/grpc-routing/README.md @@ -7,7 +7,7 @@ to route traffic to that application using GRPCRoute resources. ## 1. Deploy NGINX Gateway Fabric -1. Follow the [installation instructions](https://docs.nginx.com/nginx-gateway-fabric/installation/) to deploy NGINX Gateway Fabric. +1. Follow the [installation instructions](https://docs.nginx.com/nginx-gateway-fabric/install/) to deploy NGINX Gateway Fabric. ## 2. Deploy the Helloworld Application diff --git a/examples/http-request-header-filter/README.md b/examples/http-request-header-filter/README.md index 0dc7e36a76..5de5be7c2f 100644 --- a/examples/http-request-header-filter/README.md +++ b/examples/http-request-header-filter/README.md @@ -1,3 +1,3 @@ # HTTP request headers example -This directory contains the YAML files used in the [Modify HTTP request and response headers](https://docs.nginx.com/nginx-gateway-fabric/how-to/traffic-management/request-response-headers/) guide. +This directory contains the YAML files used in the [Modify HTTP request and response headers](https://docs.nginx.com/nginx-gateway-fabric/traffic-management/request-response-headers/) guide. diff --git a/examples/http-response-header-filter/README.md b/examples/http-response-header-filter/README.md index ba59ed221f..e6b20f7e38 100644 --- a/examples/http-response-header-filter/README.md +++ b/examples/http-response-header-filter/README.md @@ -1,3 +1,3 @@ # HTTP response headers example -This directory contains the YAML files used in the [Modify HTTP request and response headers](https://docs.nginx.com/nginx-gateway-fabric/how-to/traffic-management/request-response-headers/) guide. +This directory contains the YAML files used in the [Modify HTTP request and response headers](https://docs.nginx.com/nginx-gateway-fabric/traffic-management/request-response-headers/) guide. diff --git a/examples/https-termination/README.md b/examples/https-termination/README.md index 8e7245e467..6af8c9a1b4 100644 --- a/examples/https-termination/README.md +++ b/examples/https-termination/README.md @@ -1,3 +1,3 @@ # HTTPS Termination -This directory contains the YAML files used in the [HTTPS Termination](https://docs.nginx.com/nginx-gateway-fabric/how-to/traffic-management/https-termination/) guide. +This directory contains the YAML files used in the [HTTPS Termination](https://docs.nginx.com/nginx-gateway-fabric/traffic-management/https-termination/) guide. diff --git a/examples/snippets-filter/README.md b/examples/snippets-filter/README.md index dce0157962..ab2b999e3e 100644 --- a/examples/snippets-filter/README.md +++ b/examples/snippets-filter/README.md @@ -1,3 +1,3 @@ # SnippetsFilter -This directory contains the YAML files used in the [SnippetsFilter API](https://docs.nginx.com/nginx-gateway-fabric/how-to/traffic-management/snippets/) guide. +This directory contains the YAML files used in the [SnippetsFilter API](https://docs.nginx.com/nginx-gateway-fabric/traffic-management/snippets/) guide. diff --git a/examples/traffic-splitting/README.md b/examples/traffic-splitting/README.md index d3a07061b5..55ff9daa42 100644 --- a/examples/traffic-splitting/README.md +++ b/examples/traffic-splitting/README.md @@ -9,7 +9,7 @@ and `coffee-v2`. ## 1. Deploy NGINX Gateway Fabric -1. Follow the [installation instructions](https://docs.nginx.com/nginx-gateway-fabric/installation/) to deploy NGINX Gateway Fabric. +1. Follow the [installation instructions](https://docs.nginx.com/nginx-gateway-fabric/install/) to deploy NGINX Gateway Fabric. ## 2. Deploy the Coffee Application diff --git a/examples/upstream-settings-policy/README.md b/examples/upstream-settings-policy/README.md index e2f1d2e59b..98ae8c5bbb 100644 --- a/examples/upstream-settings-policy/README.md +++ b/examples/upstream-settings-policy/README.md @@ -1,3 +1,3 @@ # UpstreamSettingsPolicy -This directory contains the YAML files used in the [UpstreamSettingsPolicy](https://docs.nginx.com/nginx-gateway-fabric/how-to/traffic-management/upstream-settings/) guide. +This directory contains the YAML files used in the [UpstreamSettingsPolicy](https://docs.nginx.com/nginx-gateway-fabric/traffic-management/upstream-settings/) guide. From 4ddabcf2318b402ec5782ab1e4ff75922f8ddaec Mon Sep 17 00:00:00 2001 From: Alan Dooley Date: Wed, 4 Jun 2025 17:07:21 +0100 Subject: [PATCH 2/4] Update README item to list common use cases --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index f0125ed53a..814046c08d 100644 --- a/README.md +++ b/README.md @@ -27,7 +27,7 @@ NGINX Gateway Fabric uses [NGINX Agent](https://github.com/nginx/agent) to confi 1. [Get started using a kind cluster](https://docs.nginx.com/nginx-gateway-fabric/get-started/). 2. [Install](https://docs.nginx.com/nginx-gateway-fabric/install/) NGINX Gateway Fabric. 3. Deploy various [examples](examples). -4. Read our [How-to guides](https://docs.nginx.com/nginx-gateway-fabric/how-to/). +4. Follow instructions for common use cases such as [routing](https://docs.nginx.com/nginx-gateway-fabric/traffic-management/basic-routing) and [securing](https://docs.nginx.com/nginx-gateway-fabric/traffic-security/securing-backend/) traffic, or [monitoring](https://docs.nginx.com/nginx-gateway-fabric//monitoring/) your cluster. You can find the comprehensive NGINX Gateway Fabric user documentation on the [NGINX Documentation](https://docs.nginx.com/nginx-gateway-fabric/) website. From 7184e14d7958324d2b495d7b6546b6284be35057 Mon Sep 17 00:00:00 2001 From: Alan Dooley Date: Wed, 4 Jun 2025 17:26:40 +0100 Subject: [PATCH 3/4] Update README link to direct users to top level security folder --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 814046c08d..331e9fb722 100644 --- a/README.md +++ b/README.md @@ -27,7 +27,7 @@ NGINX Gateway Fabric uses [NGINX Agent](https://github.com/nginx/agent) to confi 1. [Get started using a kind cluster](https://docs.nginx.com/nginx-gateway-fabric/get-started/). 2. [Install](https://docs.nginx.com/nginx-gateway-fabric/install/) NGINX Gateway Fabric. 3. Deploy various [examples](examples). -4. Follow instructions for common use cases such as [routing](https://docs.nginx.com/nginx-gateway-fabric/traffic-management/basic-routing) and [securing](https://docs.nginx.com/nginx-gateway-fabric/traffic-security/securing-backend/) traffic, or [monitoring](https://docs.nginx.com/nginx-gateway-fabric//monitoring/) your cluster. +4. Follow instructions for common use cass such as [routing](https://docs.nginx.com/nginx-gateway-fabric/traffic-management/basic-routing) and [securing](https://docs.nginx.com/nginx-gateway-fabric/traffic-security/) traffic, or [monitoring](https://docs.nginx.com/nginx-gateway-fabric//monitoring/) your cluster. You can find the comprehensive NGINX Gateway Fabric user documentation on the [NGINX Documentation](https://docs.nginx.com/nginx-gateway-fabric/) website. From 1d2b35815504e3a27b7dd8d6ea8bb9b92c611453 Mon Sep 17 00:00:00 2001 From: Alan Dooley Date: Thu, 5 Jun 2025 11:55:35 +0100 Subject: [PATCH 4/4] Update README links once more --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 331e9fb722..fa19afecd4 100644 --- a/README.md +++ b/README.md @@ -27,7 +27,7 @@ NGINX Gateway Fabric uses [NGINX Agent](https://github.com/nginx/agent) to confi 1. [Get started using a kind cluster](https://docs.nginx.com/nginx-gateway-fabric/get-started/). 2. [Install](https://docs.nginx.com/nginx-gateway-fabric/install/) NGINX Gateway Fabric. 3. Deploy various [examples](examples). -4. Follow instructions for common use cass such as [routing](https://docs.nginx.com/nginx-gateway-fabric/traffic-management/basic-routing) and [securing](https://docs.nginx.com/nginx-gateway-fabric/traffic-security/) traffic, or [monitoring](https://docs.nginx.com/nginx-gateway-fabric//monitoring/) your cluster. +4. Follow instructions for common use cases such as [routing](https://docs.nginx.com/nginx-gateway-fabric/traffic-management/) and [securing](https://docs.nginx.com/nginx-gateway-fabric/traffic-security/) traffic, or [monitoring](https://docs.nginx.com/nginx-gateway-fabric//monitoring/) your cluster. You can find the comprehensive NGINX Gateway Fabric user documentation on the [NGINX Documentation](https://docs.nginx.com/nginx-gateway-fabric/) website. @@ -106,7 +106,7 @@ docker buildx imagetools inspect ghcr.io/nginx/nginx-gateway-fabric:edge --forma ## Troubleshooting -For troubleshooting help, see the [Troubleshooting](https://docs.nginx.com/nginx-gateway-fabric/how-to/monitoring/troubleshooting/) document. +For troubleshooting help, see the [Troubleshooting](https://docs.nginx.com/nginx-gateway-fabric/troubleshooting/) document. ## Contacts