diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 17777fa817..c4937f6bd6 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -29,7 +29,7 @@ Reserve GitHub issues for feature requests and bugs rather than general question ## Getting Started -Follow our [Installation Instructions](/docs/installation.md) to get the NGINX Gateway Fabric up and running. +Follow our [Installation Instructions](https://docs.nginx.com/nginx-gateway-fabric/installation/) to get the NGINX Gateway Fabric up and running. ### Project Structure @@ -91,7 +91,7 @@ Before beginning development, familiarize yourself with the following documents: outlining guidelines and best practices to ensure smooth and efficient pull request processes. - [Go Style Guide](/docs/developer/go-style-guide.md): A coding style guide for Go. Contains best practices and conventions to follow when writing Go code for the project. -- [Architecture](/docs/architecture.md): A high-level overview of the project's architecture. +- [Architecture](https://docs.nginx.com/nginx-gateway-fabric/overview/gateway-architecture/): A high-level overview of the project's architecture. - [Design Principles](/docs/developer/design-principles.md): An overview of the project's design principles. ## Contributor License Agreement diff --git a/README.md b/README.md index d0f7a0fbab..8d5f258180 100644 --- a/README.md +++ b/README.md @@ -10,15 +10,15 @@ and `UDPRoute` -- to configure an HTTP or TCP/UDP load balancer, reverse-proxy, on Kubernetes. NGINX Gateway Fabric supports a subset of the Gateway API. For a list of supported Gateway API resources and features, see -the [Gateway API Compatibility](https://docs.nginx.com/nginx-gateway-fabric/gateway-api-compatibility.md) doc. +the [Gateway API Compatibility](https://docs.nginx.com/nginx-gateway-fabric/gateway-api-compatibility/) doc. -Learn about our [design principles](/docs/developer/design-principles.md) and [architecture](https://docs.nginx.com/nginx-gateway-fabric/overview/gateway-architecture.md). +Learn about our [design principles](/docs/developer/design-principles.md) and [architecture](https://docs.nginx.com/nginx-gateway-fabric/overview/gateway-architecture/). ## Getting Started -1. [Quick Start on a kind cluster](https://docs.nginx.com/nginx-gateway-fabric/installation/running-on-kind.md). +1. [Quick Start on a kind cluster](https://docs.nginx.com/nginx-gateway-fabric/installation/running-on-kind/). 2. [Install](https://docs.nginx.com/nginx-gateway-fabric/installation/) NGINX Gateway Fabric. -3. [Build](https://docs.nginx.com/nginx-gateway-fabric/installation/building-the-images.md) an NGINX Gateway Fabric container image from source or use a pre-built image +3. [Build](https://docs.nginx.com/nginx-gateway-fabric/installation/building-the-images/) an NGINX Gateway Fabric container image from source or use a pre-built image available on [GitHub Container Registry](https://github.com/nginxinc/nginx-gateway-fabric/pkgs/container/nginx-gateway-fabric). 4. Deploy various [examples](examples). @@ -101,7 +101,7 @@ docker buildx imagetools inspect ghcr.io/nginxinc/nginx-gateway-fabric:edge --fo ## Troubleshooting -For troubleshooting help, see the [Troubleshooting](https://docs.nginx.com/nginx-gateway-fabric/how-to/monitoring/troubleshooting.md) document. +For troubleshooting help, see the [Troubleshooting](https://docs.nginx.com/nginx-gateway-fabric/how-to/monitoring/troubleshooting/) document. ## Contacts diff --git a/conformance/provisioner/README.md b/conformance/provisioner/README.md index 0eb42a9b3d..ff1d0dfe25 100644 --- a/conformance/provisioner/README.md +++ b/conformance/provisioner/README.md @@ -26,7 +26,7 @@ manifest and **re-build** NGF. How to deploy: -1. Follow the [installation](/docs/installation.md) instructions up until the Deploy the NGINX Gateway Fabric step +1. Follow the [installation](https://docs.nginx.com/nginx-gateway-fabric/installation/) instructions up until the Deploy the NGINX Gateway Fabric step to deploy prerequisites for both the static mode Deployments and the provisioner. 1. Deploy provisioner: diff --git a/deploy/helm-chart/README.md b/deploy/helm-chart/README.md index c11358de0a..77fa2056de 100644 --- a/deploy/helm-chart/README.md +++ b/deploy/helm-chart/README.md @@ -52,7 +52,7 @@ kubectl apply -f https://github.com/kubernetes-sigs/gateway-api/releases/downloa > **Important** > > The validating webhook is not needed if you are running Kubernetes 1.25+. Validation is done using CEL on the -> CRDs. See the [resource validation doc](https://github.com/nginxinc/nginx-gateway-fabric/blob/main/docs/resource-validation.md) +> CRDs. See the [resource validation doc](https://docs.nginx.com/nginx-gateway-fabric/overview/resource-validation/) > for more information. ## Installing the Chart diff --git a/examples/advanced-routing/README.md b/examples/advanced-routing/README.md index 1f7dc0a9b3..fc1cb56e69 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](/docs/guides/advanced-routing.md) guide. +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. diff --git a/examples/cafe-example/README.md b/examples/cafe-example/README.md index fba0e30dba..e0254de815 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](/docs/installation.md) to deploy NGINX Gateway Fabric. +1. Follow the [installation instructions](https://docs.nginx.com/nginx-gateway-fabric/installation/) to deploy NGINX Gateway Fabric. 1. Save the public IP address of NGINX Gateway Fabric into a shell variable: diff --git a/examples/cross-namespace-routing/README.md b/examples/cross-namespace-routing/README.md index d8c2ba2e41..3e774cff46 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](/docs/installation.md) to deploy NGINX Gateway Fabric. +1. Follow the [installation instructions](https://docs.nginx.com/nginx-gateway-fabric/installation/) to deploy NGINX Gateway Fabric. 1. Save the public IP address of NGINX Gateway Fabric into a shell variable: diff --git a/examples/http-header-filter/README.md b/examples/http-header-filter/README.md index 6bc85d0f31..11b32c43e7 100644 --- a/examples/http-header-filter/README.md +++ b/examples/http-header-filter/README.md @@ -3,11 +3,12 @@ In this example we will deploy NGINX Gateway Fabric and configure traffic routing for a simple echo server. We will use HTTPRoute resources to route traffic to the echo server, using the `RequestHeaderModifier` filter to modify headers to the request. + ## Running the Example ## 1. Deploy NGINX Gateway Fabric -1. Follow the [installation instructions](/docs/installation.md) to deploy NGINX Gateway Fabric. +1. Follow the [installation instructions](https://docs.nginx.com/nginx-gateway-fabric/installation/) to deploy NGINX Gateway Fabric. 1. Save the public IP address of NGINX Gateway Fabric into a shell variable: diff --git a/examples/traffic-splitting/README.md b/examples/traffic-splitting/README.md index 02c3d2fef4..0479722cff 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](/docs/installation.md) to deploy NGINX Gateway Fabric. +1. Follow the [installation instructions](https://docs.nginx.com/nginx-gateway-fabric/installation/) to deploy NGINX Gateway Fabric. 1. Save the public IP address of NGINX Gateway Fabric into a shell variable: diff --git a/tests/graceful-recovery/graceful-recovery.md b/tests/graceful-recovery/graceful-recovery.md index b99ad303d1..feeab637eb 100644 --- a/tests/graceful-recovery/graceful-recovery.md +++ b/tests/graceful-recovery/graceful-recovery.md @@ -136,7 +136,7 @@ if the configuration and version were correctly updated. 1. Switch over to a one-Node Kind cluster. Can run `make create-kind-cluster` from main directory. 2. Run steps 4-11 of the [Setup](#setup) section above using -[this guide](https://github.com/nginxinc/nginx-gateway-fabric/blob/main/docs/running-on-kind.md) for running on Kind. +[this guide](https://docs.nginx.com/nginx-gateway-fabric/installation/running-on-kind/) for running on Kind. 3. Ensure NGF and NGINX container logs are set up and traffic flows through the example application correctly. 4. Drain the Node of its resources. diff --git a/tests/zero-downtime-upgrades/zero-downtime-upgrades.md b/tests/zero-downtime-upgrades/zero-downtime-upgrades.md index c37d50c311..4dd57e757f 100644 --- a/tests/zero-downtime-upgrades/zero-downtime-upgrades.md +++ b/tests/zero-downtime-upgrades/zero-downtime-upgrades.md @@ -118,7 +118,7 @@ Notes: ### Upgrade -1. Follow the [upgrade instructions](/docs/installation.md#upgrade-nginx-gateway-fabric-from-manifests) to: +1. Follow the [upgrade instructions](https://docs.nginx.com/nginx-gateway-fabric/installation/installing-ngf/manifests/) to: 1. Upgrade Gateway API version to the one that matches the supported version of new release. 2. Upgrade NGF CRDs. 2. Start sending traffic using wrk from tester VMs for 1 minute: @@ -149,7 +149,7 @@ Notes: ``` 3. **Immediately** upgrade NGF manifests by - following [upgrade instructions](/docs/installation.md#upgrade-nginx-gateway-fabric-from-manifests). + following [upgrade instructions](https://docs.nginx.com/nginx-gateway-fabric/installation/installing-ngf/manifests/). > Don't forget to modify the manifests to have 2 replicas and Pod affinity. 4. Ensure the new Pods are running and the old ones terminate.