From 9c362090a4cc5a5441cbbe0480ceb6ca7de129a7 Mon Sep 17 00:00:00 2001 From: Jack Baldry Date: Tue, 23 Jan 2024 11:08:55 +0000 Subject: [PATCH] Note that `doc-validator` does not check full URL links Also make clear that links can be to either versioned or unversioned documentation. --- docs/sources/write/links/index.md | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/docs/sources/write/links/index.md b/docs/sources/write/links/index.md index f7af6cd2b..f4d5a84da 100644 --- a/docs/sources/write/links/index.md +++ b/docs/sources/write/links/index.md @@ -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.