docs: backlinks from example manifests to guides #1177
Merged
Conversation
This file contains 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
We would like our example YAML files to include comments that do not show up in the guides where the files are used as jinja templates, while still ensuring they are valid YAML files. Configuring the jinja Environment with "line_comment_prefix" allows you to control the syntax of the jinja comment directive. If we set that to "##", then such lines are ommitted during jinja templating, and are treated as YAML comments. See also https://jinja.palletsprojects.com/en/2.11.x/templates/#line-statements
Add Jinja "line comments" to our example manifests which reference the
guides which use them.
Generated using this awfulness:
$ sed -i '1s/^/## Used in:\n/' $( \
for iii in $(git grep -l '{% include' site-src/); do \
awk -F "'" '/{% include/ { print "examples/"$2 }' $iii ; \
done | sort | uniq)
$ for iii in $(git grep -l '{% include' site-src/); do \
for jjj in $(awk -F "'" '/{% include/ { print "examples/"$2 }' $iii); do \
sed -i "2s|^|## - $iii\n|" $jjj; \
done; \
done
Co-authored-by: Mark McLoughlin <[email protected]>
k8s-ci-robot
added
kind/documentation
|
This is brilliant, thanks @markmc! I'd love to see some automation around adding these comments in the future, but this is already a great upgrade as is. /lgtm |
k8s-ci-robot
added
the
lgtm
|
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: markmc, 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 |
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.
Fixes #446
Based on #1083
We would like our example YAML files to include comments that do not show up in the guides where the files are used as jinja templates, while still ensuring they are valid YAML files.
Configuring the jinja Environment with "line_comment_prefix" allows you to control the syntax of the jinja comment directive. If we set that to "##", then such lines are ommitted during jinja templating, and are treated as YAML comments.
See also https://jinja.palletsprojects.com/en/2.11.x/templates/#line-statements
Generated the comments using this awfulness:
/kind documentation