From 8d1845208e66e9ae8a5a69ef0d0f5c8ce712929c Mon Sep 17 00:00:00 2001 From: Sonia Sanz Vivas Date: Fri, 3 Jan 2025 15:55:11 +0100 Subject: [PATCH] Add remote clusters doc links (#205477) Part of https://github.com/elastic/kibana/issues/199664 ## Summary As part of the work of the `Remote clusters: UX improvements` project, adding some links. The corresponding PR will be quite large so I've decided to add the doc links in a separated PR to avoid noise and simplify the review process. The added links are the following: | Name | Target link | Code link | |-----------------------------------------|---------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------| | management.apiKeys| https://www.elastic.co/guide/en/kibana/8.16/api-keys.html | `${KIBANA_DOCS}api-keys.html` | | elasticsearch.remoteClustersCreateCloudClusterApiKey | https://www.elastic.co/guide/en/elasticsearch/reference/8.16/security-api-create-cross-cluster-api-key.html| `${ELASTICSEARCH_DOCS}security-api-create-cross-cluster-api-key.html`| | elasticsearch.remoteClustersOnPremPrerequisitesApiKey | https://www.elastic.co/guide/en/elasticsearch/reference/8.16/remote-clusters-api-key.html#remote-clusters-prerequisites-api-key | `${ELASTICSEARCH_DOCS}remote-clusters-api-key.html#remote-clusters-prerequisites-api-key` | | elasticsearch.remoteClustersOnPremSecurityApiKey | https://www.elastic.co/guide/en/elasticsearch/reference/8.16/remote-clusters-api-key.html#remote-clusters-security-api-key| `${ELASTICSEARCH_DOCS}remote-clusters-api-key.html#remote-clusters-security-api-key` | | elasticsearch.remoteClustersOnPremPrerequisitesCert | https://www.elastic.co/guide/en/elasticsearch/reference/8.16/remote-clusters-cert.html#remote-clusters-prerequisites-cert| `${ELASTICSEARCH_DOCS}remote-clusters-cert.html#remote-clusters-prerequisites-cert`| | elasticsearch.remoteClustersOnPremSecurityCert| https://www.elastic.co/guide/en/elasticsearch/reference/8.16/remote-clusters-cert.html#remote-clusters-security-cert| `${ELASTICSEARCH_DOCS}remote-clusters-cert.html#remote-clusters-security-cert`| --- .../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 f391114a85f26..dc747a63cdc96 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 @@ -445,6 +445,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`, @@ -539,6 +544,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`,