Replace docs/reference shortcode with ref URIs #6880
Closed
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
jdbaldry
force-pushed
the
jdb/2024-04-use-ref-uris
branch
from
4823208
to
817be06
Compare
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.
You can use
refURIs in admonitions (or any shortcodes) because they are inline and not subject to the issues noted in theadmonitionshortcode.The
refURIs perform the same pattern matching asdocs/referencebut don't require the use of reference-style links and the destinations are ordinary (full) URLs that can include version substitution. Unlikedocs/reference, the implementation doesn't userelrefso you don't have to be careful with omitting trailing slashes and the links will follow redirects.Documentation: https://grafana.com/docs/writers-toolkit/write/links/#link-from-source-content-thats-used-in-multiple-projects
Signed-off-by: Jack Baldry [email protected]