diff --git a/docs/sources/write/links/index.md b/docs/sources/write/links/index.md index f4d5a84da..732f14171 100644 --- a/docs/sources/write/links/index.md +++ b/docs/sources/write/links/index.md @@ -60,7 +60,7 @@ cascade: **Link to Grafana documentation**: -Start with `https://grafana.com/docs/grafana//`, and add the rest of the URL path. +Start with `https://grafana.com/docs/grafana//`, and add the rest of the URL path. Include trailing slashes. For example, to link to the [Developers](https://grafana.com/docs/grafana/latest/developers) page with version substitution, use: @@ -97,7 +97,7 @@ https://grafana.com/docs/mimir//release-notes/ ## Link to external pages -Use the full URL. +Use the full URL. Copy the URL as it is from the address bar. If it includes a trailing slash, include it; if it doesn't, don't. For example: @@ -121,6 +121,8 @@ From a different page: Read more in the [Grafana Open Source section of the Introduction page](https://grafana.com/docs/grafana//fundamentals/#grafana-open-source). ``` +Include the trailing slash before the hash (#) that precedes the page heading. + To convert a heading to an anchor, make the following changes: 1. Convert to lower case. diff --git a/docs/sources/write/shortcodes/index.md b/docs/sources/write/shortcodes/index.md index 234ebb11f..0561d855d 100644 --- a/docs/sources/write/shortcodes/index.md +++ b/docs/sources/write/shortcodes/index.md @@ -657,6 +657,7 @@ The content within the shortcode tags is as follows: - _`REFERENCE`_ - The path to the destination file. This shortcode supports version substitution using values like ``. To learn about version substitution, refer to [About version substitution](#about-version-substitution). + Don't include trailing slashes in the path. Then add the link in the body of the file in the following format: