chore(docs): add mkdocs-macros plugin #5412
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
k8s-ci-robot
added
the
cncf-cla: yes
k8s-ci-robot
added
the
size/XL
ivankatliarchuk
force-pushed
the
docs-mkdocs-macros
branch
2 times, most recently
from
6b450e1 to
253ff73
Compare
|
/label tide/merge-method-squash |
k8s-ci-robot
added
the
tide/merge-method-squash
ivankatliarchuk
force-pushed
the
docs-mkdocs-macros
branch
from
253ff73 to
7c6f26b
Compare
mloiseleur
reviewed
May 19, 2025
Co-authored-by: Michel Loiseleur <[email protected]>
Signed-off-by: ivan katliarchuk <[email protected]>
k8s-ci-robot
added
the
lgtm
|
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: mloiseleur 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 |
k8s-ci-robot
added
the
approved
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.
Description
Added a mkdocs plugin, that helps to capture snippets in single folder, this should simplify user experience, and no need to browse all the documents.
benefits for adding plugin
.mdpage, which is adds complexityThe idea is taken from external secrets operator . The only different they have a flat structure https://github.com/external-secrets/external-secrets/tree/main/docs/snippets. I have no preference on structure
Examples (validated is working)
updated docs
example failed yml/json validator (we could ofcourse exlude it if required)
Checklist