Skip to content

Commit 3a4a492

Browse files
committed
Use new beat URLs in doc link service (elastic#219310)
(cherry picked from commit 5b00559)
1 parent 79d0cfb commit 3a4a492

File tree

5 files changed

+70
-66
lines changed

5 files changed

+70
-66
lines changed

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

Lines changed: 66 additions & 63 deletions
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,6 @@ export const getDocLinks = ({ kibanaBranch, buildFlavor }: GetDocLinkOptions): D
3333
const KIBANA_DOCS = `${ELASTIC_WEBSITE_URL}guide/en/kibana/${DOC_LINK_VERSION}/`;
3434
const KIBANA_APIS = `${API_DOCS}doc/kibana/v9/`;
3535
const KIBANA_SERVERLESS_APIS = `{$API_DOCS}doc/serverless/`;
36-
const FLEET_DOCS = `${ELASTIC_WEBSITE_URL}guide/en/fleet/${DOC_LINK_VERSION}/`;
3736
const PLUGIN_DOCS = `${ELASTIC_WEBSITE_URL}guide/en/elasticsearch/plugins/${DOC_LINK_VERSION}/`;
3837
const SECURITY_SOLUTION_DOCS = `${ELASTIC_WEBSITE_URL}guide/en/security/${DOC_LINK_VERSION}/`;
3938
const ENTERPRISE_SEARCH_DOCS = `${ELASTIC_WEBSITE_URL}guide/en/enterprise-search/${DOC_LINK_VERSION}/`;
@@ -94,20 +93,20 @@ export const getDocLinks = ({ kibanaBranch, buildFlavor }: GetDocLinkOptions): D
9493
documentExplorer: `${ELASTIC_DOCS}explore-analyze/discover/document-explorer`,
9594
},
9695
filebeat: {
97-
base: `${ELASTIC_WEBSITE_URL}guide/en/beats/filebeat/${DOC_LINK_VERSION}`,
98-
installation: `${ELASTIC_WEBSITE_URL}guide/en/beats/filebeat/${DOC_LINK_VERSION}/filebeat-installation-configuration.html`,
99-
configuration: `${ELASTIC_WEBSITE_URL}guide/en/beats/filebeat/${DOC_LINK_VERSION}/configuring-howto-filebeat.html`,
100-
elasticsearchModule: `${ELASTIC_WEBSITE_URL}guide/en/beats/filebeat/${DOC_LINK_VERSION}/filebeat-module-elasticsearch.html`,
101-
elasticsearchOutput: `${ELASTIC_WEBSITE_URL}guide/en/beats/filebeat/${DOC_LINK_VERSION}/elasticsearch-output.html`,
102-
startup: `${ELASTIC_WEBSITE_URL}guide/en/beats/filebeat/${DOC_LINK_VERSION}/filebeat-starting.html`,
103-
exportedFields: `${ELASTIC_WEBSITE_URL}guide/en/beats/filebeat/${DOC_LINK_VERSION}/exported-fields.html`,
104-
suricataModule: `${ELASTIC_WEBSITE_URL}guide/en/beats/filebeat/${DOC_LINK_VERSION}/filebeat-module-suricata.html`,
105-
zeekModule: `${ELASTIC_WEBSITE_URL}guide/en/beats/filebeat/${DOC_LINK_VERSION}/filebeat-module-zeek.html`,
96+
base: `${ELASTIC_DOCS}reference/beats/filebeat`,
97+
installation: `${ELASTIC_DOCS}reference/beats/filebeat/filebeat-installation-configuration`,
98+
configuration: `${ELASTIC_DOCS}reference/beats/filebeat/configuring-howto-filebeat`,
99+
elasticsearchModule: `${ELASTIC_DOCS}reference/beats/filebeat/filebeat-module-elasticsearch`,
100+
elasticsearchOutput: `${ELASTIC_DOCS}reference/beats/filebeat/elasticsearch-output`,
101+
startup: `${ELASTIC_DOCS}reference/beats/filebeat/filebeat-starting`,
102+
exportedFields: `${ELASTIC_DOCS}reference/beats/filebeat/exported-fields`,
103+
suricataModule: `${ELASTIC_DOCS}reference/beats/filebeat/filebeat-module-suricata`,
104+
zeekModule: `${ELASTIC_DOCS}reference/beats/filebeat/filebeat-module-zeek`,
106105
},
107106
auditbeat: {
108-
base: `${ELASTIC_WEBSITE_URL}guide/en/beats/auditbeat/${DOC_LINK_VERSION}`,
109-
auditdModule: `${ELASTIC_WEBSITE_URL}guide/en/beats/auditbeat/${DOC_LINK_VERSION}/auditbeat-module-auditd.html`,
110-
systemModule: `${ELASTIC_WEBSITE_URL}guide/en/beats/auditbeat/${DOC_LINK_VERSION}/auditbeat-module-system.html`,
107+
base: `${ELASTIC_DOCS}reference/beats/auditbeat`,
108+
auditdModule: `${ELASTIC_DOCS}reference/beats/auditbeat/auditbeat-module-auditd`,
109+
systemModule: `${ELASTIC_DOCS}reference/beats/auditbeat/auditbeat-module-system`,
111110
},
112111
enterpriseSearch: {
113112
aiSearchDoc: `${ESRE_DOCS}`,
@@ -198,24 +197,25 @@ export const getDocLinks = ({ kibanaBranch, buildFlavor }: GetDocLinkOptions): D
198197
usersAccess: `${ENTERPRISE_SEARCH_DOCS}users-access.html`,
199198
},
200199
metricbeat: {
201-
base: `${ELASTIC_WEBSITE_URL}guide/en/beats/metricbeat/${DOC_LINK_VERSION}`,
202-
configure: `${ELASTIC_WEBSITE_URL}guide/en/beats/metricbeat/${DOC_LINK_VERSION}/configuring-howto-metricbeat.html`,
203-
httpEndpoint: `${ELASTIC_WEBSITE_URL}guide/en/beats/metricbeat/${DOC_LINK_VERSION}/http-endpoint.html`,
204-
install: `${ELASTIC_WEBSITE_URL}guide/en/beats/metricbeat/${DOC_LINK_VERSION}/metricbeat-installation-configuration.html`,
205-
start: `${ELASTIC_WEBSITE_URL}guide/en/beats/metricbeat/${DOC_LINK_VERSION}/metricbeat-starting.html`,
200+
base: `${ELASTIC_DOCS}reference/beats/metricbeat`,
201+
configure: `${ELASTIC_DOCS}reference/beats/metricbeat/configuring-howto-metricbeat`,
202+
httpEndpoint: `${ELASTIC_DOCS}reference/beats/metricbeat/http-endpoint`,
203+
install: `${ELASTIC_DOCS}reference/beats/metricbeat/metricbeat-installation-configuration`,
204+
start: `${ELASTIC_DOCS}reference/beats/metricbeat/metricbeat-starting`,
206205
},
207206
heartbeat: {
208-
base: `${ELASTIC_WEBSITE_URL}guide/en/beats/heartbeat/${DOC_LINK_VERSION}`,
207+
base: `${ELASTIC_DOCS}reference/beats/heartbeat`,
208+
monitorTags: `${ELASTIC_DOCS}reference/beats/heartbeat/monitor-options#monitor-tags`,
209209
},
210210
libbeat: {
211-
getStarted: `${ELASTIC_WEBSITE_URL}guide/en/beats/libbeat/${DOC_LINK_VERSION}/getting-started.html`,
211+
getStarted: `${ELASTIC_DOCS}reference/beats`,
212212
},
213213
logstash: {
214214
base: `${ELASTIC_WEBSITE_URL}guide/en/logstash/${DOC_LINK_VERSION}`,
215215
inputElasticAgent: `${ELASTIC_WEBSITE_URL}guide/en/logstash/${DOC_LINK_VERSION}/plugins-inputs-elastic_agent.html`,
216216
},
217217
winlogbeat: {
218-
base: `${ELASTIC_WEBSITE_URL}guide/en/beats/winlogbeat/${DOC_LINK_VERSION}`,
218+
base: `${ELASTIC_DOCS}reference/beats/winlogbeat`,
219219
},
220220
aggs: {
221221
composite: `${ELASTICSEARCH_DOCS}search-aggregations-bucket-composite-aggregation.html`,
@@ -820,49 +820,52 @@ export const getDocLinks = ({ kibanaBranch, buildFlavor }: GetDocLinkOptions): D
820820
userAgent: `${ELASTICSEARCH_DOCS}user-agent-processor.html`,
821821
},
822822
fleet: {
823-
guide: `${FLEET_DOCS}index.html`,
824-
fleetServer: `${FLEET_DOCS}fleet-server.html`,
825-
fleetServerAddFleetServer: `${FLEET_DOCS}add-a-fleet-server.html`,
826-
settings: `${FLEET_DOCS}fleet-settings.html`,
827-
kafkaSettings: `${FLEET_DOCS}kafka-output-settings.html`,
828-
logstashSettings: `${FLEET_DOCS}ls-output-settings.html`,
829-
esSettings: `${FLEET_DOCS}es-output-settings.html`,
830-
settingsFleetServerHostSettings: `${FLEET_DOCS}fleet-settings.html#fleet-server-hosts-setting`,
831-
settingsFleetServerProxySettings: `${KIBANA_DOCS}fleet-settings-kb.html#fleet-data-visualizer-settings`,
832-
troubleshooting: `${FLEET_DOCS}fleet-troubleshooting.html`,
833-
elasticAgent: `${FLEET_DOCS}elastic-agent-installation.html`,
834-
beatsAgentComparison: `${FLEET_DOCS}beats-agent-comparison.html`,
835-
datastreams: `${FLEET_DOCS}data-streams.html`,
836-
datastreamsILM: `${FLEET_DOCS}data-streams.html#data-streams-ilm`,
837-
datastreamsNamingScheme: `${FLEET_DOCS}data-streams.html#data-streams-naming-scheme`,
838-
datastreamsManualRollover: `${ELASTICSEARCH_DOCS}use-a-data-stream.html#manually-roll-over-a-data-stream`,
839-
datastreamsTSDS: `${ELASTICSEARCH_DOCS}tsds.html`,
840-
datastreamsTSDSMetrics: `${ELASTICSEARCH_DOCS}tsds.html#time-series-metric`,
841-
datastreamsDownsampling: `${ELASTICSEARCH_DOCS}downsampling.html`,
842-
installElasticAgent: `${FLEET_DOCS}install-fleet-managed-elastic-agent.html`,
843-
installElasticAgentStandalone: `${FLEET_DOCS}install-standalone-elastic-agent.html`,
844-
grantESAccessToStandaloneAgents: `${FLEET_DOCS}grant-access-to-elasticsearch.html`,
845-
upgradeElasticAgent: `${FLEET_DOCS}upgrade-elastic-agent.html`,
846-
learnMoreBlog: `${ELASTIC_WEBSITE_URL}blog/elastic-agent-and-fleet-make-it-easier-to-integrate-your-systems-with-elastic`,
823+
guide: `${ELASTIC_DOCS}reference/fleet`,
824+
fleetServer: `${ELASTIC_DOCS}reference/fleet/fleet-server`,
825+
fleetServerAddFleetServer: `${ELASTIC_DOCS}reference/fleet/deployment-models`,
826+
settings: `${ELASTIC_DOCS}reference/fleet/fleet-settings`,
827+
kafkaSettings: `${ELASTIC_DOCS}reference/fleet/kafka-output-settings`,
828+
kafkaOutputTopicsSettings: `${ELASTIC_DOCS}reference/fleet/kafka-output-settings#_topics_settings`,
829+
logstashSettings: `${ELASTIC_DOCS}reference/fleet/ls-output-settings`,
830+
esSettings: `${ELASTIC_DOCS}reference/fleet/es-output-settings`,
831+
settingsFleetServerHostSettings: `${ELASTIC_DOCS}reference/fleet/fleet-settings#fleet-server-hosts-setting`,
832+
settingsFleetServerProxySettings: `${ELASTIC_DOCS}reference/kibana/configuration-reference/fleet-settings#fleet-data-visualizer-settings`,
833+
troubleshooting: `${ELASTIC_DOCS}troubleshoot/ingest/fleet/common-problems`,
834+
elasticAgent: `${ELASTIC_DOCS}reference/fleet/install-elastic-agents`,
835+
beatsAgentComparison: `${ELASTIC_DOCS}manage-data/ingest/tools`,
836+
datastreams: `${ELASTIC_DOCS}reference/fleet/data-streams`,
837+
datastreamsILM: `${ELASTIC_DOCS}reference/fleet/data-streams#data-streams-ilm`,
838+
datastreamsNamingScheme: `${ELASTIC_DOCS}reference/fleet/data-streams#data-streams-naming-scheme`,
839+
datastreamsManualRollover: `${ELASTIC_DOCS}manage-data/data-store/data-streams/use-data-stream#manually-roll-over-a-data-stream`,
840+
datastreamsTSDS: `${ELASTIC_DOCS}manage-data/data-store/data-streams/time-series-data-stream-tsds`,
841+
datastreamsTSDSMetrics: `${ELASTIC_DOCS}manage-data/data-store/data-streams/time-series-data-stream-tsds#time-series-metric`,
842+
datastreamsDownsampling: `${ELASTIC_DOCS}manage-data/data-store/data-streams/downsampling-time-series-data-stream`,
843+
installElasticAgent: `${ELASTIC_DOCS}reference/fleet/install-fleet-managed-elastic-agent`,
844+
installElasticAgentStandalone: `${ELASTIC_DOCS}reference/fleet/install-standalone-elastic-agent`,
845+
grantESAccessToStandaloneAgents: `${ELASTIC_DOCS}reference/fleet/grant-access-to-elasticsearch`,
846+
upgradeElasticAgent: `${ELASTIC_DOCS}reference/fleet/upgrade-elastic-agent`,
847+
learnMoreBlog: `https://www.elastic.co/blog/elastic-agent-and-fleet-make-it-easier-to-integrate-your-systems-with-elastic`,
847848
apiKeysLearnMore: isServerless
848-
? `${SERVERLESS_DOCS}api-keys.html`
849-
: `${KIBANA_DOCS}api-keys.html`,
850-
onPremRegistry: `${FLEET_DOCS}air-gapped.html`,
851-
packageSignatures: `${FLEET_DOCS}package-signatures.html`,
852-
secureLogstash: `${FLEET_DOCS}secure-logstash-connections.html`,
853-
agentPolicy: `${FLEET_DOCS}agent-policy.html`,
854-
api: `${FLEET_DOCS}fleet-api-docs.html`,
855-
uninstallAgent: `${SECURITY_SOLUTION_DOCS}uninstall-agent.html`,
856-
installAndUninstallIntegrationAssets: `${FLEET_DOCS}install-uninstall-integration-assets.html`,
857-
elasticAgentInputConfiguration: `${FLEET_DOCS}elastic-agent-input-configuration.html`,
858-
policySecrets: `${FLEET_DOCS}agent-policy.html#agent-policy-secret-values`,
859-
remoteESOoutput: `${FLEET_DOCS}monitor-elastic-agent.html#external-elasticsearch-monitoring`,
860-
performancePresets: `${FLEET_DOCS}es-output-settings.html#es-output-settings-performance-tuning-settings`,
861-
scalingKubernetesResourcesAndLimits: `${FLEET_DOCS}scaling-on-kubernetes.html#_specifying_resources_and_limits_in_agent_manifests`,
862-
roleAndPrivileges: `${FLEET_DOCS}fleet-roles-and-privileges.html`,
863-
proxiesSettings: `${FLEET_DOCS}fleet-agent-proxy-support.html`,
864-
unprivilegedMode: `${FLEET_DOCS}elastic-agent-unprivileged.html#unprivileged-change-mode`,
865-
httpMonitoring: `${FLEET_DOCS}agent-policy.html#change-policy-enable-agent-monitoring`,
849+
? `${ELASTIC_DOCS}deploy-manage/api-keys/serverless-project-api-keys`
850+
: `${ELASTIC_DOCS}deploy-manage/api-keys/elasticsearch-api-keys`,
851+
onPremRegistry: `${ELASTIC_DOCS}reference/fleet/air-gapped`,
852+
packageSignatures: `${ELASTIC_DOCS}reference/fleet/package-signatures`,
853+
secureLogstash: `${ELASTIC_DOCS}reference/fleet/secure-logstash-connections`,
854+
agentPolicy: `${ELASTIC_DOCS}reference/fleet/agent-policy`,
855+
agentlessIntegrations: `${ELASTIC_DOCS}solutions/security/get-started/agentless-integrations`,
856+
api: `${ELASTIC_DOCS}reference/fleet/fleet-api-docs`,
857+
uninstallAgent: `${ELASTIC_DOCS}solutions/security/configure-elastic-defend/uninstall-elastic-agent`,
858+
installAndUninstallIntegrationAssets: `${ELASTIC_DOCS}reference/fleet/install-uninstall-integration-assets`,
859+
elasticAgentInputConfiguration: `${ELASTIC_DOCS}reference/fleet/elastic-agent-input-configuration`,
860+
policySecrets: `${ELASTIC_DOCS}reference/fleet/agent-policy#agent-policy-secret-values`,
861+
remoteESOoutput: `${ELASTIC_DOCS}reference/fleet/remote-elasticsearch-output`,
862+
performancePresets: `${ELASTIC_DOCS}reference/fleet/es-output-settings#es-output-settings-performance-tuning-settings`,
863+
scalingKubernetesResourcesAndLimits: `${ELASTIC_DOCS}reference/fleet/scaling-on-kubernetes#_specifying_resources_and_limits_in_agent_manifests`,
864+
roleAndPrivileges: `${ELASTIC_DOCS}reference/fleet/fleet-roles-privileges`,
865+
proxiesSettings: `${ELASTIC_DOCS}reference/fleet/fleet-agent-proxy-support`,
866+
unprivilegedMode: `${ELASTIC_DOCS}reference/fleet/elastic-agent-unprivileged#unprivileged-change-mode`,
867+
httpMonitoring: `${ELASTIC_DOCS}reference/fleet/agent-policy#change-policy-enable-agent-monitoring`,
868+
agentLevelLogging: `${ELASTIC_DOCS}reference/fleet/monitor-elastic-agent#change-logging-level`,
866869
},
867870
integrationDeveloper: {
868871
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)