Skip to content
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

[docs/sources/datasources] Replace docs/reference shortcode with ref URIs #88078

Merged
merged 5 commits into from
May 28, 2024

Conversation

jdbaldry
Copy link
Member

You can use ref URIs in admonitions (or any shortcodes) because they are inline and not subject to the issues noted in the admonition shortcode.

The ref URIs perform the same pattern matching as docs/reference but don't require the use of reference-style links and the destinations are ordinary (full) URLs that can include version substitution. Unlike docs/reference, the implementation doesn't use relref so 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

To check the links, refer to the deploy preview in https://github.com/grafana/website/pull/19630.

Signed-off-by: Jack Baldry jack.baldry@grafana.com

Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
@grafana-delivery-bot grafana-delivery-bot bot added this to the 11.1.x milestone May 20, 2024
@jdbaldry jdbaldry added the no-changelog Skip including change in changelog/release notes label May 20, 2024
@jdbaldry jdbaldry marked this pull request as ready for review May 20, 2024 13:34
Copy link
Collaborator

@Eve832 Eve832 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I didn't check every single link, but I checked a bunch with make docsand didn't find any duds; and I did scan the diff to make see if I saw any obvious formatting errors. So I think we're good to go

@jdbaldry jdbaldry merged commit 26c2391 into main May 28, 2024
16 checks passed
@jdbaldry jdbaldry deleted the jdb/2024-04-use-ref-uris-docs-sources-datasources branch May 28, 2024 14:17
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
no-changelog Skip including change in changelog/release notes type/docs
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants