github-mirrors/kibana
1
0
Fork 0
mirror of https://github.com/elastic/kibana.git synced 2025-04-24 09:48:58 -04:00
Code Issues Projects Releases Packages Wiki Activity

Add remote clusters doc links (#205477)

Browse source 
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`|
This commit is contained in:
Sonia Sanz Vivas 2025-01-03 15:55:11 +01:00 • committed by GitHub
parent b2344549fb
commit 8d1845208e
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
1 changed files with 6 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

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

@ -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`,