docs: Fix several MkDocs info and warning messages #3663
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This commit fixes the informational message logged by MkDocs due to an incorrect format in the nav parameter. > Config value 'nav': Expected nav to be a list, got dict with keys...
This commit resolves the following informational from MkDocs that was being logged due to the previous extensions no longer being supported. 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.
PR kubernetes-sigs#3132 (commit 8285041) introduced a trademark disclaimer to the website's footer, storing the trademark URL in MkDocs config under the key `config.trademark`. This is not a valid MkDocs configuration parameter and causes the following warning to be logged when building the site. WARNING - Config value 'trademark': Unrecognised configuration name: trademark The correct place to store custom configuration is under the `extra` key [1] in MkDoc's configuration. This commit relocates `trademark` parameter to resolve the configuration warning. [1]: https://www.mkdocs.org/user-guide/configuration/#extra
MkDocs currently logs an informational message stating that files under the blog/ and gep-696/ (GEP template) paths are not present in the site's navigation. The following pages exist in the docs directory, but are not included in the "nav" configuration: This commit adds MkDocs's `not_in_nav` configuration parameter to specify that these paths are intentionally excluded from the site's navigation.
|
Hi @blake. Thanks for your PR. I'm waiting for a kubernetes-sigs member to verify that this patch is reasonable to test. If it is, they should reply with Once the patch is verified, the new status will be reflected by the 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. |
|
Thanks @blake! /lgtm |
|
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: blake, robscott The full list of commands accepted by this bot can be found here. The pull request process is described here
Needs approval from an approver in each of these files:
Approvers can indicate their approval by writing |
gcs278
added a commit
to gcs278/gateway-api
that referenced
this pull request
Mar 9, 2025
The mkdocs-material-extensions package is now deprecated, and it's usage in mkdocs.yaml was removed in kubernetes-sigs#3663. This fix also removes it from requirements.txt to prevent unnecessary installation.
k8s-ci-robot
pushed a commit
that referenced
this pull request
Mar 10, 2025
The mkdocs-material-extensions package is now deprecated, and it's usage in mkdocs.yaml was removed in #3663. This fix also removes it from requirements.txt to prevent unnecessary installation.
EyalPazz
pushed a commit
to EyalPazz/gateway-api
that referenced
this pull request
Mar 18, 2025
) * docs: Fix nav error in mkdocs.yml This commit fixes the informational message logged by MkDocs due to an incorrect format in the nav parameter. > Config value 'nav': Expected nav to be a list, got dict with keys... * docs: Update pymdownx.emoji extensions This commit resolves the following informational from MkDocs that was being logged due to the previous extensions no longer being supported. 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. * docs: Fix warning for invalid 'trademark' config PR kubernetes-sigs#3132 (commit 8285041) introduced a trademark disclaimer to the website's footer, storing the trademark URL in MkDocs config under the key `config.trademark`. This is not a valid MkDocs configuration parameter and causes the following warning to be logged when building the site. WARNING - Config value 'trademark': Unrecognised configuration name: trademark The correct place to store custom configuration is under the `extra` key [1] in MkDoc's configuration. This commit relocates `trademark` parameter to resolve the configuration warning. [1]: https://www.mkdocs.org/user-guide/configuration/#extra * docs: Ignore certain files from nav config MkDocs currently logs an informational message stating that files under the blog/ and gep-696/ (GEP template) paths are not present in the site's navigation. The following pages exist in the docs directory, but are not included in the "nav" configuration: This commit adds MkDocs's `not_in_nav` configuration parameter to specify that these paths are intentionally excluded from the site's navigation.
EyalPazz
pushed a commit
to EyalPazz/gateway-api
that referenced
this pull request
Mar 18, 2025
…igs#3666) The mkdocs-material-extensions package is now deprecated, and it's usage in mkdocs.yaml was removed in kubernetes-sigs#3663. This fix also removes it from requirements.txt to prevent unnecessary installation.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What type of PR is this?
/kind documentation
What this PR does / why we need it:
This PR contains several commits that resolve info and warning messages that are currently being logged by MkDocs when building the site.
More information about these changes can be found in the commit message for each commit.
Which issue(s) this PR fixes:
Fixes #
Does this PR introduce a user-facing change?: