Skip to content

Use new beat URLs in doc link service #219310

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 13 commits into from
May 9, 2025
Merged

Use new beat URLs in doc link service #219310

Show file tree
Hide file tree
Changes from 11 commits
Commits
Show all changes
13 commits
Select commit Hold shift + click to select a range
6bface6
Use new beat URLs in doc link service
lcawl Apr 25, 2025
f36e736
Remove FLEET_DOCS variable
lcawl Apr 25, 2025
cd59946
Merge branch 'main' into beat-links
lcawl Apr 28, 2025
0f371cc
[CI] Auto-commit changed files from 'node scripts/eslint --no-cache -…
kibanamachine Apr 28, 2025
ee2a9f4
Fix jest error in index_patterns_missing_prompt.test.tsx
lcawl Apr 29, 2025
b2054f3
Fix jest error in monitor_status.bar.test.tsx
lcawl Apr 29, 2025
1e09c7e
Merge branch 'main' into beat-links
lcawl Apr 29, 2025
15c1aa6
Fix partial URL in monitor_tags.tsx
lcawl Apr 29, 2025
2d21178
Merge branch 'main' into beat-links
lcawl Apr 30, 2025
eb703fb
Merge branch 'main' into beat-links
lcawl May 5, 2025
fbf337e
Merge branch 'main' into beat-links
lcawl May 8, 2025
e5ef404
Merge branch 'main' into beat-links
lcawl May 9, 2025
36beddc
Remove extra variable
lcawl May 9, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
130 changes: 65 additions & 65 deletions src/platform/packages/shared/kbn-doc-links/src/get_doc_links.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,6 @@ export const getDocLinks = ({ kibanaBranch, buildFlavor }: GetDocLinkOptions): D
const KIBANA_DOCS = `${ELASTIC_WEBSITE_URL}guide/en/kibana/${DOC_LINK_VERSION}/`;
const KIBANA_APIS = `${API_DOCS}doc/kibana/`;
const KIBANA_SERVERLESS_APIS = `{$API_DOCS}doc/serverless/`;
const FLEET_DOCS = `${ELASTIC_WEBSITE_URL}guide/en/fleet/${DOC_LINK_VERSION}/`;
const INTEGRATIONS_DEV_DOCS = `${ELASTIC_WEBSITE_URL}guide/en/integrations-developer/current/`;
const OBSERVABILITY_DOCS = `${ELASTIC_WEBSITE_URL}guide/en/observability/${DOC_LINK_VERSION}/`;
const SECURITY_SOLUTION_DOCS = `${ELASTIC_WEBSITE_URL}guide/en/security/${DOC_LINK_VERSION}/`;
Expand Down Expand Up @@ -104,20 +103,20 @@ export const getDocLinks = ({ kibanaBranch, buildFlavor }: GetDocLinkOptions): D
documentExplorer: `${ELASTIC_DOCS}explore-analyze/discover/document-explorer`,
},
filebeat: {
base: `${ELASTIC_WEBSITE_URL}guide/en/beats/filebeat/${DOC_LINK_VERSION}`,
installation: `${ELASTIC_WEBSITE_URL}guide/en/beats/filebeat/${DOC_LINK_VERSION}/filebeat-installation-configuration.html`,
configuration: `${ELASTIC_WEBSITE_URL}guide/en/beats/filebeat/${DOC_LINK_VERSION}/configuring-howto-filebeat.html`,
elasticsearchModule: `${ELASTIC_WEBSITE_URL}guide/en/beats/filebeat/${DOC_LINK_VERSION}/filebeat-module-elasticsearch.html`,
elasticsearchOutput: `${ELASTIC_WEBSITE_URL}guide/en/beats/filebeat/${DOC_LINK_VERSION}/elasticsearch-output.html`,
startup: `${ELASTIC_WEBSITE_URL}guide/en/beats/filebeat/${DOC_LINK_VERSION}/filebeat-starting.html`,
exportedFields: `${ELASTIC_WEBSITE_URL}guide/en/beats/filebeat/${DOC_LINK_VERSION}/exported-fields.html`,
suricataModule: `${ELASTIC_WEBSITE_URL}guide/en/beats/filebeat/${DOC_LINK_VERSION}/filebeat-module-suricata.html`,
zeekModule: `${ELASTIC_WEBSITE_URL}guide/en/beats/filebeat/${DOC_LINK_VERSION}/filebeat-module-zeek.html`,
base: `${ELASTIC_DOCS}reference/beats/filebeat`,
installation: `${ELASTIC_DOCS}reference/beats/filebeat/filebeat-installation-configuration`,
configuration: `${ELASTIC_DOCS}reference/beats/filebeat/configuring-howto-filebeat`,
elasticsearchModule: `${ELASTIC_DOCS}reference/beats/filebeat/filebeat-module-elasticsearch`,
elasticsearchOutput: `${ELASTIC_DOCS}reference/beats/filebeat/elasticsearch-output`,
startup: `${ELASTIC_DOCS}reference/beats/filebeat/filebeat-starting`,
exportedFields: `${ELASTIC_DOCS}reference/beats/filebeat/exported-fields`,
suricataModule: `${ELASTIC_DOCS}reference/beats/filebeat/filebeat-module-suricata`,
zeekModule: `${ELASTIC_DOCS}reference/beats/filebeat/filebeat-module-zeek`,
},
auditbeat: {
base: `${ELASTIC_WEBSITE_URL}guide/en/beats/auditbeat/${DOC_LINK_VERSION}`,
auditdModule: `${ELASTIC_WEBSITE_URL}guide/en/beats/auditbeat/${DOC_LINK_VERSION}/auditbeat-module-auditd.html`,
systemModule: `${ELASTIC_WEBSITE_URL}guide/en/beats/auditbeat/${DOC_LINK_VERSION}/auditbeat-module-system.html`,
base: `${ELASTIC_DOCS}reference/beats/auditbeat`,
auditdModule: `${ELASTIC_DOCS}reference/beats/auditbeat/auditbeat-module-auditd`,
systemModule: `${ELASTIC_DOCS}reference/beats/auditbeat/auditbeat-module-system`,
},
enterpriseSearch: {
aiSearchDoc: `${ESRE_DOCS}`,
Expand Down Expand Up @@ -209,24 +208,25 @@ export const getDocLinks = ({ kibanaBranch, buildFlavor }: GetDocLinkOptions): D
usersAccess: `${ENTERPRISE_SEARCH_DOCS}users-access.html`,
},
metricbeat: {
base: `${ELASTIC_WEBSITE_URL}guide/en/beats/metricbeat/${DOC_LINK_VERSION}`,
configure: `${ELASTIC_WEBSITE_URL}guide/en/beats/metricbeat/${DOC_LINK_VERSION}/configuring-howto-metricbeat.html`,
httpEndpoint: `${ELASTIC_WEBSITE_URL}guide/en/beats/metricbeat/${DOC_LINK_VERSION}/http-endpoint.html`,
install: `${ELASTIC_WEBSITE_URL}guide/en/beats/metricbeat/${DOC_LINK_VERSION}/metricbeat-installation-configuration.html`,
start: `${ELASTIC_WEBSITE_URL}guide/en/beats/metricbeat/${DOC_LINK_VERSION}/metricbeat-starting.html`,
base: `${ELASTIC_DOCS}reference/beats/metricbeat`,
configure: `${ELASTIC_DOCS}reference/beats/metricbeat/configuring-howto-metricbeat`,
httpEndpoint: `${ELASTIC_DOCS}reference/beats/metricbeat/http-endpoint`,
install: `${ELASTIC_DOCS}reference/beats/metricbeat/metricbeat-installation-configuration`,
start: `${ELASTIC_DOCS}reference/beats/metricbeat/metricbeat-starting`,
},
heartbeat: {
base: `${ELASTIC_WEBSITE_URL}guide/en/beats/heartbeat/${DOC_LINK_VERSION}`,
base: `${ELASTIC_DOCS}reference/beats/heartbeat`,
monitorTags: `${ELASTIC_DOCS}reference/beats/heartbeat/monitor-options#monitor-tags`,
},
libbeat: {
getStarted: `${ELASTIC_WEBSITE_URL}guide/en/beats/libbeat/${DOC_LINK_VERSION}/getting-started.html`,
getStarted: `${ELASTIC_DOCS}reference/beats`,
},
logstash: {
base: `${ELASTIC_WEBSITE_URL}guide/en/logstash/${DOC_LINK_VERSION}`,
inputElasticAgent: `${ELASTIC_WEBSITE_URL}guide/en/logstash/${DOC_LINK_VERSION}/plugins-inputs-elastic_agent.html`,
},
winlogbeat: {
base: `${ELASTIC_WEBSITE_URL}guide/en/beats/winlogbeat/${DOC_LINK_VERSION}`,
base: `${ELASTIC_DOCS}reference/beats/winlogbeat`,
},
aggs: {
composite: `${ELASTIC_DOCS}reference/aggregations/search-aggregations-bucket-composite-aggregation`,
Expand Down Expand Up @@ -868,52 +868,52 @@ export const getDocLinks = ({ kibanaBranch, buildFlavor }: GetDocLinkOptions): D
userAgent: `${ELASTICSEARCH_DOCS}user-agent-processor.html`,
},
fleet: {
guide: `${FLEET_DOCS}index.html`,
fleetServer: `${FLEET_DOCS}fleet-server.html`,
fleetServerAddFleetServer: `${FLEET_DOCS}add-a-fleet-server.html`,
settings: `${FLEET_DOCS}fleet-settings.html`,
kafkaSettings: `${FLEET_DOCS}kafka-output-settings.html`,
kafkaOutputTopicsSettings: `${FLEET_DOCS}kafka-output-settings.html#_topics_settings`,
logstashSettings: `${FLEET_DOCS}ls-output-settings.html`,
esSettings: `${FLEET_DOCS}es-output-settings.html`,
settingsFleetServerHostSettings: `${FLEET_DOCS}fleet-settings.html#fleet-server-hosts-setting`,
settingsFleetServerProxySettings: `${KIBANA_DOCS}fleet-settings-kb.html#fleet-data-visualizer-settings`,
troubleshooting: `${FLEET_DOCS}fleet-troubleshooting.html`,
elasticAgent: `${FLEET_DOCS}elastic-agent-installation.html`,
beatsAgentComparison: `${FLEET_DOCS}beats-agent-comparison.html`,
datastreams: `${FLEET_DOCS}data-streams.html`,
datastreamsILM: `${FLEET_DOCS}data-streams.html#data-streams-ilm`,
datastreamsNamingScheme: `${FLEET_DOCS}data-streams.html#data-streams-naming-scheme`,
datastreamsManualRollover: `${ELASTICSEARCH_DOCS}use-a-data-stream.html#manually-roll-over-a-data-stream`,
datastreamsTSDS: `${ELASTICSEARCH_DOCS}tsds.html`,
datastreamsTSDSMetrics: `${ELASTICSEARCH_DOCS}tsds.html#time-series-metric`,
datastreamsDownsampling: `${ELASTICSEARCH_DOCS}downsampling.html`,
installElasticAgent: `${FLEET_DOCS}install-fleet-managed-elastic-agent.html`,
installElasticAgentStandalone: `${FLEET_DOCS}install-standalone-elastic-agent.html`,
grantESAccessToStandaloneAgents: `${FLEET_DOCS}grant-access-to-elasticsearch.html`,
upgradeElasticAgent: `${FLEET_DOCS}upgrade-elastic-agent.html`,
learnMoreBlog: `${ELASTIC_WEBSITE_URL}blog/elastic-agent-and-fleet-make-it-easier-to-integrate-your-systems-with-elastic`,
guide: `${ELASTIC_DOCS}reference/fleet`,
fleetServer: `${ELASTIC_DOCS}reference/fleet/fleet-server`,
fleetServerAddFleetServer: `${ELASTIC_DOCS}reference/fleet/deployment-models`,
settings: `${ELASTIC_DOCS}reference/fleet/fleet-settings`,
kafkaSettings: `${ELASTIC_DOCS}reference/fleet/kafka-output-settings`,
kafkaOutputTopicsSettings: `${ELASTIC_DOCS}reference/fleet/kafka-output-settings#_topics_settings`,
logstashSettings: `${ELASTIC_DOCS}reference/fleet/ls-output-settings`,
esSettings: `${ELASTIC_DOCS}reference/fleet/es-output-settings`,
settingsFleetServerHostSettings: `${ELASTIC_DOCS}reference/fleet/fleet-settings#fleet-server-hosts-setting`,
settingsFleetServerProxySettings: `${ELASTIC_DOCS}reference/kibana/configuration-reference/fleet-settings#fleet-data-visualizer-settings`,
troubleshooting: `${ELASTIC_DOCS}troubleshoot/ingest/fleet/common-problems`,
elasticAgent: `${ELASTIC_DOCS}reference/fleet/install-elastic-agents`,
beatsAgentComparison: `${ELASTIC_DOCS}manage-data/ingest/tools`,
datastreams: `${ELASTIC_DOCS}reference/fleet/data-streams`,
datastreamsILM: `${ELASTIC_DOCS}reference/fleet/data-streams#data-streams-ilm`,
datastreamsNamingScheme: `${ELASTIC_DOCS}reference/fleet/data-streams#data-streams-naming-scheme`,
datastreamsManualRollover: `${ELASTIC_DOCS}manage-data/data-store/data-streams/use-data-stream#manually-roll-over-a-data-stream`,
datastreamsTSDS: `${ELASTIC_DOCS}manage-data/data-store/data-streams/time-series-data-stream-tsds`,
datastreamsTSDSMetrics: `${ELASTIC_DOCS}manage-data/data-store/data-streams/time-series-data-stream-tsds#time-series-metric`,
datastreamsDownsampling: `${ELASTIC_DOCS}manage-data/data-store/data-streams/downsampling-time-series-data-stream`,
installElasticAgent: `${ELASTIC_DOCS}reference/fleet/install-fleet-managed-elastic-agent`,
installElasticAgentStandalone: `${ELASTIC_DOCS}reference/fleet/install-standalone-elastic-agent`,
grantESAccessToStandaloneAgents: `${ELASTIC_DOCS}reference/fleet/grant-access-to-elasticsearch`,
upgradeElasticAgent: `${ELASTIC_DOCS}reference/fleet/upgrade-elastic-agent`,
learnMoreBlog: `https://www.elastic.co/blog/elastic-agent-and-fleet-make-it-easier-to-integrate-your-systems-with-elastic`,
apiKeysLearnMore: isServerless
? `${SERVERLESS_DOCS}api-keys.html`
: `${KIBANA_DOCS}api-keys.html`,
onPremRegistry: `${FLEET_DOCS}air-gapped.html`,
packageSignatures: `${FLEET_DOCS}package-signatures.html`,
secureLogstash: `${FLEET_DOCS}secure-logstash-connections.html`,
agentPolicy: `${FLEET_DOCS}agent-policy.html`,
? `${ELASTIC_DOCS}deploy-manage/api-keys/serverless-project-api-keys`
: `${ELASTIC_DOCS}deploy-manage/api-keys/elasticsearch-api-keys`,
onPremRegistry: `${ELASTIC_DOCS}reference/fleet/air-gapped`,
packageSignatures: `${ELASTIC_DOCS}reference/fleet/package-signatures`,
secureLogstash: `${ELASTIC_DOCS}reference/fleet/secure-logstash-connections`,
agentPolicy: `${ELASTIC_DOCS}reference/fleet/agent-policy`,
agentlessIntegrations: `${ELASTIC_DOCS}solutions/security/get-started/agentless-integrations`,
api: `${FLEET_DOCS}fleet-api-docs.html`,
uninstallAgent: `${SECURITY_SOLUTION_DOCS}uninstall-agent.html`,
installAndUninstallIntegrationAssets: `${FLEET_DOCS}install-uninstall-integration-assets.html`,
elasticAgentInputConfiguration: `${FLEET_DOCS}elastic-agent-input-configuration.html`,
policySecrets: `${FLEET_DOCS}agent-policy.html#agent-policy-secret-values`,
remoteESOoutput: `${FLEET_DOCS}remote-elasticsearch-output.html`,
performancePresets: `${FLEET_DOCS}es-output-settings.html#es-output-settings-performance-tuning-settings`,
scalingKubernetesResourcesAndLimits: `${FLEET_DOCS}scaling-on-kubernetes.html#_specifying_resources_and_limits_in_agent_manifests`,
roleAndPrivileges: `${FLEET_DOCS}fleet-roles-and-privileges.html`,
proxiesSettings: `${FLEET_DOCS}fleet-agent-proxy-support.html`,
unprivilegedMode: `${FLEET_DOCS}elastic-agent-unprivileged.html#unprivileged-change-mode`,
httpMonitoring: `${FLEET_DOCS}agent-policy.html#change-policy-enable-agent-monitoring`,
agentLevelLogging: `${FLEET_DOCS}monitor-elastic-agent.html#change-logging-level`,
api: `${ELASTIC_DOCS}reference/fleet/fleet-api-docs`,
uninstallAgent: `${ELASTIC_DOCS}solutions/security/configure-elastic-defend/uninstall-elastic-agent`,
installAndUninstallIntegrationAssets: `${ELASTIC_DOCS}reference/fleet/install-uninstall-integration-assets`,
elasticAgentInputConfiguration: `${ELASTIC_DOCS}reference/fleet/elastic-agent-input-configuration`,
policySecrets: `${ELASTIC_DOCS}reference/fleet/agent-policy#agent-policy-secret-values`,
remoteESOoutput: `${ELASTIC_DOCS}reference/fleet/remote-elasticsearch-output`,
performancePresets: `${ELASTIC_DOCS}reference/fleet/es-output-settings#es-output-settings-performance-tuning-settings`,
scalingKubernetesResourcesAndLimits: `${ELASTIC_DOCS}reference/fleet/scaling-on-kubernetes#_specifying_resources_and_limits_in_agent_manifests`,
roleAndPrivileges: `${ELASTIC_DOCS}reference/fleet/fleet-roles-privileges`,
proxiesSettings: `${ELASTIC_DOCS}reference/fleet/fleet-agent-proxy-support`,
unprivilegedMode: `${ELASTIC_DOCS}reference/fleet/elastic-agent-unprivileged#unprivileged-change-mode`,
httpMonitoring: `${ELASTIC_DOCS}reference/fleet/agent-policy#change-policy-enable-agent-monitoring`,
agentLevelLogging: `${ELASTIC_DOCS}reference/fleet/monitor-elastic-agent#change-logging-level`,
},
integrationDeveloper: {
upload: `${INTEGRATIONS_DEV_DOCS}upload-a-new-integration.html`,
Expand Down
1 change: 1 addition & 0 deletions src/platform/packages/shared/kbn-doc-links/src/types.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -172,6 +172,7 @@ export interface DocLinks {
};
readonly heartbeat: {
readonly base: string;
readonly monitorTags: string;
};
readonly libbeat: {
readonly getStarted: string;
Expand Down
2 changes: 1 addition & 1 deletion ...ions/observability/plugins/uptime/public/legacy_uptime/components/common/monitor_tags.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -82,7 +82,7 @@ export const MonitorTags = ({ ping, summary }: Props) => {
return summary ? null : (
<EuiLink
data-test-subj="syntheticsMonitorTagsSetTagsLink"
href={docLinks?.links.heartbeat.base + '/monitor-options.html#monitor-tags'}
href={docLinks?.links.heartbeat.monitorTags}
target="_blank"
>
Set tags
Expand Down
2 changes: 1 addition & 1 deletion ...y_uptime/components/monitor/status_details/__snapshots__/monitor_status.bar.test.tsx.snap
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion .../network/components/embeddables/__snapshots__/index_patterns_missing_prompt.test.tsx.snap
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.