Skip to content

Commit d57c649

Browse files
lcawllcawl
authored
[9.0] Use new beat URLs in doc link service (#219310) (#220721)
# Backport This will backport the following commits from `main` to `9.0`: - [Use new beat URLs in doc link service (#219310)](#219310) <!--- Backport version: 9.6.6 --> ### Questions ? Please refer to the [Backport tool documentation](https://github.com/sorenlouv/backport) <!--BACKPORT [{"author":{"name":"Lisa Cawley","email":"[email protected]"},"sourceCommit":{"committedDate":"2025-05-09T10:01:39Z","message":"Use new beat URLs in doc link service (#219310)","sha":"5b005594cc8c231b24934bd3c4f8c2593c3561f6","branchLabelMapping":{"^v9.1.0$":"main","^v(\\d+).(\\d+).\\d+$":"$1.$2"}},"sourcePullRequest":{"labels":["Team:Docs","release_note:skip","ci:cloud-deploy","ci:project-deploy-observability","backport:version","v9.1.0","v9.0.1"],"title":"Use new beat URLs in doc link service","number":219310,"url":"https://github.com/elastic/kibana/pull/219310","mergeCommit":{"message":"Use new beat URLs in doc link service (#219310)","sha":"5b005594cc8c231b24934bd3c4f8c2593c3561f6"}},"sourceBranch":"main","suggestedTargetBranches":["9.0"],"targetPullRequestStates":[{"branch":"main","label":"v9.1.0","branchLabelMappingKey":"^v9.1.0$","isSourceBranch":true,"state":"MERGED","url":"https://github.com/elastic/kibana/pull/219310","number":219310,"mergeCommit":{"message":"Use new beat URLs in doc link service (#219310)","sha":"5b005594cc8c231b24934bd3c4f8c2593c3561f6"}},{"branch":"9.0","label":"v9.0.1","branchLabelMappingKey":"^v(\\d+).(\\d+).\\d+$","isSourceBranch":false,"state":"NOT_CREATED"}]}] BACKPORT-->
1 parent fba7a93 commit d57c649

File tree

5 files changed

+70
-67
lines changed

5 files changed

+70
-67
lines changed

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

Lines changed: 66 additions & 64 deletions
Original file line numberDiff line numberDiff line change
@@ -32,11 +32,9 @@ export const getDocLinks = ({ kibanaBranch, buildFlavor }: GetDocLinkOptions): D
3232
const KIBANA_DOCS = `${ELASTIC_WEBSITE_URL}guide/en/kibana/${DOC_LINK_VERSION}/`;
3333
const KIBANA_APIS = `${API_DOCS}doc/kibana/v9/`;
3434
const KIBANA_SERVERLESS_APIS = `{$API_DOCS}doc/serverless/`;
35-
const FLEET_DOCS = `${ELASTIC_WEBSITE_URL}guide/en/fleet/${DOC_LINK_VERSION}/`;
3635
const SECURITY_SOLUTION_DOCS = `${ELASTIC_WEBSITE_URL}guide/en/security/${DOC_LINK_VERSION}/`;
3736
const ENTERPRISE_SEARCH_DOCS = `${ELASTIC_WEBSITE_URL}guide/en/enterprise-search/${DOC_LINK_VERSION}/`;
3837
const ESRE_DOCS = `${ELASTIC_WEBSITE_URL}guide/en/esre/${DOC_LINK_VERSION}/`;
39-
const SERVERLESS_DOCS = `${ELASTIC_WEBSITE_URL}guide/en/serverless/current/`;
4038
const SEARCH_LABS_REPO = `${ELASTIC_GITHUB}elasticsearch-labs/`;
4139
const isServerless = buildFlavor === 'serverless';
4240

@@ -91,20 +89,20 @@ export const getDocLinks = ({ kibanaBranch, buildFlavor }: GetDocLinkOptions): D
9189
documentExplorer: `${ELASTIC_DOCS}explore-analyze/discover/document-explorer`,
9290
},
9391
filebeat: {
94-
base: `${ELASTIC_WEBSITE_URL}guide/en/beats/filebeat/${DOC_LINK_VERSION}`,
95-
installation: `${ELASTIC_WEBSITE_URL}guide/en/beats/filebeat/${DOC_LINK_VERSION}/filebeat-installation-configuration.html`,
96-
configuration: `${ELASTIC_WEBSITE_URL}guide/en/beats/filebeat/${DOC_LINK_VERSION}/configuring-howto-filebeat.html`,
97-
elasticsearchModule: `${ELASTIC_WEBSITE_URL}guide/en/beats/filebeat/${DOC_LINK_VERSION}/filebeat-module-elasticsearch.html`,
98-
elasticsearchOutput: `${ELASTIC_WEBSITE_URL}guide/en/beats/filebeat/${DOC_LINK_VERSION}/elasticsearch-output.html`,
99-
startup: `${ELASTIC_WEBSITE_URL}guide/en/beats/filebeat/${DOC_LINK_VERSION}/filebeat-starting.html`,
100-
exportedFields: `${ELASTIC_WEBSITE_URL}guide/en/beats/filebeat/${DOC_LINK_VERSION}/exported-fields.html`,
101-
suricataModule: `${ELASTIC_WEBSITE_URL}guide/en/beats/filebeat/${DOC_LINK_VERSION}/filebeat-module-suricata.html`,
102-
zeekModule: `${ELASTIC_WEBSITE_URL}guide/en/beats/filebeat/${DOC_LINK_VERSION}/filebeat-module-zeek.html`,
92+
base: `${ELASTIC_DOCS}reference/beats/filebeat`,
93+
installation: `${ELASTIC_DOCS}reference/beats/filebeat/filebeat-installation-configuration`,
94+
configuration: `${ELASTIC_DOCS}reference/beats/filebeat/configuring-howto-filebeat`,
95+
elasticsearchModule: `${ELASTIC_DOCS}reference/beats/filebeat/filebeat-module-elasticsearch`,
96+
elasticsearchOutput: `${ELASTIC_DOCS}reference/beats/filebeat/elasticsearch-output`,
97+
startup: `${ELASTIC_DOCS}reference/beats/filebeat/filebeat-starting`,
98+
exportedFields: `${ELASTIC_DOCS}reference/beats/filebeat/exported-fields`,
99+
suricataModule: `${ELASTIC_DOCS}reference/beats/filebeat/filebeat-module-suricata`,
100+
zeekModule: `${ELASTIC_DOCS}reference/beats/filebeat/filebeat-module-zeek`,
103101
},
104102
auditbeat: {
105-
base: `${ELASTIC_WEBSITE_URL}guide/en/beats/auditbeat/${DOC_LINK_VERSION}`,
106-
auditdModule: `${ELASTIC_WEBSITE_URL}guide/en/beats/auditbeat/${DOC_LINK_VERSION}/auditbeat-module-auditd.html`,
107-
systemModule: `${ELASTIC_WEBSITE_URL}guide/en/beats/auditbeat/${DOC_LINK_VERSION}/auditbeat-module-system.html`,
103+
base: `${ELASTIC_DOCS}reference/beats/auditbeat`,
104+
auditdModule: `${ELASTIC_DOCS}reference/beats/auditbeat/auditbeat-module-auditd`,
105+
systemModule: `${ELASTIC_DOCS}reference/beats/auditbeat/auditbeat-module-system`,
108106
},
109107
enterpriseSearch: {
110108
aiSearchDoc: `${ESRE_DOCS}`,
@@ -195,24 +193,25 @@ export const getDocLinks = ({ kibanaBranch, buildFlavor }: GetDocLinkOptions): D
195193
usersAccess: `${ENTERPRISE_SEARCH_DOCS}users-access.html`,
196194
},
197195
metricbeat: {
198-
base: `${ELASTIC_WEBSITE_URL}guide/en/beats/metricbeat/${DOC_LINK_VERSION}`,
199-
configure: `${ELASTIC_WEBSITE_URL}guide/en/beats/metricbeat/${DOC_LINK_VERSION}/configuring-howto-metricbeat.html`,
200-
httpEndpoint: `${ELASTIC_WEBSITE_URL}guide/en/beats/metricbeat/${DOC_LINK_VERSION}/http-endpoint.html`,
201-
install: `${ELASTIC_WEBSITE_URL}guide/en/beats/metricbeat/${DOC_LINK_VERSION}/metricbeat-installation-configuration.html`,
202-
start: `${ELASTIC_WEBSITE_URL}guide/en/beats/metricbeat/${DOC_LINK_VERSION}/metricbeat-starting.html`,
196+
base: `${ELASTIC_DOCS}reference/beats/metricbeat`,
197+
configure: `${ELASTIC_DOCS}reference/beats/metricbeat/configuring-howto-metricbeat`,
198+
httpEndpoint: `${ELASTIC_DOCS}reference/beats/metricbeat/http-endpoint`,
199+
install: `${ELASTIC_DOCS}reference/beats/metricbeat/metricbeat-installation-configuration`,
200+
start: `${ELASTIC_DOCS}reference/beats/metricbeat/metricbeat-starting`,
203201
},
204202
heartbeat: {
205-
base: `${ELASTIC_WEBSITE_URL}guide/en/beats/heartbeat/${DOC_LINK_VERSION}`,
203+
base: `${ELASTIC_DOCS}reference/beats/heartbeat`,
204+
monitorTags: `${ELASTIC_DOCS}reference/beats/heartbeat/monitor-options#monitor-tags`,
206205
},
207206
libbeat: {
208-
getStarted: `${ELASTIC_WEBSITE_URL}guide/en/beats/libbeat/${DOC_LINK_VERSION}/getting-started.html`,
207+
getStarted: `${ELASTIC_DOCS}reference/beats`,
209208
},
210209
logstash: {
211210
base: `${ELASTIC_DOCS}reference/logstash`,
212211
inputElasticAgent: `${ELASTIC_DOCS}reference/logstash/plugins/plugins-inputs-elastic_agent`,
213212
},
214213
winlogbeat: {
215-
base: `${ELASTIC_WEBSITE_URL}guide/en/beats/winlogbeat/${DOC_LINK_VERSION}`,
214+
base: `${ELASTIC_DOCS}reference/beats/winlogbeat`,
216215
},
217216
aggs: {
218217
composite: `${ELASTIC_DOCS}reference/aggregations/search-aggregations-bucket-composite-aggregation`,
@@ -830,50 +829,53 @@ export const getDocLinks = ({ kibanaBranch, buildFlavor }: GetDocLinkOptions): D
830829
userAgent: `${ELASTIC_DOCS}reference/enrich-processor/user-agent-processor`,
831830
},
832831
fleet: {
833-
guide: `${FLEET_DOCS}index.html`,
832+
guide: `${ELASTIC_DOCS}reference/fleet`,
834833
fingerprint: `${ELASTIC_DOCS}reference/fleet/fingerprint-processor`,
835-
fleetServer: `${FLEET_DOCS}fleet-server.html`,
836-
fleetServerAddFleetServer: `${FLEET_DOCS}add-a-fleet-server.html`,
837-
settings: `${FLEET_DOCS}fleet-settings.html`,
838-
kafkaSettings: `${FLEET_DOCS}kafka-output-settings.html`,
839-
logstashSettings: `${FLEET_DOCS}ls-output-settings.html`,
840-
esSettings: `${FLEET_DOCS}es-output-settings.html`,
841-
settingsFleetServerHostSettings: `${FLEET_DOCS}fleet-settings.html#fleet-server-hosts-setting`,
842-
settingsFleetServerProxySettings: `${KIBANA_DOCS}fleet-settings-kb.html#fleet-data-visualizer-settings`,
843-
troubleshooting: `${FLEET_DOCS}fleet-troubleshooting.html`,
844-
elasticAgent: `${FLEET_DOCS}elastic-agent-installation.html`,
845-
beatsAgentComparison: `${FLEET_DOCS}beats-agent-comparison.html`,
846-
datastreams: `${FLEET_DOCS}data-streams.html`,
847-
datastreamsILM: `${FLEET_DOCS}data-streams.html#data-streams-ilm`,
848-
datastreamsNamingScheme: `${FLEET_DOCS}data-streams.html#data-streams-naming-scheme`,
849-
datastreamsManualRollover: `${ELASTICSEARCH_DOCS}use-a-data-stream.html#manually-roll-over-a-data-stream`,
850-
datastreamsTSDS: `${ELASTICSEARCH_DOCS}tsds.html`,
851-
datastreamsTSDSMetrics: `${ELASTICSEARCH_DOCS}tsds.html#time-series-metric`,
852-
datastreamsDownsampling: `${ELASTICSEARCH_DOCS}downsampling.html`,
853-
installElasticAgent: `${FLEET_DOCS}install-fleet-managed-elastic-agent.html`,
854-
installElasticAgentStandalone: `${FLEET_DOCS}install-standalone-elastic-agent.html`,
855-
grantESAccessToStandaloneAgents: `${FLEET_DOCS}grant-access-to-elasticsearch.html`,
856-
upgradeElasticAgent: `${FLEET_DOCS}upgrade-elastic-agent.html`,
857-
learnMoreBlog: `${ELASTIC_WEBSITE_URL}blog/elastic-agent-and-fleet-make-it-easier-to-integrate-your-systems-with-elastic`,
834+
fleetServer: `${ELASTIC_DOCS}reference/fleet/fleet-server`,
835+
fleetServerAddFleetServer: `${ELASTIC_DOCS}reference/fleet/deployment-models`,
836+
settings: `${ELASTIC_DOCS}reference/fleet/fleet-settings`,
837+
kafkaSettings: `${ELASTIC_DOCS}reference/fleet/kafka-output-settings`,
838+
kafkaOutputTopicsSettings: `${ELASTIC_DOCS}reference/fleet/kafka-output-settings#_topics_settings`,
839+
logstashSettings: `${ELASTIC_DOCS}reference/fleet/ls-output-settings`,
840+
esSettings: `${ELASTIC_DOCS}reference/fleet/es-output-settings`,
841+
settingsFleetServerHostSettings: `${ELASTIC_DOCS}reference/fleet/fleet-settings#fleet-server-hosts-setting`,
842+
settingsFleetServerProxySettings: `${ELASTIC_DOCS}reference/kibana/configuration-reference/fleet-settings#fleet-data-visualizer-settings`,
843+
troubleshooting: `${ELASTIC_DOCS}troubleshoot/ingest/fleet/common-problems`,
844+
elasticAgent: `${ELASTIC_DOCS}reference/fleet/install-elastic-agents`,
845+
beatsAgentComparison: `${ELASTIC_DOCS}manage-data/ingest/tools`,
846+
datastreams: `${ELASTIC_DOCS}reference/fleet/data-streams`,
847+
datastreamsILM: `${ELASTIC_DOCS}reference/fleet/data-streams#data-streams-ilm`,
848+
datastreamsNamingScheme: `${ELASTIC_DOCS}reference/fleet/data-streams#data-streams-naming-scheme`,
849+
datastreamsManualRollover: `${ELASTIC_DOCS}manage-data/data-store/data-streams/use-data-stream#manually-roll-over-a-data-stream`,
850+
datastreamsTSDS: `${ELASTIC_DOCS}manage-data/data-store/data-streams/time-series-data-stream-tsds`,
851+
datastreamsTSDSMetrics: `${ELASTIC_DOCS}manage-data/data-store/data-streams/time-series-data-stream-tsds#time-series-metric`,
852+
datastreamsDownsampling: `${ELASTIC_DOCS}manage-data/data-store/data-streams/downsampling-time-series-data-stream`,
853+
installElasticAgent: `${ELASTIC_DOCS}reference/fleet/install-fleet-managed-elastic-agent`,
854+
installElasticAgentStandalone: `${ELASTIC_DOCS}reference/fleet/install-standalone-elastic-agent`,
855+
grantESAccessToStandaloneAgents: `${ELASTIC_DOCS}reference/fleet/grant-access-to-elasticsearch`,
856+
upgradeElasticAgent: `${ELASTIC_DOCS}reference/fleet/upgrade-elastic-agent`,
857+
learnMoreBlog: `https://www.elastic.co/blog/elastic-agent-and-fleet-make-it-easier-to-integrate-your-systems-with-elastic`,
858858
apiKeysLearnMore: isServerless
859-
? `${SERVERLESS_DOCS}api-keys.html`
860-
: `${KIBANA_DOCS}api-keys.html`,
861-
onPremRegistry: `${FLEET_DOCS}air-gapped.html`,
862-
packageSignatures: `${FLEET_DOCS}package-signatures.html`,
863-
secureLogstash: `${FLEET_DOCS}secure-logstash-connections.html`,
864-
agentPolicy: `${FLEET_DOCS}agent-policy.html`,
865-
api: `${FLEET_DOCS}fleet-api-docs.html`,
866-
uninstallAgent: `${SECURITY_SOLUTION_DOCS}uninstall-agent.html`,
867-
installAndUninstallIntegrationAssets: `${FLEET_DOCS}install-uninstall-integration-assets.html`,
868-
elasticAgentInputConfiguration: `${FLEET_DOCS}elastic-agent-input-configuration.html`,
869-
policySecrets: `${FLEET_DOCS}agent-policy.html#agent-policy-secret-values`,
870-
remoteESOoutput: `${FLEET_DOCS}monitor-elastic-agent.html#external-elasticsearch-monitoring`,
871-
performancePresets: `${FLEET_DOCS}es-output-settings.html#es-output-settings-performance-tuning-settings`,
872-
scalingKubernetesResourcesAndLimits: `${FLEET_DOCS}scaling-on-kubernetes.html#_specifying_resources_and_limits_in_agent_manifests`,
873-
roleAndPrivileges: `${FLEET_DOCS}fleet-roles-and-privileges.html`,
874-
proxiesSettings: `${FLEET_DOCS}fleet-agent-proxy-support.html`,
875-
unprivilegedMode: `${FLEET_DOCS}elastic-agent-unprivileged.html#unprivileged-change-mode`,
876-
httpMonitoring: `${FLEET_DOCS}agent-policy.html#change-policy-enable-agent-monitoring`,
859+
? `${ELASTIC_DOCS}deploy-manage/api-keys/serverless-project-api-keys`
860+
: `${ELASTIC_DOCS}deploy-manage/api-keys/elasticsearch-api-keys`,
861+
onPremRegistry: `${ELASTIC_DOCS}reference/fleet/air-gapped`,
862+
packageSignatures: `${ELASTIC_DOCS}reference/fleet/package-signatures`,
863+
secureLogstash: `${ELASTIC_DOCS}reference/fleet/secure-logstash-connections`,
864+
agentPolicy: `${ELASTIC_DOCS}reference/fleet/agent-policy`,
865+
agentlessIntegrations: `${ELASTIC_DOCS}solutions/security/get-started/agentless-integrations`,
866+
api: `${ELASTIC_DOCS}reference/fleet/fleet-api-docs`,
867+
uninstallAgent: `${ELASTIC_DOCS}solutions/security/configure-elastic-defend/uninstall-elastic-agent`,
868+
installAndUninstallIntegrationAssets: `${ELASTIC_DOCS}reference/fleet/install-uninstall-integration-assets`,
869+
elasticAgentInputConfiguration: `${ELASTIC_DOCS}reference/fleet/elastic-agent-input-configuration`,
870+
policySecrets: `${ELASTIC_DOCS}reference/fleet/agent-policy#agent-policy-secret-values`,
871+
remoteESOoutput: `${ELASTIC_DOCS}reference/fleet/remote-elasticsearch-output`,
872+
performancePresets: `${ELASTIC_DOCS}reference/fleet/es-output-settings#es-output-settings-performance-tuning-settings`,
873+
scalingKubernetesResourcesAndLimits: `${ELASTIC_DOCS}reference/fleet/scaling-on-kubernetes#_specifying_resources_and_limits_in_agent_manifests`,
874+
roleAndPrivileges: `${ELASTIC_DOCS}reference/fleet/fleet-roles-privileges`,
875+
proxiesSettings: `${ELASTIC_DOCS}reference/fleet/fleet-agent-proxy-support`,
876+
unprivilegedMode: `${ELASTIC_DOCS}reference/fleet/elastic-agent-unprivileged#unprivileged-change-mode`,
877+
httpMonitoring: `${ELASTIC_DOCS}reference/fleet/agent-policy#change-policy-enable-agent-monitoring`,
878+
agentLevelLogging: `${ELASTIC_DOCS}reference/fleet/monitor-elastic-agent#change-logging-level`,
877879
},
878880
integrationDeveloper: {
879881
upload: `${ELASTIC_DOCS}extend/integrations/upload-new-integration`,

‎src/platform/packages/shared/kbn-doc-links/src/types.ts‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -171,6 +171,7 @@ export interface DocLinks {
171171
};
172172
readonly heartbeat: {
173173
readonly base: string;
174+
readonly monitorTags: string;
174175
};
175176
readonly libbeat: {
176177
readonly getStarted: string;

‎x-pack/solutions/observability/plugins/uptime/public/legacy_uptime/components/common/monitor_tags.tsx‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -82,7 +82,7 @@ export const MonitorTags = ({ ping, summary }: Props) => {
8282
return summary ? null : (
8383
<EuiLink
8484
data-test-subj="syntheticsMonitorTagsSetTagsLink"
85-
href={docLinks?.links.heartbeat.base + '/monitor-options.html#monitor-tags'}
85+
href={docLinks?.links.heartbeat.monitorTags}
8686
target="_blank"
8787
>
8888
Set tags

‎x-pack/solutions/observability/plugins/uptime/public/legacy_uptime/components/monitor/status_details/__snapshots__/monitor_status.bar.test.tsx.snap‎

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎x-pack/solutions/security/plugins/security_solution/public/explore/network/components/embeddables/__snapshots__/index_patterns_missing_prompt.test.tsx.snap‎

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)