Skip to content
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.

Sign up for GitHub

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

Fix docs links in notes #1158

Merged
merged 3 commits into from
Oct 19, 2023
Merged

Fix docs links in notes #1158

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
d0ab1e9
Fix docs links in notes
sjberman Oct 18, 2023
1eec8b7
Fix one more
sjberman Oct 18, 2023
a9b9554
Merge branch 'main' into docs/readme-links
sjberman Oct 19, 2023
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
7 changes: 4 additions & 3 deletions conformance/provisioner/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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:

Expand Down
2 changes: 1 addition & 1 deletion deploy/helm-chart/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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:

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

Expand Down
4 changes: 2 additions & 2 deletions docs/guides/upgrade-apps-without-downtime.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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

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

Expand Down
3 changes: 2 additions & 1 deletion docs/proposals/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
Loading