From d0ab1e90c5b82c6f5d753d6e6d6db69020f4a4e4 Mon Sep 17 00:00:00 2001 From: Saylor Berman Date: Wed, 18 Oct 2023 15:30:47 -0600 Subject: [PATCH 1/2] Fix docs links in notes Problem: Internal docs links within notes aren't working properly. Solution: Adjusted these links so they redirect properly. --- conformance/provisioner/README.md | 7 ++++--- deploy/helm-chart/README.md | 2 +- docs/guides/upgrade-apps-without-downtime.md | 4 ++-- docs/proposals/README.md | 3 ++- 4 files changed, 9 insertions(+), 7 deletions(-) diff --git a/conformance/provisioner/README.md b/conformance/provisioner/README.md index 04de6fa47e..0eb42a9b3d 100644 --- a/conformance/provisioner/README.md +++ b/conformance/provisioner/README.md @@ -19,9 +19,10 @@ Global Flags: https://github.com/nginxinc/nginx-gateway-fabric/issues/634). However, it can be used in the Gateway API conformance tests, which expect a Gateway API implementation to provision an independent data plane per Gateway. > -> Note: Provisioner uses [this manifest](/deploy/manifests/deployment.yaml) to create an NGF static mode Deployment. -This manifest gets included into the NGF binary during the NGF build. To customize the Deployment, modify the manifest -and **re-build** NGF. +> Note: Provisioner uses [this manifest](https://github.com/nginxinc/nginx-gateway-fabric/blob/main/conformance/provisioner/static-deployment.yaml) +to create an NGF static mode Deployment. +> This manifest gets included into the NGF binary during the NGF build. To customize the Deployment, modify the +manifest and **re-build** NGF. How to deploy: diff --git a/deploy/helm-chart/README.md b/deploy/helm-chart/README.md index 47ed6a4209..2f76629d03 100644 --- a/deploy/helm-chart/README.md +++ b/deploy/helm-chart/README.md @@ -14,7 +14,7 @@ This chart deploys the NGINX Gateway Fabric in your Kubernetes cluster. > Note: The Gateway API resources from the standard channel (the CRDs and the validating webhook) must be installed > before deploying NGINX Gateway Fabric. If they are already installed in your cluster, please ensure they are > the correct version as supported by the NGINX Gateway Fabric - -> [see the Technical Specifications](../../README.md#technical-specifications). +> [see the Technical Specifications](https://github.com/nginxinc/nginx-gateway-fabric/blob/main/README.md#technical-specifications). To install the Gateway resources from [the Gateway API repo](https://github.com/kubernetes-sigs/gateway-api), run: diff --git a/docs/guides/upgrade-apps-without-downtime.md b/docs/guides/upgrade-apps-without-downtime.md index 4287c3b1b2..bbc5646fec 100644 --- a/docs/guides/upgrade-apps-without-downtime.md +++ b/docs/guides/upgrade-apps-without-downtime.md @@ -5,7 +5,7 @@ This guide explains how to use NGINX Gateway Fabric to upgrade applications with Multiple upgrade methods are mentioned, assuming existing familiarity: this guide focuses primarily on how to use NGINX Gateway Fabric to accomplish them. -> See the [Architecture document](/docs/architecture.md) to learn more about NGINX Gateway Fabric architecture. +> See the [Architecture document](../architecture.md) to learn more about NGINX Gateway Fabric architecture. ## NGINX Gateway Fabric Functionality @@ -83,7 +83,7 @@ For example, an application can be exposed using a routing rule like below: port: 80 ``` -> See the [Cafe example](/examples/cafe-example) for a basic example. +> See the [Cafe example](../../examples/cafe-example) for a basic example. The upgrade methods in the next sections cover: diff --git a/docs/proposals/README.md b/docs/proposals/README.md index c36104fb8b..81bfa9338f 100644 --- a/docs/proposals/README.md +++ b/docs/proposals/README.md @@ -80,7 +80,8 @@ with the changes and update the status field of the corresponding Enhancement Pr > Note: > -> Make sure to read the [Development Guide](/CONTRIBUTING.md#development-guide) before making any code changes. +> Make sure to read the [Development Guide](https://github.com/nginxinc/nginx-gateway-fabric/blob/main/CONTRIBUTING.md#development-guide) +> before making any code changes. ## Status From 1eec8b70d16495bc326bb0b5874bde4c0cdd985c Mon Sep 17 00:00:00 2001 From: Saylor Berman Date: Wed, 18 Oct 2023 16:17:03 -0600 Subject: [PATCH 2/2] Fix one more --- docs/developer/quickstart.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/developer/quickstart.md b/docs/developer/quickstart.md index 2f8cd31b33..b02b37517d 100644 --- a/docs/developer/quickstart.md +++ b/docs/developer/quickstart.md @@ -98,7 +98,7 @@ This will build the docker images `nginx-gateway-fabric:` and `nginx- helm install my-release ./deploy/helm-chart --create-namespace --wait --set service.type=NodePort --set nginxGateway.image.repository=nginx-gateway-fabric --set nginxGateway.image.tag=$(whoami) --set nginxGateway.image.pullPolicy=Never --set nginx.image.repository=nginx-gateway-fabric/nginx --set nginx.image.tag=$(whoami) --set nginx.image.pullPolicy=Never -n nginx-gateway ``` - > For more information on helm configuration options see the Helm [README](/deploy/helm-chart/README.md). + > For more information on helm configuration options see the Helm [README](../../deploy/helm-chart/README.md). - To install with manifests: