Skip to content

Commit

Permalink
Note that doc-validator does not check full URL links
Browse files Browse the repository at this point in the history
Also make clear that links can be to either versioned or unversioned documentation.
  • Loading branch information
jdbaldry authored Jan 23, 2024
1 parent a02dd80 commit 9c36209
Showing 1 changed file with 6 additions and 1 deletion.
7 changes: 6 additions & 1 deletion docs/sources/write/links/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,8 +38,13 @@ For more information and examples, refer to [`docs/reference` shortcode](https:/

## Link to grafana.com pages

Use a full URL with version substitution syntax (if needed).
Use a full URL.

{{< admonition type="note" >}}
The `doc-validator` linter does not check links that use full URLs.
{{< /admonition >}}

If you are linking to versioned documentation, use a full URL with version substitution syntax.
Version substitution is necessary for full URLs to link to the correct version of documentation.
Usually, this is the current version of documentation.

Expand Down

0 comments on commit 9c36209

Please sign in to comment.