Skip to content

Docs: Bump mkdocs to v9.6.16, fix links. #13741

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 1 commit into from
Aug 11, 2025
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 .github/actions/mkdocs/Dockerfile
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
FROM squidfunk/mkdocs-material:9.4.5
FROM squidfunk/mkdocs-material:9.6.16

COPY action.sh /action.sh

Expand Down
2 changes: 1 addition & 1 deletion docs/deploy/baremetal.md
Original file line number Diff line number Diff line change
Expand Up @@ -261,7 +261,7 @@ for generating redirect URLs that take into account the URL used by external cli
Location: https://myapp.example.com/ #-> missing NodePort in HTTPS redirect
```

[install-baremetal]: ./index.md#bare-metal
[install-baremetal]: ./index.md#bare-metal-clusters
[install-quickstart]: ./index.md#quick-start
[nodeport-def]: https://kubernetes.io/docs/concepts/services-networking/service/#type-nodeport
[nodeport-nat]: https://kubernetes.io/docs/tutorials/services/source-ip/#source-ip-for-services-with-type-nodeport
Expand Down
2 changes: 1 addition & 1 deletion docs/deploy/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -100,7 +100,7 @@ kubectl apply -f https://raw.githubusercontent.com/kubernetes/ingress-nginx/cont
resources as if you had used Helm to install the controller.

!!! attention
If you are running an old version of Kubernetes (1.18 or earlier), please read [this paragraph](#running-on-Kubernetes-versions-older-than-1.19) for specific instructions.
If you are running an old version of Kubernetes (1.18 or earlier), please read [this paragraph](#running-on-kubernetes-versions-older-than-119) for specific instructions.
Because of api deprecations, the default manifest may not work on your cluster.
Specific manifests for supported Kubernetes versions are available within a sub-folder of each provider.

Expand Down
2 changes: 1 addition & 1 deletion docs/examples/customization/custom-errors/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ If you do not already have an instance of the Ingress-Nginx Controller running,
The `ingress-nginx` Service is of type `ClusterIP` in this example. This may vary depending on your environment.
Make sure you can use the Service to reach NGINX before proceeding with the rest of this example.

[deploy]: ../../../deploy/
[deploy]: ../../../deploy/index.md

## Testing error pages

Expand Down
2 changes: 1 addition & 1 deletion docs/examples/customization/jwt/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,4 +45,4 @@ data:
```

References:
* [Custom Configuration](../custom-configuration/)
* [Custom Configuration](../custom-configuration/README.md)
2 changes: 1 addition & 1 deletion docs/examples/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ Please review the [prerequisites](PREREQUISITES.md) before trying them.

The examples on these pages include the `spec.ingressClassName` field which replaces the deprecated `kubernetes.io/ingress.class: nginx` annotation. Users of ingress-nginx < 1.0.0 (Helm chart < 4.0.0) should use the [legacy documentation](https://github.com/kubernetes/ingress-nginx/tree/legacy/docs/examples).

For more information, check out the [Migration to apiVersion networking.k8s.io/v1](../#faq-migration-to-apiversion-networkingk8siov1) guide.
For more information, check out the [Migration to apiVersion networking.k8s.io/v1](../user-guide/k8s-122-migration.md) guide.

Category | Name | Description | Complexity Level
---------| ---- | ----------- | ----------------
Expand Down
2 changes: 1 addition & 1 deletion docs/examples/rewrite/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ This example demonstrates how to use `Rewrite` annotations.

You will need to make sure your Ingress targets exactly one Ingress
controller by specifying the [ingress.class annotation](../../user-guide/multiple-ingress.md),
and that you have an ingress controller [running](../../deploy/) in your cluster.
and that you have an ingress controller [running](../../deploy/index.md) in your cluster.

## Deployment

Expand Down
2 changes: 1 addition & 1 deletion docs/examples/static-ip/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ This example demonstrates how to assign a static-ip to an Ingress on through the
You need a [TLS cert](../PREREQUISITES.md#tls-certificates) and a [test HTTP service](../PREREQUISITES.md#test-http-service) for this example.
You will also need to make sure your Ingress targets exactly one Ingress
controller by specifying the [ingress.class annotation](../../user-guide/multiple-ingress.md),
and that you have an ingress controller [running](../../deploy/) in your cluster.
and that you have an ingress controller [running](../../deploy/index.md) in your cluster.

## Acquiring an IP

Expand Down
2 changes: 1 addition & 1 deletion docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,5 +8,5 @@ You can learn more about using [Ingress](https://kubernetes.io/docs/concepts/ser

# Getting Started

See [Deployment](./deploy/) for a whirlwind tour that will get you started.
See [Deployment](./deploy/index.md) for a whirlwind tour that will get you started.

2 changes: 1 addition & 1 deletion docs/lua_tests.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ installations besides docker

## Where are the Lua Tests?

Lua Tests can be found in the [rootfs/etc/nginx/lua/test](../rootfs/etc/nginx/lua/test) directory
Lua Tests can be found in the [rootfs/etc/nginx/lua/test](https://github.com/kubernetes/ingress-nginx/tree/main/rootfs/etc/nginx/lua/test) directory


[1]: https://openresty.org/en/installation.html
8 changes: 4 additions & 4 deletions docs/requirements.txt
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
mkdocs-material==9.4.5
mkdocs-awesome-pages-plugin==2.9.2
mkdocs-minify-plugin==0.7.1
mkdocs-redirects==1.2.1
mkdocs-material==9.6.16
mkdocs-awesome-pages-plugin==2.10.1
mkdocs-minify-plugin==0.8.0
mkdocs-redirects==1.2.2
2 changes: 1 addition & 1 deletion docs/user-guide/custom-errors.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,4 +28,4 @@ See also the [Custom errors][example-custom-errors] example.

[cm-custom-http-errors]: ./nginx-configuration/configmap.md#custom-http-errors
[img-custom-error-pages]: https://github.com/kubernetes/ingress-nginx/tree/main/images/custom-error-pages
[example-custom-errors]: ../../examples/customization/custom-errors
[example-custom-errors]: ../examples/customization/custom-errors/README.md
2 changes: 1 addition & 1 deletion mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ markdown_extensions:
- pymdownx.critic
- pymdownx.details
- pymdownx.emoji:
emoji_index: !!python/name:materialx.emoji.twemoji
emoji_index: !!python/name:material.extensions.emoji.twemoji
emoji_generator: !!python/name:materialx.emoji.to_svg
- pymdownx.highlight
- pymdownx.inlinehilite
Expand Down