-
Notifications
You must be signed in to change notification settings - Fork 13
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.
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
Add cascade and param info to Front Matter and Shortcodes topics #404
Conversation
Overall readability score: 60.85 (🟢 +0.02)
View detailed metrics🟢 - Shows an increase in readability
Averages:
View metric targets
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Nice! I like this a lot. The cascade
documentation is a useful subset of the Hugo docs. There are alternative forms of cascading front matter that can selectively target a page but I think keeping to this single form is valuable because it keeps things simple.
The `param` shortcode in the topic body text: | ||
|
||
```markdown | ||
Welcome to Grafana {{</* param PRODUCT_VERSION */>}}! Read on to learn about changes to dashboards and visualizations, data sources, security and authentication, and more. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I don't think we should have exclamations in examples since they are discouraged by the style guide.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I copied this direct from the published docs :-) I'll remove it here.
I saw that when I was reading up on cascade. I see it's also used for labels. I only documented the variable... thinking we could expand on this section as we need. |
This PR adds
cascade
andparam
info to Front Matter and shortcodes topics in the Writer's Toolkit