Skip to content

Commit f20fe55

Browse files
authoredOct 19, 2023
Fix docs links in notes (#1158)
Problem: Internal docs links within notes aren't working properly. Solution: Adjusted these links so they redirect properly.
1 parent 3a391f6 commit f20fe55

File tree

5 files changed

+10
-8
lines changed

5 files changed

+10
-8
lines changed
 

‎conformance/provisioner/README.md

+4-3
Original file line numberDiff line numberDiff line change
@@ -19,9 +19,10 @@ Global Flags:
1919
https://github.com/nginxinc/nginx-gateway-fabric/issues/634). However, it can be used in the Gateway API conformance
2020
tests, which expect a Gateway API implementation to provision an independent data plane per Gateway.
2121
>
22-
> Note: Provisioner uses [this manifest](/deploy/manifests/deployment.yaml) to create an NGF static mode Deployment.
23-
This manifest gets included into the NGF binary during the NGF build. To customize the Deployment, modify the manifest
24-
and **re-build** NGF.
22+
> Note: Provisioner uses [this manifest](https://github.com/nginxinc/nginx-gateway-fabric/blob/main/conformance/provisioner/static-deployment.yaml)
23+
to create an NGF static mode Deployment.
24+
> This manifest gets included into the NGF binary during the NGF build. To customize the Deployment, modify the
25+
manifest and **re-build** NGF.
2526

2627
How to deploy:
2728

‎deploy/helm-chart/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ This chart deploys the NGINX Gateway Fabric in your Kubernetes cluster.
1414
> Note: The Gateway API resources from the standard channel (the CRDs and the validating webhook) must be installed
1515
> before deploying NGINX Gateway Fabric. If they are already installed in your cluster, please ensure they are
1616
> the correct version as supported by the NGINX Gateway Fabric -
17-
> [see the Technical Specifications](../../README.md#technical-specifications).
17+
> [see the Technical Specifications](https://github.com/nginxinc/nginx-gateway-fabric/blob/main/README.md#technical-specifications).
1818
1919
To install the Gateway resources from [the Gateway API repo](https://github.com/kubernetes-sigs/gateway-api), run:
2020

‎docs/developer/quickstart.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -98,7 +98,7 @@ This will build the docker images `nginx-gateway-fabric:<your-user>` and `nginx-
9898
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
9999
```
100100
101-
> For more information on helm configuration options see the Helm [README](/deploy/helm-chart/README.md).
101+
> For more information on helm configuration options see the Helm [README](../../deploy/helm-chart/README.md).
102102
103103
- To install with manifests:
104104

‎docs/guides/upgrade-apps-without-downtime.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ This guide explains how to use NGINX Gateway Fabric to upgrade applications with
55
Multiple upgrade methods are mentioned, assuming existing familiarity: this guide focuses primarily on how to use NGINX
66
Gateway Fabric to accomplish them.
77

8-
> See the [Architecture document](/docs/architecture.md) to learn more about NGINX Gateway Fabric architecture.
8+
> See the [Architecture document](../architecture.md) to learn more about NGINX Gateway Fabric architecture.
99
1010
## NGINX Gateway Fabric Functionality
1111

@@ -83,7 +83,7 @@ For example, an application can be exposed using a routing rule like below:
8383
port: 80
8484
```
8585
86-
> See the [Cafe example](/examples/cafe-example) for a basic example.
86+
> See the [Cafe example](../../examples/cafe-example) for a basic example.
8787
8888
The upgrade methods in the next sections cover:
8989

‎docs/proposals/README.md

+2-1
Original file line numberDiff line numberDiff line change
@@ -80,7 +80,8 @@ with the changes and update the status field of the corresponding Enhancement Pr
8080

8181
> Note:
8282
>
83-
> Make sure to read the [Development Guide](/CONTRIBUTING.md#development-guide) before making any code changes.
83+
> Make sure to read the [Development Guide](https://github.com/nginxinc/nginx-gateway-fabric/blob/main/CONTRIBUTING.md#development-guide)
84+
> before making any code changes.
8485
8586
## Status
8687

0 commit comments

Comments
 (0)
Please sign in to comment.