Skip to content

Update production documentation URLs for 2.0 release #3445

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,9 +25,9 @@ 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/).
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.

Expand Down Expand Up @@ -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

Expand Down Expand Up @@ -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.
2 changes: 1 addition & 1 deletion deploy/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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/).
2 changes: 1 addition & 1 deletion design/control-data-plane-separation/design.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
2 changes: 1 addition & 1 deletion docs/developer/quickstart.md
Original file line number Diff line number Diff line change
Expand Up @@ -121,7 +121,7 @@ This will build the docker images `nginx-gateway-fabric:<your-user>` 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=<N1 staging endpoint>`.

To build the NGINX Gateway Fabric and NGINX Plus container images from source run the following make command:
Expand Down
2 changes: 1 addition & 1 deletion examples/advanced-routing/README.md
Original file line number Diff line number Diff line change
@@ -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.
2 changes: 1 addition & 1 deletion examples/cafe-example/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
2 changes: 1 addition & 1 deletion examples/client-settings-policy/README.md
Original file line number Diff line number Diff line change
@@ -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.
2 changes: 1 addition & 1 deletion examples/cross-namespace-routing/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
2 changes: 1 addition & 1 deletion examples/grpc-routing/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
2 changes: 1 addition & 1 deletion examples/http-request-header-filter/README.md
Original file line number Diff line number Diff line change
@@ -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.
2 changes: 1 addition & 1 deletion examples/http-response-header-filter/README.md
Original file line number Diff line number Diff line change
@@ -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.
2 changes: 1 addition & 1 deletion examples/https-termination/README.md
Original file line number Diff line number Diff line change
@@ -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.
2 changes: 1 addition & 1 deletion examples/snippets-filter/README.md
Original file line number Diff line number Diff line change
@@ -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.
2 changes: 1 addition & 1 deletion examples/traffic-splitting/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
2 changes: 1 addition & 1 deletion examples/upstream-settings-policy/README.md
Original file line number Diff line number Diff line change
@@ -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.
Loading