Skip to content

Commit 0dc4f03

Browse files
authored
docs: Fix several MkDocs info and warning messages (#3663)
* 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 #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.
1 parent d62f3bd commit 0dc4f03

File tree

2 files changed

+19
-15
lines changed

2 files changed

+19
-15
lines changed

mkdocs.yml

Lines changed: 17 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,8 @@ repo_url: https://github.com/kubernetes-sigs/gateway-api
33
repo_name: kubernetes-sigs/gateway-api
44
site_dir: site
55
docs_dir: site-src
6-
trademark: https://www.linuxfoundation.org/legal/trademark-usage
6+
extra:
7+
trademark: https://www.linuxfoundation.org/legal/trademark-usage
78
extra_css:
89
- stylesheets/extra.css
910
extra_javascript:
@@ -52,8 +53,8 @@ markdown_extensions:
5253
- admonition
5354
- meta
5455
- pymdownx.emoji:
55-
emoji_index: !!python/name:materialx.emoji.twemoji
56-
emoji_generator: !!python/name:materialx.emoji.to_svg
56+
emoji_index: !!python/name:material.extensions.emoji.twemoji
57+
emoji_generator: !!python/name:material.extensions.emoji.to_svg
5758
- pymdownx.details
5859
- pymdownx.highlight
5960
- pymdownx.inlinehilite
@@ -70,17 +71,17 @@ nav:
7071
- Overview:
7172
- Introduction: index.md
7273
- Concepts:
73-
API Overview: concepts/api-overview.md
74-
Conformance: concepts/conformance.md
75-
Roles and Personas: concepts/roles-and-personas.md
76-
Security Model: concepts/security-model.md
77-
Tools: concepts/tooling.md
78-
Use Cases: concepts/use-cases.md
79-
Versioning: concepts/versioning.md
74+
- API Overview: concepts/api-overview.md
75+
- Conformance: concepts/conformance.md
76+
- Roles and Personas: concepts/roles-and-personas.md
77+
- Security Model: concepts/security-model.md
78+
- Tools: concepts/tooling.md
79+
- Use Cases: concepts/use-cases.md
80+
- Versioning: concepts/versioning.md
8081
- Service Mesh:
81-
Overview: mesh/index.md
82-
GAMMA Initiative: mesh/gamma.md
83-
Service Facets: mesh/service-facets.md
82+
- Overview: mesh/index.md
83+
- GAMMA Initiative: mesh/gamma.md
84+
- Service Facets: mesh/service-facets.md
8485
- Implementations:
8586
- List: implementations.md
8687
- Comparisons:
@@ -180,3 +181,6 @@ nav:
180181
- Enhancement Requests: contributing/enhancement-requests.md
181182
- Release Cycle: contributing/release-cycle.md
182183
- Contributor Ladder: contributing/contributor-ladder.md
184+
not_in_nav: |
185+
/blog/*
186+
/geps/gep-696/*

site-src/overrides/partials/copyright.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -22,10 +22,10 @@
2222

2323
<!-- Copyright and theme information -->
2424
<div class="md-copyright">
25-
{% if config.trademark %}
25+
{% if config.extra.trademark %}
2626
<p>
2727
The Linux Foundation has registered trademarks and uses trademarks. For a list of trademarks of The Linux Foundation,
28-
please see our <a href="{{ config.trademark }}">Trademark Usage page</a>.
28+
please see our <a href="{{ config.extra.trademark }}">Trademark Usage page</a>.
2929
</p>
3030
{% endif %}
3131
{% if not config.extra.generator == false %}

0 commit comments

Comments
 (0)