Skip to content

Commit 98d935d

Browse files
[8.x] Add remote clusters doc links (elastic#205477) (elastic#205503)
# Backport This will backport the following commits from `main` to `8.x`: - [Add remote clusters doc links (elastic#205477)](elastic#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 (elastic#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 (elastic#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 (elastic#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>
1 parent 84db72d commit 98d935d

File tree

1 file changed

+6
-0
lines changed

1 file changed

+6
-0
lines changed

src/platform/packages/shared/kbn-doc-links/src/get_doc_links.ts

+6
Original file line numberDiff line numberDiff line change
@@ -448,6 +448,11 @@ export const getDocLinks = ({ kibanaBranch, buildFlavor }: GetDocLinkOptions): D
448448
remoteClustersOnPremSetupTrustWithCert: `${ELASTICSEARCH_DOCS}remote-clusters-cert.html`,
449449
remoteClustersOnPremSetupTrustWithApiKey: `${ELASTICSEARCH_DOCS}remote-clusters-api-key.html`,
450450
remoteClustersCloudSetupTrust: `${ELASTIC_WEBSITE_URL}guide/en/cloud/current/ec-enable-ccs.html`,
451+
remoteClustersCreateCloudClusterApiKey: `${ELASTICSEARCH_DOCS}security-api-create-cross-cluster-api-key.html`,
452+
remoteClustersOnPremPrerequisitesApiKey: `${ELASTICSEARCH_DOCS}remote-clusters-api-key.html#remote-clusters-prerequisites-api-key`,
453+
remoteClustersOnPremSecurityApiKey: `${ELASTICSEARCH_DOCS}remote-clusters-api-key.html#remote-clusters-security-api-key`,
454+
remoteClustersOnPremPrerequisitesCert: `${ELASTICSEARCH_DOCS}remote-clusters-cert.html#remote-clusters-prerequisites-cert`,
455+
remoteClustersOnPremSecurityCert: `${ELASTICSEARCH_DOCS}remote-clusters-cert.html#remote-clusters-security-cert`,
451456
rollupMigratingToDownsampling: `${ELASTICSEARCH_DOCS}rollup-migrating-to-downsampling.html`,
452457
rrf: `${ELASTICSEARCH_DOCS}rrf.html`,
453458
scriptParameters: `${ELASTICSEARCH_DOCS}modules-scripting-using.html#prefer-params`,
@@ -540,6 +545,7 @@ export const getDocLinks = ({ kibanaBranch, buildFlavor }: GetDocLinkOptions): D
540545
timelionSettings: `${KIBANA_DOCS}advanced-options.html#kibana-timelion-settings`,
541546
generalSettings: `${KIBANA_DOCS}advanced-options.html#kibana-general-settings`,
542547
savedObjectsApiList: `${KIBANA_DOCS}saved-objects-api.html#saved-objects-api`,
548+
apiKeys: `${KIBANA_DOCS}api-keys.html`,
543549
},
544550
ml: {
545551
guide: `${MACHINE_LEARNING_DOCS}index.html`,

0 commit comments

Comments
 (0)