Skip to content

Commit

Permalink
Add trailing slash guidance (#436)
Browse files Browse the repository at this point in the history
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
Co-authored-by: Jack Baldry <[email protected]>
  • Loading branch information
3 people authored Jan 25, 2024
1 parent 8de4937 commit ff40e23
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 2 deletions.
6 changes: 4 additions & 2 deletions docs/sources/write/links/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,7 @@ cascade:
**Link to Grafana documentation**:
Start with `https://grafana.com/docs/grafana/<GRAFANA_VERSION>/`, and add the rest of the URL path.
Start with `https://grafana.com/docs/grafana/<GRAFANA_VERSION>/`, 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:

Expand Down Expand Up @@ -97,7 +97,7 @@ https://grafana.com/docs/mimir/<MIMIR_VERSION>/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:

Expand All @@ -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/<GRAFANA_VERSION>/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.
Expand Down
1 change: 1 addition & 0 deletions docs/sources/write/shortcodes/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 `<GRAFANA VERSION>`.
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:

Expand Down

0 comments on commit ff40e23

Please sign in to comment.