Skip to content

Commit b74acba

Browse files
dedemortondedemorton
committed
[DOCS] Update links to Beats documentation (#70380)
* Update links to Beats documentation * Update snapshot files * Fix lint errors
1 parent 8fe4265 commit b74acba

19 files changed

Lines changed: 86 additions & 71 deletions

File tree

‎docs/management/watcher-ui/index.asciidoc‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -60,7 +60,7 @@ The following example walks you through creating a threshold alert. The alert
6060
is triggered when the maximum total CPU usage on a machine goes above a
6161
certain percentage. The example uses https://www.elastic.co/products/beats/metricbeat[Metricbeat]
6262
to collect metrics from your systems and services.
63-
{metricbeat-ref}/metricbeat-installation.html[Learn more] on how to install
63+
{metricbeat-ref}/metricbeat-installation-configuration.html[Learn more] on how to install
6464
and get started with Metricbeat.
6565

6666
[float]

‎docs/user/monitoring/monitoring-metricbeat.asciidoc‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -82,7 +82,7 @@ For more information, see {ref}/monitoring-settings.html[Monitoring settings in
8282
and {ref}/cluster-update-settings.html[Cluster update settings].
8383
--
8484

85-
. {metricbeat-ref}/metricbeat-installation.html[Install {metricbeat}] on the
85+
. {metricbeat-ref}/metricbeat-installation-configuration.html[Install {metricbeat}] on the
8686
same server as {kib}.
8787

8888
. Enable the {kib} {xpack} module in {metricbeat}. +

‎src/core/public/doc_links/doc_links_service.ts‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -41,8 +41,8 @@ export class DocLinksService {
4141
},
4242
filebeat: {
4343
base: `${ELASTIC_WEBSITE_URL}guide/en/beats/filebeat/${DOC_LINK_VERSION}`,
44-
installation: `${ELASTIC_WEBSITE_URL}guide/en/beats/filebeat/${DOC_LINK_VERSION}/filebeat-installation.html`,
45-
configuration: `${ELASTIC_WEBSITE_URL}guide/en/beats/filebeat/${DOC_LINK_VERSION}/filebeat-configuration.html`,
44+
installation: `${ELASTIC_WEBSITE_URL}guide/en/beats/filebeat/${DOC_LINK_VERSION}/filebeat-installation-configuration.html`,
45+
configuration: `${ELASTIC_WEBSITE_URL}guide/en/beats/filebeat/${DOC_LINK_VERSION}/configuring-howto-filebeat.html`,
4646
elasticsearchOutput: `${ELASTIC_WEBSITE_URL}guide/en/beats/filebeat/${DOC_LINK_VERSION}/elasticsearch-output.html`,
4747
startup: `${ELASTIC_WEBSITE_URL}guide/en/beats/filebeat/${DOC_LINK_VERSION}/filebeat-starting.html`,
4848
exportedFields: `${ELASTIC_WEBSITE_URL}guide/en/beats/filebeat/${DOC_LINK_VERSION}/exported-fields.html`,

‎src/plugins/home/server/tutorials/cloudwatch_logs/index.ts‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,8 @@ export function cloudwatchLogsSpecProvider(context: TutorialContext): TutorialSc
4747
an AWS Lambda function. \
4848
[Learn more]({learnMoreLink}).',
4949
values: {
50-
learnMoreLink: '{config.docs.beats.functionbeat}/functionbeat-getting-started.html',
50+
learnMoreLink:
51+
'{config.docs.beats.functionbeat}/functionbeat-installation-configuration.html',
5152
},
5253
}),
5354
euiIconType: 'logoAWS',

‎src/plugins/home/server/tutorials/instructions/auditbeat_instructions.ts‎

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -31,9 +31,9 @@ export const createAuditbeatInstructions = (context?: TutorialContext) => ({
3131
defaultMessage: 'Download and install Auditbeat',
3232
}),
3333
textPre: i18n.translate('home.tutorials.common.auditbeatInstructions.install.osxTextPre', {
34-
defaultMessage: 'First time using Auditbeat? See the [Getting Started Guide]({linkUrl}).',
34+
defaultMessage: 'First time using Auditbeat? See the [Quick Start]({linkUrl}).',
3535
values: {
36-
linkUrl: '{config.docs.beats.auditbeat}/auditbeat-getting-started.html',
36+
linkUrl: '{config.docs.beats.auditbeat}/auditbeat-installation-configuration.html',
3737
},
3838
}),
3939
commands: [
@@ -47,9 +47,9 @@ export const createAuditbeatInstructions = (context?: TutorialContext) => ({
4747
defaultMessage: 'Download and install Auditbeat',
4848
}),
4949
textPre: i18n.translate('home.tutorials.common.auditbeatInstructions.install.debTextPre', {
50-
defaultMessage: 'First time using Auditbeat? See the [Getting Started Guide]({linkUrl}).',
50+
defaultMessage: 'First time using Auditbeat? See the [Quick Start]({linkUrl}).',
5151
values: {
52-
linkUrl: '{config.docs.beats.auditbeat}/auditbeat-getting-started.html',
52+
linkUrl: '{config.docs.beats.auditbeat}/auditbeat-installation-configuration.html',
5353
},
5454
}),
5555
commands: [
@@ -68,9 +68,9 @@ export const createAuditbeatInstructions = (context?: TutorialContext) => ({
6868
defaultMessage: 'Download and install Auditbeat',
6969
}),
7070
textPre: i18n.translate('home.tutorials.common.auditbeatInstructions.install.rpmTextPre', {
71-
defaultMessage: 'First time using Auditbeat? See the [Getting Started Guide]({linkUrl}).',
71+
defaultMessage: 'First time using Auditbeat? See the [Quick Start]({linkUrl}).',
7272
values: {
73-
linkUrl: '{config.docs.beats.auditbeat}/auditbeat-getting-started.html',
73+
linkUrl: '{config.docs.beats.auditbeat}/auditbeat-installation-configuration.html',
7474
},
7575
}),
7676
commands: [
@@ -92,7 +92,7 @@ export const createAuditbeatInstructions = (context?: TutorialContext) => ({
9292
'home.tutorials.common.auditbeatInstructions.install.windowsTextPre',
9393
{
9494
defaultMessage:
95-
'First time using Auditbeat? See the [Getting Started Guide]({guideLinkUrl}).\n\
95+
'First time using Auditbeat? See the [Quick Start]({guideLinkUrl}).\n\
9696
1. Download the Auditbeat Windows zip file from the [Download]({auditbeatLinkUrl}) page.\n\
9797
2. Extract the contents of the zip file into {folderPath}.\n\
9898
3. Rename the `{directoryName}` directory to `Auditbeat`.\n\
@@ -101,7 +101,7 @@ export const createAuditbeatInstructions = (context?: TutorialContext) => ({
101101
5. From the PowerShell prompt, run the following commands to install Auditbeat as a Windows service.',
102102
values: {
103103
folderPath: '`C:\\Program Files`',
104-
guideLinkUrl: '{config.docs.beats.auditbeat}/auditbeat-getting-started.html',
104+
guideLinkUrl: '{config.docs.beats.auditbeat}/auditbeat-installation-configuration.html',
105105
auditbeatLinkUrl: 'https://www.elastic.co/downloads/beats/auditbeat',
106106
directoryName: 'auditbeat-{config.kibana.version}-windows',
107107
},

‎src/plugins/home/server/tutorials/instructions/filebeat_instructions.ts‎

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -31,9 +31,9 @@ export const createFilebeatInstructions = (context?: TutorialContext) => ({
3131
defaultMessage: 'Download and install Filebeat',
3232
}),
3333
textPre: i18n.translate('home.tutorials.common.filebeatInstructions.install.osxTextPre', {
34-
defaultMessage: 'First time using Filebeat? See the [Getting Started Guide]({linkUrl}).',
34+
defaultMessage: 'First time using Filebeat? See the [Quick Start]({linkUrl}).',
3535
values: {
36-
linkUrl: '{config.docs.beats.filebeat}/filebeat-getting-started.html',
36+
linkUrl: '{config.docs.beats.filebeat}/filebeat-installation-configuration.html',
3737
},
3838
}),
3939
commands: [
@@ -47,9 +47,9 @@ export const createFilebeatInstructions = (context?: TutorialContext) => ({
4747
defaultMessage: 'Download and install Filebeat',
4848
}),
4949
textPre: i18n.translate('home.tutorials.common.filebeatInstructions.install.debTextPre', {
50-
defaultMessage: 'First time using Filebeat? See the [Getting Started Guide]({linkUrl}).',
50+
defaultMessage: 'First time using Filebeat? See the [Quick Start]({linkUrl}).',
5151
values: {
52-
linkUrl: '{config.docs.beats.filebeat}/filebeat-getting-started.html',
52+
linkUrl: '{config.docs.beats.filebeat}/filebeat-installation-configuration.html',
5353
},
5454
}),
5555
commands: [
@@ -68,9 +68,9 @@ export const createFilebeatInstructions = (context?: TutorialContext) => ({
6868
defaultMessage: 'Download and install Filebeat',
6969
}),
7070
textPre: i18n.translate('home.tutorials.common.filebeatInstructions.install.rpmTextPre', {
71-
defaultMessage: 'First time using Filebeat? See the [Getting Started Guide]({linkUrl}).',
71+
defaultMessage: 'First time using Filebeat? See the [Quick Start]({linkUrl}).',
7272
values: {
73-
linkUrl: '{config.docs.beats.filebeat}/filebeat-getting-started.html',
73+
linkUrl: '{config.docs.beats.filebeat}/filebeat-installation-configuration.html',
7474
},
7575
}),
7676
commands: [
@@ -90,7 +90,7 @@ export const createFilebeatInstructions = (context?: TutorialContext) => ({
9090
}),
9191
textPre: i18n.translate('home.tutorials.common.filebeatInstructions.install.windowsTextPre', {
9292
defaultMessage:
93-
'First time using Filebeat? See the [Getting Started Guide]({guideLinkUrl}).\n\
93+
'First time using Filebeat? See the [Quick Start]({guideLinkUrl}).\n\
9494
1. Download the Filebeat Windows zip file from the [Download]({filebeatLinkUrl}) page.\n\
9595
2. Extract the contents of the zip file into {folderPath}.\n\
9696
3. Rename the `{directoryName}` directory to `Filebeat`.\n\
@@ -99,7 +99,7 @@ export const createFilebeatInstructions = (context?: TutorialContext) => ({
9999
5. From the PowerShell prompt, run the following commands to install Filebeat as a Windows service.',
100100
values: {
101101
folderPath: '`C:\\Program Files`',
102-
guideLinkUrl: '{config.docs.beats.filebeat}/filebeat-getting-started.html',
102+
guideLinkUrl: '{config.docs.beats.filebeat}/filebeat-installation-configuration.html',
103103
filebeatLinkUrl: 'https://www.elastic.co/downloads/beats/filebeat',
104104
directoryName: 'filebeat-{config.kibana.version}-windows',
105105
},

‎src/plugins/home/server/tutorials/instructions/functionbeat_instructions.ts‎

Lines changed: 11 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -31,8 +31,10 @@ export const createFunctionbeatInstructions = (context?: TutorialContext) => ({
3131
defaultMessage: 'Download and install Functionbeat',
3232
}),
3333
textPre: i18n.translate('home.tutorials.common.functionbeatInstructions.install.osxTextPre', {
34-
defaultMessage: 'First time using Functionbeat? See the [Getting Started Guide]({link}).',
35-
values: { link: '{config.docs.beats.functionbeat}/functionbeat-getting-started.html' },
34+
defaultMessage: 'First time using Functionbeat? See the [Quick Start]({link}).',
35+
values: {
36+
link: '{config.docs.beats.functionbeat}/functionbeat-installation-configuration.html',
37+
},
3638
}),
3739
commands: [
3840
'curl -L -O https://artifacts.elastic.co/downloads/beats/functionbeat/functionbeat-{config.kibana.version}-darwin-x86_64.tar.gz',
@@ -47,8 +49,10 @@ export const createFunctionbeatInstructions = (context?: TutorialContext) => ({
4749
textPre: i18n.translate(
4850
'home.tutorials.common.functionbeatInstructions.install.linuxTextPre',
4951
{
50-
defaultMessage: 'First time using Functionbeat? See the [Getting Started Guide]({link}).',
51-
values: { link: '{config.docs.beats.functionbeat}/functionbeat-getting-started.html' },
52+
defaultMessage: 'First time using Functionbeat? See the [Quick Start]({link}).',
53+
values: {
54+
link: '{config.docs.beats.functionbeat}/functionbeat-installation-configuration.html',
55+
},
5256
}
5357
),
5458
commands: [
@@ -65,7 +69,7 @@ export const createFunctionbeatInstructions = (context?: TutorialContext) => ({
6569
'home.tutorials.common.functionbeatInstructions.install.windowsTextPre',
6670
{
6771
defaultMessage:
68-
'First time using Functionbeat? See the [Getting Started Guide]({functionbeatLink}).\n\
72+
'First time using Functionbeat? See the [Quick Start]({functionbeatLink}).\n\
6973
1. Download the Functionbeat Windows zip file from the [Download]({elasticLink}) page.\n\
7074
2. Extract the contents of the zip file into {folderPath}.\n\
7175
3. Rename the {directoryName} directory to `Functionbeat`.\n\
@@ -75,7 +79,8 @@ export const createFunctionbeatInstructions = (context?: TutorialContext) => ({
7579
values: {
7680
directoryName: '`functionbeat-{config.kibana.version}-windows`',
7781
folderPath: '`C:\\Program Files`',
78-
functionbeatLink: '{config.docs.beats.functionbeat}/functionbeat-getting-started.html',
82+
functionbeatLink:
83+
'{config.docs.beats.functionbeat}/functionbeat-installation-configuration.html',
7984
elasticLink: 'https://www.elastic.co/downloads/beats/functionbeat',
8085
},
8186
}

‎src/plugins/home/server/tutorials/instructions/heartbeat_instructions.ts‎

Lines changed: 11 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -31,8 +31,8 @@ export const createHeartbeatInstructions = (context?: TutorialContext) => ({
3131
defaultMessage: 'Download and install Heartbeat',
3232
}),
3333
textPre: i18n.translate('home.tutorials.common.heartbeatInstructions.install.osxTextPre', {
34-
defaultMessage: 'First time using Heartbeat? See the [Getting Started Guide]({link}).',
35-
values: { link: '{config.docs.beats.heartbeat}/heartbeat-getting-started.html' },
34+
defaultMessage: 'First time using Heartbeat? See the [Quick Start]({link}).',
35+
values: { link: '{config.docs.beats.heartbeat}/heartbeat-installation-configuration.html' },
3636
}),
3737
commands: [
3838
'curl -L -O https://artifacts.elastic.co/downloads/beats/heartbeat/heartbeat-{config.kibana.version}-darwin-x86_64.tar.gz',
@@ -45,8 +45,8 @@ export const createHeartbeatInstructions = (context?: TutorialContext) => ({
4545
defaultMessage: 'Download and install Heartbeat',
4646
}),
4747
textPre: i18n.translate('home.tutorials.common.heartbeatInstructions.install.debTextPre', {
48-
defaultMessage: 'First time using Heartbeat? See the [Getting Started Guide]({link}).',
49-
values: { link: '{config.docs.beats.heartbeat}/heartbeat-getting-started.html' },
48+
defaultMessage: 'First time using Heartbeat? See the [Quick Start]({link}).',
49+
values: { link: '{config.docs.beats.heartbeat}/heartbeat-installation-configuration.html' },
5050
}),
5151
commands: [
5252
'curl -L -O https://artifacts.elastic.co/downloads/beats/heartbeat/heartbeat-{config.kibana.version}-amd64.deb',
@@ -62,8 +62,8 @@ export const createHeartbeatInstructions = (context?: TutorialContext) => ({
6262
defaultMessage: 'Download and install Heartbeat',
6363
}),
6464
textPre: i18n.translate('home.tutorials.common.heartbeatInstructions.install.rpmTextPre', {
65-
defaultMessage: 'First time using Heartbeat? See the [Getting Started Guide]({link}).',
66-
values: { link: '{config.docs.beats.heartbeat}/heartbeat-getting-started.html' },
65+
defaultMessage: 'First time using Heartbeat? See the [Quick Start]({link}).',
66+
values: { link: '{config.docs.beats.heartbeat}/heartbeat-installation-configuration.html' },
6767
}),
6868
commands: [
6969
'curl -L -O https://artifacts.elastic.co/downloads/beats/heartbeat/heartbeat-{config.kibana.version}-x86_64.rpm',
@@ -82,7 +82,7 @@ export const createHeartbeatInstructions = (context?: TutorialContext) => ({
8282
'home.tutorials.common.heartbeatInstructions.install.windowsTextPre',
8383
{
8484
defaultMessage:
85-
'First time using Heartbeat? See the [Getting Started Guide]({heartbeatLink}).\n\
85+
'First time using Heartbeat? See the [Quick Start]({heartbeatLink}).\n\
8686
1. Download the Heartbeat Windows zip file from the [Download]({elasticLink}) page.\n\
8787
2. Extract the contents of the zip file into {folderPath}.\n\
8888
3. Rename the {directoryName} directory to `Heartbeat`.\n\
@@ -92,7 +92,8 @@ export const createHeartbeatInstructions = (context?: TutorialContext) => ({
9292
values: {
9393
directoryName: '`heartbeat-{config.kibana.version}-windows`',
9494
folderPath: '`C:\\Program Files`',
95-
heartbeatLink: '{config.docs.beats.heartbeat}/heartbeat-getting-started.html',
95+
heartbeatLink:
96+
'{config.docs.beats.heartbeat}/heartbeat-installation-configuration.html',
9697
elasticLink: 'https://www.elastic.co/downloads/beats/heartbeat',
9798
},
9899
}
@@ -357,7 +358,7 @@ export function heartbeatEnableInstructionsOnPrem() {
357358
'Where {hostTemplate} is your monitored URL, For more details on how to configure Monitors in \
358359
Heartbeat, read the [Heartbeat configuration docs.]({configureLink})',
359360
values: {
360-
configureLink: '{config.docs.beats.heartbeat}/heartbeat-configuration.html',
361+
configureLink: '{config.docs.beats.heartbeat}/configuring-howto-heartbeat.html',
361362
hostTemplate: '`<http://localhost:9200>`',
362363
},
363364
}
@@ -428,7 +429,7 @@ export function heartbeatEnableInstructionsCloud() {
428429
{
429430
defaultMessage:
430431
'For more details on how to configure Monitors in Heartbeat, read the [Heartbeat configuration docs.]({configureLink})',
431-
values: { configureLink: '{config.docs.beats.heartbeat}/heartbeat-configuration.html' },
432+
values: { configureLink: '{config.docs.beats.heartbeat}/configuring-howto-heartbeat.html' },
432433
}
433434
);
434435
return {

‎src/plugins/home/server/tutorials/instructions/metricbeat_instructions.ts‎

Lines changed: 15 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -31,8 +31,10 @@ export const createMetricbeatInstructions = (context?: TutorialContext) => ({
3131
defaultMessage: 'Download and install Metricbeat',
3232
}),
3333
textPre: i18n.translate('home.tutorials.common.metricbeatInstructions.install.osxTextPre', {
34-
defaultMessage: 'First time using Metricbeat? See the [Getting Started Guide]({link}).',
35-
values: { link: '{config.docs.beats.metricbeat}/metricbeat-getting-started.html' },
34+
defaultMessage: 'First time using Metricbeat? See the [Quick Start]({link}).',
35+
values: {
36+
link: '{config.docs.beats.metricbeat}/metricbeat-installation-configuration.html',
37+
},
3638
}),
3739
commands: [
3840
'curl -L -O https://artifacts.elastic.co/downloads/beats/metricbeat/metricbeat-{config.kibana.version}-darwin-x86_64.tar.gz',
@@ -45,8 +47,10 @@ export const createMetricbeatInstructions = (context?: TutorialContext) => ({
4547
defaultMessage: 'Download and install Metricbeat',
4648
}),
4749
textPre: i18n.translate('home.tutorials.common.metricbeatInstructions.install.debTextPre', {
48-
defaultMessage: 'First time using Metricbeat? See the [Getting Started Guide]({link}).',
49-
values: { link: '{config.docs.beats.metricbeat}/metricbeat-getting-started.html' },
50+
defaultMessage: 'First time using Metricbeat? See the [Quick Start]({link}).',
51+
values: {
52+
link: '{config.docs.beats.metricbeat}/metricbeat-installation-configuration.html',
53+
},
5054
}),
5155
commands: [
5256
'curl -L -O https://artifacts.elastic.co/downloads/beats/metricbeat/metricbeat-{config.kibana.version}-amd64.deb',
@@ -62,8 +66,10 @@ export const createMetricbeatInstructions = (context?: TutorialContext) => ({
6266
defaultMessage: 'Download and install Metricbeat',
6367
}),
6468
textPre: i18n.translate('home.tutorials.common.metricbeatInstructions.install.rpmTextPre', {
65-
defaultMessage: 'First time using Metricbeat? See the [Getting Started Guide]({link}).',
66-
values: { link: '{config.docs.beats.metricbeat}/metricbeat-getting-started.html' },
69+
defaultMessage: 'First time using Metricbeat? See the [Quick Start]({link}).',
70+
values: {
71+
link: '{config.docs.beats.metricbeat}/metricbeat-installation-configuration.html',
72+
},
6773
}),
6874
commands: [
6975
'curl -L -O https://artifacts.elastic.co/downloads/beats/metricbeat/metricbeat-{config.kibana.version}-x86_64.rpm',
@@ -82,7 +88,7 @@ export const createMetricbeatInstructions = (context?: TutorialContext) => ({
8288
'home.tutorials.common.metricbeatInstructions.install.windowsTextPre',
8389
{
8490
defaultMessage:
85-
'First time using Metricbeat? See the [Getting Started Guide]({metricbeatLink}).\n\
91+
'First time using Metricbeat? See the [Quick Start]({metricbeatLink}).\n\
8692
1. Download the Metricbeat Windows zip file from the [Download]({elasticLink}) page.\n\
8793
2. Extract the contents of the zip file into {folderPath}.\n\
8894
3. Rename the {directoryName} directory to `Metricbeat`.\n\
@@ -92,7 +98,8 @@ export const createMetricbeatInstructions = (context?: TutorialContext) => ({
9298
values: {
9399
directoryName: '`metricbeat-{config.kibana.version}-windows`',
94100
folderPath: '`C:\\Program Files`',
95-
metricbeatLink: '{config.docs.beats.metricbeat}/metricbeat-getting-started.html',
101+
metricbeatLink:
102+
'{config.docs.beats.metricbeat}/metricbeat-installation-configuration.html',
96103
elasticLink: 'https://www.elastic.co/downloads/beats/metricbeat',
97104
},
98105
}

0 commit comments

Comments
 (0)