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.

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

Jump to bottom
Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

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

wants to merge 1 commit into from

Conversation

marcel2012
Copy link
Contributor

What this PR does / why we need it:

This PR upgrades mkdocs version and fixes broken links.

 % make live-docs
...
INFO    -  DeprecationWarning: 'materialx.emoji.twemoji' is deprecated.
           Material emoji logic has been officially moved into mkdocs-material
           version 9.4. Please use Material's 'material.extensions.emoji.twemoji'
           instead of 'materialx.emoji.twemoji' in your 'mkdocs.yml' file.

           ```
           markdown_extensions:
             - pymdownx.emoji:
                 emoji_index: !!python/name:material.extensions.emoji.twemoji
                 emoji_generator: !!python/name:material.extensions.emoji.to_svg
           ```

           'mkdocs_material_extensions' is deprecated and will no longer be
           supported moving forward. This is the last release.

             File "/usr/local/lib/python3.11/site-packages/materialx/emoji.py", line 118, in twemoji
               return _patch_index(options)
             File "/usr/local/lib/python3.11/site-packages/materialx/emoji.py", line 68, in _deprecated_func
               warnings.warn(
WARNING -  Material emoji logic has been officially moved into mkdocs-material
           version 9.4. Please use Material's 'material.extensions.emoji.twemoji'
           instead of 'materialx.emoji.twemoji' in your 'mkdocs.yml' file.

           ```
           markdown_extensions:
             - pymdownx.emoji:
                 emoji_index: !!python/name:material.extensions.emoji.twemoji
                 emoji_generator: !!python/name:material.extensions.emoji.to_svg
           ```

           'mkdocs_material_extensions' is deprecated and will no longer be
           supported moving forward. This is the last release.
...
INFO    -  Doc file 'index.md' contains an unrecognized relative link './deploy/', it was left as is. Did you mean 'deploy/index.md'?
INFO    -  Doc file 'lua_tests.md' contains an unrecognized relative link '../rootfs/etc/nginx/lua/test', it was left as is.
INFO    -  Doc file 'examples/index.md' contains an unrecognized relative link '../#faq-migration-to-apiversion-networkingk8siov1', it was left as is. Did you mean
           '../index.md#faq-migration-to-apiversion-networkingk8siov1'?
INFO    -  Doc file 'examples/customization/custom-errors/README.md' contains an unrecognized relative link '../../../deploy/', it was left as is. Did you mean '../../../deploy/index.md'?
INFO    -  Doc file 'examples/customization/jwt/README.md' contains an unrecognized relative link '../custom-configuration/', it was left as is. Did you mean '../custom-configuration/README.md'?
INFO    -  Doc file 'examples/rewrite/README.md' contains an unrecognized relative link '../../deploy/', it was left as is. Did you mean '../../deploy/index.md'?
INFO    -  Doc file 'examples/static-ip/README.md' contains an unrecognized relative link '../../deploy/', it was left as is. Did you mean '../../deploy/index.md'?
INFO    -  Doc file 'user-guide/custom-errors.md' contains an unrecognized relative link '../../examples/customization/custom-errors', it was left as is. Did you mean
           '../examples/customization/custom-errors/README.md'?
INFO    -  Doc file 'deploy/index.md' contains a link '#running-on-Kubernetes-versions-older-than-1.19', but there is no such anchor on this page.
INFO    -  Doc file 'deploy/baremetal.md' contains a link './index.md#bare-metal', but the doc 'deploy/index.md' does not contain an anchor '#bare-metal'.
...

Types of changes

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • CVE Report (Scanner found CVE and adding report)
  • Breaking change (fix or feature that would cause existing functionality to change)
  • Documentation only

Which issue/s this PR fixes

How Has This Been Tested?

make live-docs command and manual tests

Checklist:

  • My change requires a change to the documentation.
  • I have updated the documentation accordingly.
  • I've read the CONTRIBUTION guide
  • I have added unit and/or e2e tests to cover my changes.
  • All new and existing tests passed.

@netlify Netlify
Copy link

netlify bot commented Aug 10, 2025 •
edited
Loading

✅ Deploy Preview for kubernetes-ingress-nginx ready!

Name Link
🔨 Latest commit 597864c
🔍 Latest deploy log https://app.netlify.com/projects/kubernetes-ingress-nginx/deploys/689916d61b841800086c6f20
😎 Deploy Preview https://deploy-preview-13741--kubernetes-ingress-nginx.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by: marcel2012
Once this PR has been reviewed and has the lgtm label, please assign tao12345666333 for approval. For more information see the Code Review Process.

The full list of commands accepted by this bot can be found here.

Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@k8s-ci-robot k8s-ci-robot added area/docs cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. labels Aug 10, 2025
@k8s-ci-robot
Copy link
Contributor

This issue is currently awaiting triage.

If Ingress contributors determines this is a relevant issue, they will accept it by applying the triage/accepted label and provide further guidance.

The triage/accepted label can be added by org members by writing /triage accepted in a comment.

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository.

@k8s-ci-robot k8s-ci-robot added the needs-triage Indicates an issue or PR lacks a `triage/foo` label and requires one. label Aug 10, 2025
@marcel2012 marcel2012 changed the title Docs: Bump mkdocs to v9.6.16, fix links Docs: Bump mkdocs to v9.6.16, fix links. Aug 10, 2025
@k8s-ci-robot k8s-ci-robot added needs-kind Indicates a PR lacks a `kind/foo` label and requires one. needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. labels Aug 10, 2025
@k8s-ci-robot
Copy link
Contributor

Hi @marcel2012. Thanks for your PR.

I'm waiting for a kubernetes member to verify that this patch is reasonable to test. If it is, they should reply with /ok-to-test on its own line. Until that is done, I will not automatically test new commits in this PR, but the usual testing commands by org members will still work. Regular contributors should join the org to skip this step.

Once the patch is verified, the new status will be reflected by the ok-to-test label.

I understand the commands that are listed here.

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository.

@k8s-ci-robot k8s-ci-robot added needs-priority size/M Denotes a PR that changes 30-99 lines, ignoring generated files. labels Aug 10, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@Gacko Gacko Awaiting requested review from Gacko

@tao12345666333 tao12345666333 Awaiting requested review from tao12345666333

Assignees
No one assigned
Labels
area/docs cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. needs-kind Indicates a PR lacks a `kind/foo` label and requires one. needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. needs-priority needs-triage Indicates an issue or PR lacks a `triage/foo` label and requires one. size/M Denotes a PR that changes 30-99 lines, ignoring generated files.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@marcel2012 @k8s-ci-robot