Skip to content

Commit a5ae669

Browse files
authored
fix: fix links in github docs to d-n-c (#1291)
1 parent 110df75 commit a5ae669

File tree

11 files changed

+18
-17
lines changed

11 files changed

+18
-17
lines changed

CONTRIBUTING.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ Reserve GitHub issues for feature requests and bugs rather than general question
2929

3030
## Getting Started
3131

32-
Follow our [Installation Instructions](/docs/installation.md) to get the NGINX Gateway Fabric up and running.
32+
Follow our [Installation Instructions](https://docs.nginx.com/nginx-gateway-fabric/installation/) to get the NGINX Gateway Fabric up and running.
3333

3434
### Project Structure
3535

@@ -91,7 +91,7 @@ Before beginning development, familiarize yourself with the following documents:
9191
outlining guidelines and best practices to ensure smooth and efficient pull request processes.
9292
- [Go Style Guide](/docs/developer/go-style-guide.md): A coding style guide for Go. Contains best practices and
9393
conventions to follow when writing Go code for the project.
94-
- [Architecture](/docs/architecture.md): A high-level overview of the project's architecture.
94+
- [Architecture](https://docs.nginx.com/nginx-gateway-fabric/overview/gateway-architecture/): A high-level overview of the project's architecture.
9595
- [Design Principles](/docs/developer/design-principles.md): An overview of the project's design principles.
9696

9797
## Contributor License Agreement

README.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -10,15 +10,15 @@ and `UDPRoute` -- to configure an HTTP or TCP/UDP load balancer, reverse-proxy,
1010
on Kubernetes. NGINX Gateway Fabric supports a subset of the Gateway API.
1111

1212
For a list of supported Gateway API resources and features, see
13-
the [Gateway API Compatibility](https://docs.nginx.com/nginx-gateway-fabric/gateway-api-compatibility.md) doc.
13+
the [Gateway API Compatibility](https://docs.nginx.com/nginx-gateway-fabric/gateway-api-compatibility/) doc.
1414

15-
Learn about our [design principles](/docs/developer/design-principles.md) and [architecture](https://docs.nginx.com/nginx-gateway-fabric/overview/gateway-architecture.md).
15+
Learn about our [design principles](/docs/developer/design-principles.md) and [architecture](https://docs.nginx.com/nginx-gateway-fabric/overview/gateway-architecture/).
1616

1717
## Getting Started
1818

19-
1. [Quick Start on a kind cluster](https://docs.nginx.com/nginx-gateway-fabric/installation/running-on-kind.md).
19+
1. [Quick Start on a kind cluster](https://docs.nginx.com/nginx-gateway-fabric/installation/running-on-kind/).
2020
2. [Install](https://docs.nginx.com/nginx-gateway-fabric/installation/) NGINX Gateway Fabric.
21-
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
21+
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
2222
available
2323
on [GitHub Container Registry](https://github.com/nginxinc/nginx-gateway-fabric/pkgs/container/nginx-gateway-fabric).
2424
4. Deploy various [examples](examples).
@@ -101,7 +101,7 @@ docker buildx imagetools inspect ghcr.io/nginxinc/nginx-gateway-fabric:edge --fo
101101

102102
## Troubleshooting
103103

104-
For troubleshooting help, see the [Troubleshooting](https://docs.nginx.com/nginx-gateway-fabric/how-to/monitoring/troubleshooting.md) document.
104+
For troubleshooting help, see the [Troubleshooting](https://docs.nginx.com/nginx-gateway-fabric/how-to/monitoring/troubleshooting/) document.
105105

106106
## Contacts
107107

conformance/provisioner/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ manifest and **re-build** NGF.
2626

2727
How to deploy:
2828

29-
1. Follow the [installation](/docs/installation.md) instructions up until the Deploy the NGINX Gateway Fabric step
29+
1. Follow the [installation](https://docs.nginx.com/nginx-gateway-fabric/installation/) instructions up until the Deploy the NGINX Gateway Fabric step
3030
to deploy prerequisites for both the static mode Deployments and the provisioner.
3131
1. Deploy provisioner:
3232

deploy/helm-chart/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,7 @@ kubectl apply -f https://github.com/kubernetes-sigs/gateway-api/releases/downloa
5252
> **Important**
5353
>
5454
> The validating webhook is not needed if you are running Kubernetes 1.25+. Validation is done using CEL on the
55-
> CRDs. See the [resource validation doc](https://github.com/nginxinc/nginx-gateway-fabric/blob/main/docs/resource-validation.md)
55+
> CRDs. See the [resource validation doc](https://docs.nginx.com/nginx-gateway-fabric/overview/resource-validation/)
5656
> for more information.
5757
5858
## Installing the Chart

examples/advanced-routing/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
11
# Advanced Routing
22

3-
This directory contains the YAML files used in the [Advanced Routing](/docs/guides/advanced-routing.md) guide.
3+
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.

examples/cafe-example/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ to route traffic to that application using HTTPRoute resources.
77

88
## 1. Deploy NGINX Gateway Fabric
99

10-
1. Follow the [installation instructions](/docs/installation.md) to deploy NGINX Gateway Fabric.
10+
1. Follow the [installation instructions](https://docs.nginx.com/nginx-gateway-fabric/installation/) to deploy NGINX Gateway Fabric.
1111

1212
1. Save the public IP address of NGINX Gateway Fabric into a shell variable:
1313

examples/cross-namespace-routing/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ in a different namespace from our HTTPRoutes.
77

88
## 1. Deploy NGINX Gateway Fabric
99

10-
1. Follow the [installation instructions](/docs/installation.md) to deploy NGINX Gateway Fabric.
10+
1. Follow the [installation instructions](https://docs.nginx.com/nginx-gateway-fabric/installation/) to deploy NGINX Gateway Fabric.
1111

1212
1. Save the public IP address of NGINX Gateway Fabric into a shell variable:
1313

examples/http-header-filter/README.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,11 +3,12 @@
33
In this example we will deploy NGINX Gateway Fabric and configure traffic routing for a simple echo server.
44
We will use HTTPRoute resources to route traffic to the echo server, using the `RequestHeaderModifier` filter to modify
55
headers to the request.
6+
67
## Running the Example
78

89
## 1. Deploy NGINX Gateway Fabric
910

10-
1. Follow the [installation instructions](/docs/installation.md) to deploy NGINX Gateway Fabric.
11+
1. Follow the [installation instructions](https://docs.nginx.com/nginx-gateway-fabric/installation/) to deploy NGINX Gateway Fabric.
1112

1213
1. Save the public IP address of NGINX Gateway Fabric into a shell variable:
1314

examples/traffic-splitting/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ and `coffee-v2`.
99

1010
## 1. Deploy NGINX Gateway Fabric
1111

12-
1. Follow the [installation instructions](/docs/installation.md) to deploy NGINX Gateway Fabric.
12+
1. Follow the [installation instructions](https://docs.nginx.com/nginx-gateway-fabric/installation/) to deploy NGINX Gateway Fabric.
1313

1414
1. Save the public IP address of NGINX Gateway Fabric into a shell variable:
1515

tests/graceful-recovery/graceful-recovery.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -136,7 +136,7 @@ if the configuration and version were correctly updated.
136136

137137
1. Switch over to a one-Node Kind cluster. Can run `make create-kind-cluster` from main directory.
138138
2. Run steps 4-11 of the [Setup](#setup) section above using
139-
[this guide](https://github.com/nginxinc/nginx-gateway-fabric/blob/main/docs/running-on-kind.md) for running on Kind.
139+
[this guide](https://docs.nginx.com/nginx-gateway-fabric/installation/running-on-kind/) for running on Kind.
140140
3. Ensure NGF and NGINX container logs are set up and traffic flows through the example application correctly.
141141
4. Drain the Node of its resources.
142142

tests/zero-downtime-upgrades/zero-downtime-upgrades.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -118,7 +118,7 @@ Notes:
118118

119119
### Upgrade
120120

121-
1. Follow the [upgrade instructions](/docs/installation.md#upgrade-nginx-gateway-fabric-from-manifests) to:
121+
1. Follow the [upgrade instructions](https://docs.nginx.com/nginx-gateway-fabric/installation/installing-ngf/manifests/) to:
122122
1. Upgrade Gateway API version to the one that matches the supported version of new release.
123123
2. Upgrade NGF CRDs.
124124
2. Start sending traffic using wrk from tester VMs for 1 minute:
@@ -149,7 +149,7 @@ Notes:
149149
```
150150

151151
3. **Immediately** upgrade NGF manifests by
152-
following [upgrade instructions](/docs/installation.md#upgrade-nginx-gateway-fabric-from-manifests).
152+
following [upgrade instructions](https://docs.nginx.com/nginx-gateway-fabric/installation/installing-ngf/manifests/).
153153
> Don't forget to modify the manifests to have 2 replicas and Pod affinity.
154154
4. Ensure the new Pods are running and the old ones terminate.
155155

0 commit comments

Comments
 (0)