Skip to content

Commit 2f0cb58

Browse files
authored
fix markdown linter issues (#7822)
Signed-off-by: Jakub Jarosz <[email protected]>
1 parent b56b714 commit 2f0cb58

File tree

6 files changed

+12
-15
lines changed

6 files changed

+12
-15
lines changed

CHANGELOG.md

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -691,8 +691,7 @@ CHANGES:
691691
`redirect-to-https` and `ssl-redirect` ConfigMap keys no longer have any effect on generated configs for VirtualServer
692692
resources.
693693
- [745](https://github.com/nginx/kubernetes-ingress/pull/745): Improve routing rules. Update the spec of
694-
VirtualServer and VirtualServerRoute accordingly. See YAML examples of the changes
695-
[here](https://github.com/nginx/kubernetes-ingress/pull/745).
694+
VirtualServer and VirtualServerRoute accordingly. See [YAML examples of the changes](https://github.com/nginx/kubernetes-ingress/pull/745).
696695
- [710](https://github.com/nginx/kubernetes-ingress/pull/710): Run IC as non-root. Make sure to use the updated
697696
manifests to install/upgrade the Ingress Controller.
698697
- [603](https://github.com/nginx/kubernetes-ingress/pull/603): Update apiVersion in Deployments and DaemonSets to
@@ -1095,7 +1094,7 @@ CHANGES:
10951094
- [399](https://github.com/nginx/kubernetes-ingress/pull/399): Improve secret handling. **Note**: the PR changed how
10961095
the Ingress Controller processes Ingress resources with TLS termination enabled but without any referenced (or with
10971096
invalid) secrets and Ingress resources with JWT validation enabled but without any referenced (or with invalid) JWK.
1098-
Please read [here](https://github.com/nginx/kubernetes-ingress/pull/399) for more details.
1097+
Please [read here](https://github.com/nginx/kubernetes-ingress/pull/399) for more details.
10991098
- [357](https://github.com/nginx/kubernetes-ingress/pull/357): Improve Project Layout and Refactor Controller
11001099
Package. **Note**: the PR significantly changed the layout of the project to follow best practices.
11011100
- [347](https://github.com/nginx/kubernetes-ingress/pull/347): Use edge version in manifests and Helm chart.
@@ -1262,8 +1261,8 @@ UPGRADE:
12621261
- [166](https://github.com/nginx/kubernetes-ingress/pull/166): Watch Secret resources for updates. **Note**: If a
12631262
Secret referenced by one or more Ingress resources becomes invalid or gets removed, the configuration for those
12641263
Ingress resources will be disabled until there is a valid Secret.
1265-
- [160](https://github.com/nginx/kubernetes-ingress/pull/160): Add support for events. See the details
1266-
[here](https://github.com/nginx/kubernetes-ingress/pull/160).
1264+
- [160](https://github.com/nginx/kubernetes-ingress/pull/160): Add support for events.
1265+
See [the details here](https://github.com/nginx/kubernetes-ingress/pull/160).
12671266
- [157](https://github.com/nginx/kubernetes-ingress/pull/157): Add graceful termination - when the Ingress Controller
12681267
receives `SIGTERM`, it shutdowns itself as well as NGINX, using `nginx -s quit`.
12691268

CONTRIBUTING.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -76,7 +76,7 @@ fill in the template as provided.
7676

7777
### F5 Contributor License Agreement (CLA)
7878

79-
F5 requires all external contributors to agree to the terms of the F5 CLA (available [here](https://github.com/f5/.github/blob/main/CLA/cla-markdown.md))
79+
F5 requires all external contributors to agree to [the terms of the F5 CLA](https://github.com/f5/.github/blob/main/CLA/cla-markdown.md))
8080
before any of their changes can be incorporated into an F5 Open Source repository.
8181

8282
If you have not yet agreed to the F5 CLA terms and submit a PR to this repository, a bot will prompt you to view and

deployments/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
# Installation
22

3-
This folder includes Kubernetes manifests for installing NGINX or NGINX Plus Ingress Controller. Read the installation
4-
instructions [here](https://docs.nginx.com/nginx-ingress-controller/installation/).
3+
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/).

examples/custom-resources/oidc/README.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -57,16 +57,15 @@ kubectl apply -f webapp.yaml
5757

5858
To set up Keycloak:
5959

60-
1. Follow the steps in the "Configuring Keycloak" section of the documentation
61-
[here](https://docs.nginx.com/nginx/deployment-guides/single-sign-on/keycloak/#configuring-keycloak):
60+
1. Follow the steps in the "Configuring Keycloak" [section of the documentation](https://docs.nginx.com/nginx/deployment-guides/single-sign-on/keycloak/#configuring-keycloak):
6261
1. To connect to Keycloak, use `https://keycloak.example.com`.
6362
1. Make sure to save the client secret for NGINX-Plus client to the `SECRET` shell variable:
6463

6564
```console
6665
SECRET=value
6766
```
6867

69-
1. Alternatively, execute the commands [here](./keycloak_setup.md).
68+
1. Alternatively, [execute the commands](./keycloak_setup.md).
7069

7170
## Step 5 - Deploy the Client Secret
7271

examples/ingress-resources/daemon-set/README.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,5 +3,4 @@
33
You can deploy the NGINX or NGINX Plus controller as a [Daemon Set](https://kubernetes.io/docs/admin/daemons/). This
44
allows you to deploy the controller on all or select nodes of your cluster.
55

6-
Read the installation instructions
7-
[here](https://docs.nginx.com/nginx-ingress-controller/installation/installation-with-manifests/).
6+
Read [the installation instructions](https://docs.nginx.com/nginx-ingress-controller/installation/installation-with-manifests/).
Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
# RBAC
22

33
It is possible to run the Ingress Controller in a cluster with
4-
[RBAC](https://kubernetes.io/docs/admin/authorization/rbac/) enabled. Read the installation instructions
5-
[here](https://docs.nginx.com/nginx-ingress-controller/installation/installation-with-manifests/).
4+
[RBAC](https://kubernetes.io/docs/admin/authorization/rbac/) enabled.
5+
Read the [installation instructions](https://docs.nginx.com/nginx-ingress-controller/installation/installation-with-manifests/).

0 commit comments

Comments
 (0)