From 83108bb970d31b198622e92ce8614b9c4b0dc3ae Mon Sep 17 00:00:00 2001 From: Brandon Morelli Date: Wed, 25 Jun 2025 16:29:35 -0700 Subject: [PATCH 1/5] Update links.md --- docs/syntax/links.md | 16 +++++++--------- 1 file changed, 7 insertions(+), 9 deletions(-) diff --git a/docs/syntax/links.md b/docs/syntax/links.md index 4c22fe1ee..c10ea51e0 100644 --- a/docs/syntax/links.md +++ b/docs/syntax/links.md @@ -15,24 +15,22 @@ It has two components: ### Internal links -Link between documentation files using either relative or absolute paths. +Use internal links for doc to doc links. Internal links can reference a relative or absolute path, and you can optionally append an anchor to send readers to a specific section on a page. #### Relative paths -Navigate relative to the current file's location: ```markdown -[Security documentation](../security/index.md) +[Security docs](../security/index.md) -[Monitoring guide](monitor/index.md) -``` +[Install](monitor/index.md#installation) +```` #### Absolute paths -You can also use absolute paths to link to pages within the same repository. -Say you're working on a random page somewhere in the `docs-content` repo. You can link to a page in the `deploy-manage` section like this: - ```markdown -[API Keys](/deploy-manage/api-keys.md) +[API keys](/deploy-manage/api-keys.md) + +[Authentication](/deploy-manage/api-keys.md#authentication) ``` Note the leading `/` before the path. From 864cd44a4d86a9de222c10a4bdb045f6c1be3d5b Mon Sep 17 00:00:00 2001 From: Brandon Morelli Date: Wed, 25 Jun 2025 16:33:52 -0700 Subject: [PATCH 2/5] Update links.md --- docs/syntax/links.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/syntax/links.md b/docs/syntax/links.md index c10ea51e0..7238ce6ba 100644 --- a/docs/syntax/links.md +++ b/docs/syntax/links.md @@ -15,7 +15,7 @@ It has two components: ### Internal links -Use internal links for doc to doc links. Internal links can reference a relative or absolute path, and you can optionally append an anchor to send readers to a specific section on a page. +Link to other documentation pages using the file’s relative or absolute path. Optionally append an anchor to send readers to a specific section on a page. Never use a full URL for links between documentation pages. #### Relative paths @@ -23,7 +23,7 @@ Use internal links for doc to doc links. Internal links can reference a relative [Security docs](../security/index.md) [Install](monitor/index.md#installation) -```` +``` #### Absolute paths From db629637ae740e0041ab7ef89d97a6f55656a006 Mon Sep 17 00:00:00 2001 From: Brandon Morelli Date: Wed, 25 Jun 2025 16:37:26 -0700 Subject: [PATCH 3/5] Update links.md --- docs/syntax/links.md | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/docs/syntax/links.md b/docs/syntax/links.md index 7238ce6ba..06d8c4b19 100644 --- a/docs/syntax/links.md +++ b/docs/syntax/links.md @@ -15,10 +15,12 @@ It has two components: ### Internal links -Link to other documentation pages using the file’s relative or absolute path. Optionally append an anchor to send readers to a specific section on a page. Never use a full URL for links between documentation pages. +Link to other documentation pages in the same repository using the file’s relative or absolute path. Optionally append an anchor to send readers to a specific section on a page. Never use a full URL for links between documentation pages. #### Relative paths +Use relative paths to link to other pages inside the same repository. + ```markdown [Security docs](../security/index.md) @@ -27,6 +29,8 @@ Link to other documentation pages using the file’s relative or absolute path. #### Absolute paths +Use absolute paths to link to other pages inside the same repository. + ```markdown [API keys](/deploy-manage/api-keys.md) @@ -88,6 +92,8 @@ The syntax follows the format `://`, where: The `path` in cross-repo links must be relative to the `docset.yml` file and not the full path within the repo ::: +Never use a full URL for links across documentation repositories. + ### External links Link to websites and resources outside the Elastic docs: From e5cf16b9592d2b74c3814e30cdb1bd8144542c3b Mon Sep 17 00:00:00 2001 From: Brandon Morelli Date: Wed, 25 Jun 2025 16:37:46 -0700 Subject: [PATCH 4/5] Update links.md --- docs/syntax/links.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/syntax/links.md b/docs/syntax/links.md index 06d8c4b19..03e37a0be 100644 --- a/docs/syntax/links.md +++ b/docs/syntax/links.md @@ -15,7 +15,7 @@ It has two components: ### Internal links -Link to other documentation pages in the same repository using the file’s relative or absolute path. Optionally append an anchor to send readers to a specific section on a page. Never use a full URL for links between documentation pages. +Link between documentation pages in the same repository using the file’s relative or absolute path. Optionally append an anchor to send readers to a specific section on a page. Never use a full URL for links between documentation pages. #### Relative paths From 5a219fe383e614087e5d468c5dd73787654d848c Mon Sep 17 00:00:00 2001 From: Brandon Morelli Date: Wed, 25 Jun 2025 16:40:06 -0700 Subject: [PATCH 5/5] Update links.md --- docs/syntax/links.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/syntax/links.md b/docs/syntax/links.md index 03e37a0be..90f4f77be 100644 --- a/docs/syntax/links.md +++ b/docs/syntax/links.md @@ -15,7 +15,7 @@ It has two components: ### Internal links -Link between documentation pages in the same repository using the file’s relative or absolute path. Optionally append an anchor to send readers to a specific section on a page. Never use a full URL for links between documentation pages. +Link between documentation pages in the same repository using the file’s relative or absolute path. The path must include the `.md` file extension. Optionally append an anchor to send readers to a specific section on a page. Never use a full URL for links between documentation pages. #### Relative paths