From 98d935db2a6ba11ed3e617d46d6b49b5a29aa7ce Mon Sep 17 00:00:00 2001
From: Kibana Machine <42973632+kibanamachine@users.noreply.github.com>
Date: Sat, 4 Jan 2025 03:39:59 +1100
Subject: [PATCH] [8.x] Add remote clusters doc links (#205477) (#205503)

# Backport

This will backport the following commits from `main` to `8.x`:
- [Add remote clusters doc links
(#205477)](https://github.com/elastic/kibana/pull/205477)

<!--- Backport version: 9.4.3 -->

### Questions ?
Please refer to the [Backport tool
documentation](https://github.com/sqren/backport)

<!--BACKPORT [{"author":{"name":"Sonia Sanz
Vivas","email":"sonia.sanzvivas@elastic.co"},"sourceCommit":{"committedDate":"2025-01-03T14:55:11Z","message":"Add
remote clusters doc links (#205477)\n\nPart of
https://github.com/elastic/kibana/issues/199664\n\n## Summary\n\nAs part
of the work of the `Remote clusters: UX improvements` project,\nadding
some links. The corresponding PR will be quite large so I've\ndecided to
add the doc links in a separated PR to avoid noise and\nsimplify the
review process. The added links are the following:\n\n| Name | Target
link | Code link
|\n\n|-----------------------------------------|---------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------|\n|
management.apiKeys|\nhttps://www.elastic.co/guide/en/kibana/8.16/api-keys.html
|\n`${KIBANA_DOCS}api-keys.html` |\n|
elasticsearch.remoteClustersCreateCloudClusterApiKey
|\nhttps://www.elastic.co/guide/en/elasticsearch/reference/8.16/security-api-create-cross-cluster-api-key.html|\n`${ELASTICSEARCH_DOCS}security-api-create-cross-cluster-api-key.html`|\n|
elasticsearch.remoteClustersOnPremPrerequisitesApiKey
|\nhttps://www.elastic.co/guide/en/elasticsearch/reference/8.16/remote-clusters-api-key.html#remote-clusters-prerequisites-api-key\n|\n`${ELASTICSEARCH_DOCS}remote-clusters-api-key.html#remote-clusters-prerequisites-api-key`\n|\n|
elasticsearch.remoteClustersOnPremSecurityApiKey
|\nhttps://www.elastic.co/guide/en/elasticsearch/reference/8.16/remote-clusters-api-key.html#remote-clusters-security-api-key|\n`${ELASTICSEARCH_DOCS}remote-clusters-api-key.html#remote-clusters-security-api-key`\n|\n|
elasticsearch.remoteClustersOnPremPrerequisitesCert
|\nhttps://www.elastic.co/guide/en/elasticsearch/reference/8.16/remote-clusters-cert.html#remote-clusters-prerequisites-cert|\n`${ELASTICSEARCH_DOCS}remote-clusters-cert.html#remote-clusters-prerequisites-cert`|\n|
elasticsearch.remoteClustersOnPremSecurityCert|\nhttps://www.elastic.co/guide/en/elasticsearch/reference/8.16/remote-clusters-cert.html#remote-clusters-security-cert|\n`${ELASTICSEARCH_DOCS}remote-clusters-cert.html#remote-clusters-security-cert`|","sha":"8d1845208e66e9ae8a5a69ef0d0f5c8ce712929c","branchLabelMapping":{"^v9.0.0$":"main","^v8.18.0$":"8.x","^v(\\d+).(\\d+).\\d+$":"$1.$2"}},"sourcePullRequest":{"labels":["Team:Kibana
Management","release_note:skip","v9.0.0","backport:prev-minor"],"title":"Add
remote clusters doc
links","number":205477,"url":"https://github.com/elastic/kibana/pull/205477","mergeCommit":{"message":"Add
remote clusters doc links (#205477)\n\nPart of
https://github.com/elastic/kibana/issues/199664\n\n## Summary\n\nAs part
of the work of the `Remote clusters: UX improvements` project,\nadding
some links. The corresponding PR will be quite large so I've\ndecided to
add the doc links in a separated PR to avoid noise and\nsimplify the
review process. The added links are the following:\n\n| Name | Target
link | Code link
|\n\n|-----------------------------------------|---------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------|\n|
management.apiKeys|\nhttps://www.elastic.co/guide/en/kibana/8.16/api-keys.html
|\n`${KIBANA_DOCS}api-keys.html` |\n|
elasticsearch.remoteClustersCreateCloudClusterApiKey
|\nhttps://www.elastic.co/guide/en/elasticsearch/reference/8.16/security-api-create-cross-cluster-api-key.html|\n`${ELASTICSEARCH_DOCS}security-api-create-cross-cluster-api-key.html`|\n|
elasticsearch.remoteClustersOnPremPrerequisitesApiKey
|\nhttps://www.elastic.co/guide/en/elasticsearch/reference/8.16/remote-clusters-api-key.html#remote-clusters-prerequisites-api-key\n|\n`${ELASTICSEARCH_DOCS}remote-clusters-api-key.html#remote-clusters-prerequisites-api-key`\n|\n|
elasticsearch.remoteClustersOnPremSecurityApiKey
|\nhttps://www.elastic.co/guide/en/elasticsearch/reference/8.16/remote-clusters-api-key.html#remote-clusters-security-api-key|\n`${ELASTICSEARCH_DOCS}remote-clusters-api-key.html#remote-clusters-security-api-key`\n|\n|
elasticsearch.remoteClustersOnPremPrerequisitesCert
|\nhttps://www.elastic.co/guide/en/elasticsearch/reference/8.16/remote-clusters-cert.html#remote-clusters-prerequisites-cert|\n`${ELASTICSEARCH_DOCS}remote-clusters-cert.html#remote-clusters-prerequisites-cert`|\n|
elasticsearch.remoteClustersOnPremSecurityCert|\nhttps://www.elastic.co/guide/en/elasticsearch/reference/8.16/remote-clusters-cert.html#remote-clusters-security-cert|\n`${ELASTICSEARCH_DOCS}remote-clusters-cert.html#remote-clusters-security-cert`|","sha":"8d1845208e66e9ae8a5a69ef0d0f5c8ce712929c"}},"sourceBranch":"main","suggestedTargetBranches":[],"targetPullRequestStates":[{"branch":"main","label":"v9.0.0","branchLabelMappingKey":"^v9.0.0$","isSourceBranch":true,"state":"MERGED","url":"https://github.com/elastic/kibana/pull/205477","number":205477,"mergeCommit":{"message":"Add
remote clusters doc links (#205477)\n\nPart of
https://github.com/elastic/kibana/issues/199664\n\n## Summary\n\nAs part
of the work of the `Remote clusters: UX improvements` project,\nadding
some links. The corresponding PR will be quite large so I've\ndecided to
add the doc links in a separated PR to avoid noise and\nsimplify the
review process. The added links are the following:\n\n| Name | Target
link | Code link
|\n\n|-----------------------------------------|---------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------|\n|
management.apiKeys|\nhttps://www.elastic.co/guide/en/kibana/8.16/api-keys.html
|\n`${KIBANA_DOCS}api-keys.html` |\n|
elasticsearch.remoteClustersCreateCloudClusterApiKey
|\nhttps://www.elastic.co/guide/en/elasticsearch/reference/8.16/security-api-create-cross-cluster-api-key.html|\n`${ELASTICSEARCH_DOCS}security-api-create-cross-cluster-api-key.html`|\n|
elasticsearch.remoteClustersOnPremPrerequisitesApiKey
|\nhttps://www.elastic.co/guide/en/elasticsearch/reference/8.16/remote-clusters-api-key.html#remote-clusters-prerequisites-api-key\n|\n`${ELASTICSEARCH_DOCS}remote-clusters-api-key.html#remote-clusters-prerequisites-api-key`\n|\n|
elasticsearch.remoteClustersOnPremSecurityApiKey
|\nhttps://www.elastic.co/guide/en/elasticsearch/reference/8.16/remote-clusters-api-key.html#remote-clusters-security-api-key|\n`${ELASTICSEARCH_DOCS}remote-clusters-api-key.html#remote-clusters-security-api-key`\n|\n|
elasticsearch.remoteClustersOnPremPrerequisitesCert
|\nhttps://www.elastic.co/guide/en/elasticsearch/reference/8.16/remote-clusters-cert.html#remote-clusters-prerequisites-cert|\n`${ELASTICSEARCH_DOCS}remote-clusters-cert.html#remote-clusters-prerequisites-cert`|\n|
elasticsearch.remoteClustersOnPremSecurityCert|\nhttps://www.elastic.co/guide/en/elasticsearch/reference/8.16/remote-clusters-cert.html#remote-clusters-security-cert|\n`${ELASTICSEARCH_DOCS}remote-clusters-cert.html#remote-clusters-security-cert`|","sha":"8d1845208e66e9ae8a5a69ef0d0f5c8ce712929c"}}]}]
BACKPORT-->

Co-authored-by: Sonia Sanz Vivas <sonia.sanzvivas@elastic.co>
---
 .../packages/shared/kbn-doc-links/src/get_doc_links.ts      | 6 ++++++
 1 file changed, 6 insertions(+)

diff --git a/src/platform/packages/shared/kbn-doc-links/src/get_doc_links.ts b/src/platform/packages/shared/kbn-doc-links/src/get_doc_links.ts
index 7758e2c31f6d9..e11e9a564b935 100644
--- a/src/platform/packages/shared/kbn-doc-links/src/get_doc_links.ts
+++ b/src/platform/packages/shared/kbn-doc-links/src/get_doc_links.ts
@@ -448,6 +448,11 @@ export const getDocLinks = ({ kibanaBranch, buildFlavor }: GetDocLinkOptions): D
       remoteClustersOnPremSetupTrustWithCert: `${ELASTICSEARCH_DOCS}remote-clusters-cert.html`,
       remoteClustersOnPremSetupTrustWithApiKey: `${ELASTICSEARCH_DOCS}remote-clusters-api-key.html`,
       remoteClustersCloudSetupTrust: `${ELASTIC_WEBSITE_URL}guide/en/cloud/current/ec-enable-ccs.html`,
+      remoteClustersCreateCloudClusterApiKey: `${ELASTICSEARCH_DOCS}security-api-create-cross-cluster-api-key.html`,
+      remoteClustersOnPremPrerequisitesApiKey: `${ELASTICSEARCH_DOCS}remote-clusters-api-key.html#remote-clusters-prerequisites-api-key`,
+      remoteClustersOnPremSecurityApiKey: `${ELASTICSEARCH_DOCS}remote-clusters-api-key.html#remote-clusters-security-api-key`,
+      remoteClustersOnPremPrerequisitesCert: `${ELASTICSEARCH_DOCS}remote-clusters-cert.html#remote-clusters-prerequisites-cert`,
+      remoteClustersOnPremSecurityCert: `${ELASTICSEARCH_DOCS}remote-clusters-cert.html#remote-clusters-security-cert`,
       rollupMigratingToDownsampling: `${ELASTICSEARCH_DOCS}rollup-migrating-to-downsampling.html`,
       rrf: `${ELASTICSEARCH_DOCS}rrf.html`,
       scriptParameters: `${ELASTICSEARCH_DOCS}modules-scripting-using.html#prefer-params`,
@@ -540,6 +545,7 @@ export const getDocLinks = ({ kibanaBranch, buildFlavor }: GetDocLinkOptions): D
       timelionSettings: `${KIBANA_DOCS}advanced-options.html#kibana-timelion-settings`,
       generalSettings: `${KIBANA_DOCS}advanced-options.html#kibana-general-settings`,
       savedObjectsApiList: `${KIBANA_DOCS}saved-objects-api.html#saved-objects-api`,
+      apiKeys: `${KIBANA_DOCS}api-keys.html`,
     },
     ml: {
       guide: `${MACHINE_LEARNING_DOCS}index.html`,