Skip to content

Commit 6792da5

Browse files
committed
Update README links to reflect documentation URL changes
1 parent 14b4b0c commit 6792da5

File tree

48 files changed

+60
-60
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

48 files changed

+60
-60
lines changed

.github/workflows/release.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -456,7 +456,7 @@ jobs:
456456
# This is the official implementation of NGINX Ingress Controller (based on NGINX Plus) from NGINX.
457457
# usage-instructions: |
458458
# This container requires Kubernetes and can be deployed to EKS.
459-
# Review the installation instructions https://docs.nginx.com/nginx-ingress-controller/installation/ and utilize the deployment resources available https://github.com/nginx/kubernetes-ingress/tree/v${{ inputs.nic_version }}/deployments
459+
# Review the installation instructions https://docs.nginx.com/nginx-ingress-controller/install and utilize the deployment resources available https://github.com/nginx/kubernetes-ingress/tree/v${{ inputs.nic_version }}/deployments
460460
# Use this image instead of building your own.
461461

462462
binaries:

CHANGELOG.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -122,8 +122,8 @@ UPGRADE:
122122
```
123123

124124
As part of the upgrade, make sure to create the `v1` policies CRD. See the corresponding instructions for the
125-
[manifests](https://docs.nginx.com/nginx-ingress-controller/installation/installation-with-manifests/#create-custom-resources)
126-
and [Helm](https://docs.nginx.com/nginx-ingress-controller/installation/installation-with-helm/#upgrading-the-crds)
125+
[manifests](https://docs.nginx.com/nginx-ingress-controller/install/manifests#create-custom-resources)
126+
and [Helm](https://docs.nginx.com/nginx-ingress-controller/install/helm#upgrading-the-crds)
127127
installations.
128128

129129
Also note that all policies except for `accessControl` are still in preview. To enable them, run the Ingress
@@ -285,7 +285,7 @@ UPGRADE:
285285
- For Helm, use version 0.7.0 of the chart.
286286

287287
For Kubernetes >= 1.18, when upgrading using the
288-
[manifests](https://docs.nginx.com/nginx-ingress-controller/installation/installation-with-manifests/), make sure to
288+
[manifests](https://docs.nginx.com/nginx-ingress-controller/install/manifests), make sure to
289289
update the [ClusterRole](deployments/rbac/rbac.yaml) and create the [IngressClass
290290
resource](deployments/common/ingress-class.yaml), which is required for Kubernetes >= 1.18. Otherwise, the Ingress
291291
Controller will fail to start. If you run multiple NGINX Ingress Controllers in the cluster, each Ingress Controller has
@@ -308,7 +308,7 @@ NOTES:
308308

309309
- When using Kubernetes >= 1.18 the Ingress Controller will only process resources that belong to its class. See
310310
[IngressClass
311-
doc](https://docs.nginx.com/nginx-ingress-controller/installation/running-multiple-ingress-controllers/#ingress-class)
311+
doc](https://docs.nginx.com/nginx-ingress-controller/install/multiple-controllers#ingress-class)
312312
to learn more.
313313
- For Kubernetes >= 1.18, a dedicated IngressClass resource, which is configured by `controller.ingressClass`, is
314314
required per helm release. When upgrading or installing releases, ensure `controller.ingressClass` is not set to the
@@ -416,7 +416,7 @@ the cluster. Before upgrading, make sure to back up the custom resources. After
416416
NOTES:
417417

418418
- As part of installing a release, Helm will install the CRDs unless that step is disabled (see the [corresponding
419-
doc](https://docs.nginx.com/nginx-ingress-controller/installation/installation-with-helm/)). The installed CRDs
419+
doc](https://docs.nginx.com/nginx-ingress-controller/install/helm/). The installed CRDs
420420
include the CRDs for all Ingress Controller features, including the ones disabled by default (like App Protect with
421421
`aplogconfs.appprotect.f5.com` and `appolicies.appprotect.f5.com` CRDs).
422422

@@ -536,7 +536,7 @@ UPGRADE:
536536
- For Helm, use version 0.5.0 of the chart.
537537

538538
When upgrading using the
539-
[manifests](https://docs.nginx.com/nginx-ingress-controller/installation/installation-with-manifests/), make sure to
539+
[manifests](https://docs.nginx.com/nginx-ingress-controller/install/manifests), make sure to
540540
deploy the new TransportServer CRD (`common/ts-definition.yaml`), as it is required by the Ingress Controller.
541541
Otherwise, you will get error messages in the Ingress Controller logs.
542542

CONTRIBUTING.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ Please reserve GitHub issues for feature requests and bugs rather than general q
2828

2929
## Getting Started
3030

31-
Follow our [Installation Guide](https://docs.nginx.com/nginx-ingress-controller/installation/) to
31+
Follow our [Installation Guide](https://docs.nginx.com/nginx-ingress-controller/install/) to
3232
get NGINX Ingress Controller up and running.
3333

3434
Read the [documentation](https://docs.nginx.com/nginx-ingress-controller) and

README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -106,8 +106,8 @@ In the case of NGINX, the Ingress Controller is deployed in a pod along with the
106106
> page](https://github.com/nginx/kubernetes-ingress/releases) of the GitHub repository.
107107
108108
1. Install NGINX Ingress Controller using the [Helm
109-
chart](https://docs.nginx.com/nginx-ingress-controller/installation/installing-nic/installation-with-helm/) or the Kubernetes
110-
[manifests](https://docs.nginx.com/nginx-ingress-controller/installation/installing-nic/installation-with-manifests/).
109+
chart](https://docs.nginx.com/nginx-ingress-controller/install/helm/) or the Kubernetes
110+
[manifests](https://docs.nginx.com/nginx-ingress-controller/install/manifests/).
111111
1. Configure load balancing for a simple web application:
112112
- Use the Ingress resource. See the [Cafe
113113
example](https://github.com/nginx/kubernetes-ingress/tree/main/examples/ingress-resources/complete-example).
@@ -143,8 +143,8 @@ your links to the correct versions:
143143

144144
| Version | Description | Image for NGINX | Image for NGINX Plus | Installation Manifests and Helm Chart | Documentation and Examples |
145145
| ------- | ----------- | --------------- | -------------------- | ---------------------------------------| -------------------------- |
146-
| Latest stable release | For production use | Use the 5.2.1 images from [DockerHub](https://hub.docker.com/r/nginx/nginx-ingress/), [GitHub Container](https://github.com/nginx/kubernetes-ingress/pkgs/container/kubernetes-ingress), [Amazon ECR Public Gallery](https://gallery.ecr.aws/nginx/nginx-ingress) or [Quay.io](https://quay.io/repository/nginx/nginx-ingress) or [build your own image](https://docs.nginx.com/nginx-ingress-controller/installation/build-nginx-ingress-controller/). | Use the 5.2.1 images from the [F5 Container Registry](https://docs.nginx.com/nginx-ingress-controller/installation/nic-images/registry-download/) or [Build your own image](https://docs.nginx.com/nginx-ingress-controller/installation/build-nginx-ingress-controller/). | [Manifests](https://github.com/nginx/kubernetes-ingress/tree/v5.2.1/deployments). [Helm chart](https://github.com/nginx/kubernetes-ingress/tree/v5.2.1/charts/nginx-ingress). | [Documentation](https://docs.nginx.com/nginx-ingress-controller/). [Examples](https://docs.nginx.com/nginx-ingress-controller/configuration/configuration-examples/). |
147-
| Edge/Nightly | For testing and experimenting | Use the edge or nightly images from [DockerHub](https://hub.docker.com/r/nginx/nginx-ingress/), [GitHub Container](https://github.com/nginx/kubernetes-ingress/pkgs/container/kubernetes-ingress), [Amazon ECR Public Gallery](https://gallery.ecr.aws/nginx/nginx-ingress) or [Quay.io](https://quay.io/repository/nginx/nginx-ingress) or [build your own image](https://docs.nginx.com/nginx-ingress-controller/installation/build-nginx-ingress-controller/). | [Build your own image](https://docs.nginx.com/nginx-ingress-controller/installation/build-nginx-ingress-controller/). | [Manifests](https://github.com/nginx/kubernetes-ingress/tree/main/deployments). [Helm chart](https://github.com/nginx/kubernetes-ingress/tree/main/charts/nginx-ingress). | [Documentation](https://docs.nginx.com/nginx-ingress-controller). [Examples](https://github.com/nginx/kubernetes-ingress/tree/main/examples). |
146+
| Latest stable release | For production use | Use the 5.2.1 images from [DockerHub](https://hub.docker.com/r/nginx/nginx-ingress/), [GitHub Container](https://github.com/nginx/kubernetes-ingress/pkgs/container/kubernetes-ingress), [Amazon ECR Public Gallery](https://gallery.ecr.aws/nginx/nginx-ingress) or [Quay.io](https://quay.io/repository/nginx/nginx-ingress) or [build your own image](https://docs.nginx.com/nginx-ingress-controller/install/build/). | Use the 5.2.1 images from the [F5 Container Registry](https://docs.nginx.com/nginx-ingress-controller/install/images/registry-download/) or [Build your own image](https://docs.nginx.com/nginx-ingress-controller/install/build). | [Manifests](https://github.com/nginx/kubernetes-ingress/tree/v5.2.1/deployments). [Helm chart](https://github.com/nginx/kubernetes-ingress/tree/v5.2.1/charts/nginx-ingress). | [Documentation](https://docs.nginx.com/nginx-ingress-controller/). [Examples](https://docs.nginx.com/nginx-ingress-controller/configuration/configuration-examples/). |
147+
| Edge/Nightly | For testing and experimenting | Use the edge or nightly images from [DockerHub](https://hub.docker.com/r/nginx/nginx-ingress/), [GitHub Container](https://github.com/nginx/kubernetes-ingress/pkgs/container/kubernetes-ingress), [Amazon ECR Public Gallery](https://gallery.ecr.aws/nginx/nginx-ingress) or [Quay.io](https://quay.io/repository/nginx/nginx-ingress) or [build your own image](https://docs.nginx.com/nginx-ingress-controller/install/build/). | [Build your own image](https://docs.nginx.com/nginx-ingress-controller/install/build/). | [Manifests](https://github.com/nginx/kubernetes-ingress/tree/main/deployments). [Helm chart](https://github.com/nginx/kubernetes-ingress/tree/main/charts/nginx-ingress). | [Documentation](https://docs.nginx.com/nginx-ingress-controller). [Examples](https://github.com/nginx/kubernetes-ingress/tree/main/examples). |
148148

149149
## SBOM (Software Bill of Materials)
150150

build/README.md

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

3-
For instructions, read the [Build NGINX Ingress Controller](https://docs.nginx.com/nginx-ingress-controller/installation/build-nginx-ingress-controller/) documentation.
3+
For instructions, read the [Build NGINX Ingress Controller](https://docs.nginx.com/nginx-ingress-controller/install/build) documentation.

charts/nginx-ingress/README.md

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

3-
Please refer to the [Installation with Helm](https://docs.nginx.com/nginx-ingress-controller/installation/installing-nic/installation-with-helm/) guide in the NGINX Ingress Controller documentation site.
3+
Please refer to the [Installation with Helm](https://docs.nginx.com/nginx-ingress-controller/install/helm/) guide in the NGINX Ingress Controller documentation site.

charts/nginx-ingress/templates/NOTES.txt

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,12 +2,12 @@ NGINX Ingress Controller {{ .Chart.AppVersion }} has been installed.
22

33
For release notes for this version please see: https://docs.nginx.com/nginx-ingress-controller/releases/
44

5-
Installation and upgrade instructions: https://docs.nginx.com/nginx-ingress-controller/installation/installing-nic/installation-with-helm/
5+
Installation and upgrade instructions: https://docs.nginx.com/nginx-ingress-controller/install/helm/
66

77
{{ if .Release.IsUpgrade -}}
88
If you are upgrading from a version of the chart that uses older Custom Resource Definitions (CRD) it is necessary to manually upgrade the CRDs as this is not managed by Helm.
99
To update to the latest version of the CRDs:
1010
$ kubectl apply -f https://raw.githubusercontent.com/nginx/kubernetes-ingress/v{{ .Chart.AppVersion }}/deploy/crds.yaml
1111

12-
More details on upgrading the CRDs: https://docs.nginx.com/nginx-ingress-controller/installation/installing-nic/installation-with-helm/#upgrading-the-crds
12+
More details on upgrading the CRDs: https://docs.nginx.com/nginx-ingress-controller/install/helm#upgrading-the-crds
1313
{{- end -}}

deployments/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
# Installation
22

33
This folder includes Kubernetes manifests for installing NGINX or NGINX Plus Ingress Controller. Read [the installation
4-
instructions](https://docs.nginx.com/nginx-ingress-controller/installation/).
4+
instructions](https://docs.nginx.com/nginx-ingress-controller/install/).

examples/custom-resources/advanced-routing/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ example, for which we have introduced the following changes:
1313

1414
## Prerequisites
1515

16-
1. Follow the [installation](https://docs.nginx.com/nginx-ingress-controller/installation/installation-with-manifests/)
16+
1. Follow the [installation](https://docs.nginx.com/nginx-ingress-controller/install/manifests)
1717
instructions to deploy the Ingress Controller with custom resources enabled.
1818
1. Save the public IP address of the Ingress Controller into a shell variable:
1919

examples/custom-resources/api-key/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ a web application, configure load balancing for it via a VirtualServer, and appl
66

77
## Prerequisites
88

9-
1. Follow the [installation](https://docs.nginx.com/nginx-ingress-controller/installation/installation-with-manifests/) instructions to deploy the Ingress Controller.
9+
1. Follow the [installation](https://docs.nginx.com/nginx-ingress-controller/install/manifests) instructions to deploy the Ingress Controller.
1010
1. Save the public IP address of the Ingress Controller into a shell variable:
1111

1212
```console

0 commit comments

Comments
 (0)