Update docs/shared shortcode usage to use keyword argument interface
#4921
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
Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
|
I'm opening this PR to see how CI handles this given that the image in use in CI has the old Once the quirks are resolved here, I will open up the PRs to change all the older versions. |
clayton-cornell
approved these changes
Aug 28, 2023
jdbaldry
changed the title
docs/shared shortcodedocs/shared shortcode usage to use keyword argument interface
jdbaldry
changed the title
docs/shared shortcode usage to use keyword argument interfacedocs/shared shortcode usage to use keyword argument interface
jdbaldry
added a commit
that referenced
this pull request
Aug 31, 2023
#4921) (#5041) * Use updated version inference in all Agent docs Signed-off-by: Jack Baldry <jack.baldry@grafana.com> * Fix doc/shared lookup path Signed-off-by: Jack Baldry <jack.baldry@grafana.com> --------- Signed-off-by: Jack Baldry <jack.baldry@grafana.com> (cherry picked from commit 1e6dc88) Co-authored-by: Jack Baldry <jack.baldry@grafana.com>
github-actions
bot
added
the
frozen-due-to-age
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
Previously, an empty version was inferred from the relative permalink for the page. Although the behavior was similar to the other version inference done in shortcodes like
docs/reference, it did not allow specifying an empty version needed to include content from unversioned documentation.For consistency with other shortcodes like
docs/reference, thedocs/sharedshortcode version lookup has been replaced with the following behavior:version="", use an empty version.version="<SOMETHING VERSION>, use version inference as described in https://grafana.com/docs/writers-toolkit/write/shortcodes/#docsreference-shortcode:~:text=The%20path%20to,becomes%20GRAFANA%20CLOUD..version="ANYTHING ELSE", use that literal value.