Skip to content

Commit

Permalink
Add warning about relref shortcode usage
Browse files Browse the repository at this point in the history
Signed-off-by: Jack Baldry <[email protected]>
  • Loading branch information
jdbaldry committed Oct 19, 2023
1 parent fc4bb12 commit 4ae4131
Showing 1 changed file with 5 additions and 0 deletions.
5 changes: 5 additions & 0 deletions docs/sources/write/shortcodes/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -286,6 +286,11 @@ In this example, the image's display size is changed to have a maximum width of

<!-- vale Grafana.Spelling = YES -->

{{% admonition type="warning" %}}
This shortcode is present in the documentation, but is being deprecated in favor of fully qualified URLs.
Don't use it when creating new or updating existing documentation.
{{% /admonition %}}

The `relref` shortcode provides build-time link checking to ensure that the destination file exists.

For example: `{{</* relref "./path/to/file" */>}}`.
Expand Down

0 comments on commit 4ae4131

Please sign in to comment.