grafana / agent

Vendor-neutral programmable observability pipelines.
https://grafana.com/docs/agent/
Apache License 2.0
1.56k stars 479 forks source link

[release-v0.36] Replace docs/reference shortcode with ref URIs #6882

Closed jdbaldry closed 1 month ago

jdbaldry commented 1 month ago

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

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