Skip to content
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

[DOCS] Update links to Beats documentation #70380

Merged
merged 3 commits into from
Aug 21, 2020
Merged

[DOCS] Update links to Beats documentation #70380

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
0867520
Update links to Beats documentation
dedemorton Jun 30, 2020
ee345fa
Update snapshot files
dedemorton Aug 21, 2020
726f701
Fix lint errors
dedemorton Aug 21, 2020
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
2 changes: 1 addition & 1 deletion docs/management/watcher-ui/index.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,7 @@ The following example walks you through creating a threshold alert. The alert
is triggered when the maximum total CPU usage on a machine goes above a
certain percentage. The example uses https://www.elastic.co/products/beats/metricbeat[Metricbeat]
to collect metrics from your systems and services.
{metricbeat-ref}/metricbeat-installation.html[Learn more] on how to install
{metricbeat-ref}/metricbeat-installation-configuration.html[Learn more] on how to install
and get started with Metricbeat.

[float]
Expand Down
2 changes: 1 addition & 1 deletion docs/user/monitoring/monitoring-metricbeat.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -82,7 +82,7 @@ For more information, see {ref}/monitoring-settings.html[Monitoring settings in
and {ref}/cluster-update-settings.html[Cluster update settings].
--

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

. Enable the {kib} {xpack} module in {metricbeat}. +
Expand Down
4 changes: 2 additions & 2 deletions src/core/public/doc_links/doc_links_service.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,8 +41,8 @@ export class DocLinksService {
},
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.html`,
configuration: `${ELASTIC_WEBSITE_URL}guide/en/beats/filebeat/${DOC_LINK_VERSION}/filebeat-configuration.html`,
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`,
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`,
Expand Down
3 changes: 2 additions & 1 deletion src/plugins/home/server/tutorials/cloudwatch_logs/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,8 @@ export function cloudwatchLogsSpecProvider(context: TutorialContext): TutorialSc
an AWS Lambda function. \
[Learn more]({learnMoreLink}).',
values: {
learnMoreLink: '{config.docs.beats.functionbeat}/functionbeat-getting-started.html',
learnMoreLink:
'{config.docs.beats.functionbeat}/functionbeat-installation-configuration.html',
},
}),
euiIconType: 'logoAWS',
Expand Down
16 changes: 8 additions & 8 deletions src/plugins/home/server/tutorials/instructions/auditbeat_instructions.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,9 +31,9 @@ export const createAuditbeatInstructions = (context?: TutorialContext) => ({
defaultMessage: 'Download and install Auditbeat',
}),
textPre: i18n.translate('home.tutorials.common.auditbeatInstructions.install.osxTextPre', {
defaultMessage: 'First time using Auditbeat? See the [Getting Started Guide]({linkUrl}).',
defaultMessage: 'First time using Auditbeat? See the [Quick Start]({linkUrl}).',
values: {
linkUrl: '{config.docs.beats.auditbeat}/auditbeat-getting-started.html',
linkUrl: '{config.docs.beats.auditbeat}/auditbeat-installation-configuration.html',
},
}),
commands: [
Expand All @@ -47,9 +47,9 @@ export const createAuditbeatInstructions = (context?: TutorialContext) => ({
defaultMessage: 'Download and install Auditbeat',
}),
textPre: i18n.translate('home.tutorials.common.auditbeatInstructions.install.debTextPre', {
defaultMessage: 'First time using Auditbeat? See the [Getting Started Guide]({linkUrl}).',
defaultMessage: 'First time using Auditbeat? See the [Quick Start]({linkUrl}).',
values: {
linkUrl: '{config.docs.beats.auditbeat}/auditbeat-getting-started.html',
linkUrl: '{config.docs.beats.auditbeat}/auditbeat-installation-configuration.html',
},
}),
commands: [
Expand All @@ -68,9 +68,9 @@ export const createAuditbeatInstructions = (context?: TutorialContext) => ({
defaultMessage: 'Download and install Auditbeat',
}),
textPre: i18n.translate('home.tutorials.common.auditbeatInstructions.install.rpmTextPre', {
defaultMessage: 'First time using Auditbeat? See the [Getting Started Guide]({linkUrl}).',
defaultMessage: 'First time using Auditbeat? See the [Quick Start]({linkUrl}).',
values: {
linkUrl: '{config.docs.beats.auditbeat}/auditbeat-getting-started.html',
linkUrl: '{config.docs.beats.auditbeat}/auditbeat-installation-configuration.html',
},
}),
commands: [
Expand All @@ -92,7 +92,7 @@ export const createAuditbeatInstructions = (context?: TutorialContext) => ({
'home.tutorials.common.auditbeatInstructions.install.windowsTextPre',
{
defaultMessage:
'First time using Auditbeat? See the [Getting Started Guide]({guideLinkUrl}).\n\
'First time using Auditbeat? See the [Quick Start]({guideLinkUrl}).\n\
1. Download the Auditbeat Windows zip file from the [Download]({auditbeatLinkUrl}) page.\n\
2. Extract the contents of the zip file into {folderPath}.\n\
3. Rename the `{directoryName}` directory to `Auditbeat`.\n\
Expand All @@ -101,7 +101,7 @@ export const createAuditbeatInstructions = (context?: TutorialContext) => ({
5. From the PowerShell prompt, run the following commands to install Auditbeat as a Windows service.',
values: {
folderPath: '`C:\\Program Files`',
guideLinkUrl: '{config.docs.beats.auditbeat}/auditbeat-getting-started.html',
guideLinkUrl: '{config.docs.beats.auditbeat}/auditbeat-installation-configuration.html',
auditbeatLinkUrl: 'https://www.elastic.co/downloads/beats/auditbeat',
directoryName: 'auditbeat-{config.kibana.version}-windows',
},
Expand Down
16 changes: 8 additions & 8 deletions src/plugins/home/server/tutorials/instructions/filebeat_instructions.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,9 +31,9 @@ export const createFilebeatInstructions = (context?: TutorialContext) => ({
defaultMessage: 'Download and install Filebeat',
}),
textPre: i18n.translate('home.tutorials.common.filebeatInstructions.install.osxTextPre', {
defaultMessage: 'First time using Filebeat? See the [Getting Started Guide]({linkUrl}).',
defaultMessage: 'First time using Filebeat? See the [Quick Start]({linkUrl}).',
values: {
linkUrl: '{config.docs.beats.filebeat}/filebeat-getting-started.html',
linkUrl: '{config.docs.beats.filebeat}/filebeat-installation-configuration.html',
},
}),
commands: [
Expand All @@ -47,9 +47,9 @@ export const createFilebeatInstructions = (context?: TutorialContext) => ({
defaultMessage: 'Download and install Filebeat',
}),
textPre: i18n.translate('home.tutorials.common.filebeatInstructions.install.debTextPre', {
defaultMessage: 'First time using Filebeat? See the [Getting Started Guide]({linkUrl}).',
defaultMessage: 'First time using Filebeat? See the [Quick Start]({linkUrl}).',
values: {
linkUrl: '{config.docs.beats.filebeat}/filebeat-getting-started.html',
linkUrl: '{config.docs.beats.filebeat}/filebeat-installation-configuration.html',
},
}),
commands: [
Expand All @@ -68,9 +68,9 @@ export const createFilebeatInstructions = (context?: TutorialContext) => ({
defaultMessage: 'Download and install Filebeat',
}),
textPre: i18n.translate('home.tutorials.common.filebeatInstructions.install.rpmTextPre', {
defaultMessage: 'First time using Filebeat? See the [Getting Started Guide]({linkUrl}).',
defaultMessage: 'First time using Filebeat? See the [Quick Start]({linkUrl}).',
values: {
linkUrl: '{config.docs.beats.filebeat}/filebeat-getting-started.html',
linkUrl: '{config.docs.beats.filebeat}/filebeat-installation-configuration.html',
},
}),
commands: [
Expand All @@ -90,7 +90,7 @@ export const createFilebeatInstructions = (context?: TutorialContext) => ({
}),
textPre: i18n.translate('home.tutorials.common.filebeatInstructions.install.windowsTextPre', {
defaultMessage:
'First time using Filebeat? See the [Getting Started Guide]({guideLinkUrl}).\n\
'First time using Filebeat? See the [Quick Start]({guideLinkUrl}).\n\
1. Download the Filebeat Windows zip file from the [Download]({filebeatLinkUrl}) page.\n\
2. Extract the contents of the zip file into {folderPath}.\n\
3. Rename the `{directoryName}` directory to `Filebeat`.\n\
Expand All @@ -99,7 +99,7 @@ export const createFilebeatInstructions = (context?: TutorialContext) => ({
5. From the PowerShell prompt, run the following commands to install Filebeat as a Windows service.',
values: {
folderPath: '`C:\\Program Files`',
guideLinkUrl: '{config.docs.beats.filebeat}/filebeat-getting-started.html',
guideLinkUrl: '{config.docs.beats.filebeat}/filebeat-installation-configuration.html',
filebeatLinkUrl: 'https://www.elastic.co/downloads/beats/filebeat',
directoryName: 'filebeat-{config.kibana.version}-windows',
},
Expand Down
17 changes: 11 additions & 6 deletions src/plugins/home/server/tutorials/instructions/functionbeat_instructions.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,8 +31,10 @@ export const createFunctionbeatInstructions = (context?: TutorialContext) => ({
defaultMessage: 'Download and install Functionbeat',
}),
textPre: i18n.translate('home.tutorials.common.functionbeatInstructions.install.osxTextPre', {
defaultMessage: 'First time using Functionbeat? See the [Getting Started Guide]({link}).',
values: { link: '{config.docs.beats.functionbeat}/functionbeat-getting-started.html' },
defaultMessage: 'First time using Functionbeat? See the [Quick Start]({link}).',
values: {
link: '{config.docs.beats.functionbeat}/functionbeat-installation-configuration.html',
},
}),
commands: [
'curl -L -O https://artifacts.elastic.co/downloads/beats/functionbeat/functionbeat-{config.kibana.version}-darwin-x86_64.tar.gz',
Expand All @@ -47,8 +49,10 @@ export const createFunctionbeatInstructions = (context?: TutorialContext) => ({
textPre: i18n.translate(
'home.tutorials.common.functionbeatInstructions.install.linuxTextPre',
{
defaultMessage: 'First time using Functionbeat? See the [Getting Started Guide]({link}).',
values: { link: '{config.docs.beats.functionbeat}/functionbeat-getting-started.html' },
defaultMessage: 'First time using Functionbeat? See the [Quick Start]({link}).',
values: {
link: '{config.docs.beats.functionbeat}/functionbeat-installation-configuration.html',
},
}
),
commands: [
Expand All @@ -65,7 +69,7 @@ export const createFunctionbeatInstructions = (context?: TutorialContext) => ({
'home.tutorials.common.functionbeatInstructions.install.windowsTextPre',
{
defaultMessage:
'First time using Functionbeat? See the [Getting Started Guide]({functionbeatLink}).\n\
'First time using Functionbeat? See the [Quick Start]({functionbeatLink}).\n\
1. Download the Functionbeat Windows zip file from the [Download]({elasticLink}) page.\n\
2. Extract the contents of the zip file into {folderPath}.\n\
3. Rename the {directoryName} directory to `Functionbeat`.\n\
Expand All @@ -75,7 +79,8 @@ export const createFunctionbeatInstructions = (context?: TutorialContext) => ({
values: {
directoryName: '`functionbeat-{config.kibana.version}-windows`',
folderPath: '`C:\\Program Files`',
functionbeatLink: '{config.docs.beats.functionbeat}/functionbeat-getting-started.html',
functionbeatLink:
'{config.docs.beats.functionbeat}/functionbeat-installation-configuration.html',
elasticLink: 'https://www.elastic.co/downloads/beats/functionbeat',
},
}
Expand Down
21 changes: 11 additions & 10 deletions src/plugins/home/server/tutorials/instructions/heartbeat_instructions.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,8 +31,8 @@ export const createHeartbeatInstructions = (context?: TutorialContext) => ({
defaultMessage: 'Download and install Heartbeat',
}),
textPre: i18n.translate('home.tutorials.common.heartbeatInstructions.install.osxTextPre', {
defaultMessage: 'First time using Heartbeat? See the [Getting Started Guide]({link}).',
values: { link: '{config.docs.beats.heartbeat}/heartbeat-getting-started.html' },
defaultMessage: 'First time using Heartbeat? See the [Quick Start]({link}).',
values: { link: '{config.docs.beats.heartbeat}/heartbeat-installation-configuration.html' },
}),
commands: [
'curl -L -O https://artifacts.elastic.co/downloads/beats/heartbeat/heartbeat-{config.kibana.version}-darwin-x86_64.tar.gz',
Expand All @@ -45,8 +45,8 @@ export const createHeartbeatInstructions = (context?: TutorialContext) => ({
defaultMessage: 'Download and install Heartbeat',
}),
textPre: i18n.translate('home.tutorials.common.heartbeatInstructions.install.debTextPre', {
defaultMessage: 'First time using Heartbeat? See the [Getting Started Guide]({link}).',
values: { link: '{config.docs.beats.heartbeat}/heartbeat-getting-started.html' },
defaultMessage: 'First time using Heartbeat? See the [Quick Start]({link}).',
values: { link: '{config.docs.beats.heartbeat}/heartbeat-installation-configuration.html' },
}),
commands: [
'curl -L -O https://artifacts.elastic.co/downloads/beats/heartbeat/heartbeat-{config.kibana.version}-amd64.deb',
Expand All @@ -62,8 +62,8 @@ export const createHeartbeatInstructions = (context?: TutorialContext) => ({
defaultMessage: 'Download and install Heartbeat',
}),
textPre: i18n.translate('home.tutorials.common.heartbeatInstructions.install.rpmTextPre', {
defaultMessage: 'First time using Heartbeat? See the [Getting Started Guide]({link}).',
values: { link: '{config.docs.beats.heartbeat}/heartbeat-getting-started.html' },
defaultMessage: 'First time using Heartbeat? See the [Quick Start]({link}).',
values: { link: '{config.docs.beats.heartbeat}/heartbeat-installation-configuration.html' },
}),
commands: [
'curl -L -O https://artifacts.elastic.co/downloads/beats/heartbeat/heartbeat-{config.kibana.version}-x86_64.rpm',
Expand All @@ -82,7 +82,7 @@ export const createHeartbeatInstructions = (context?: TutorialContext) => ({
'home.tutorials.common.heartbeatInstructions.install.windowsTextPre',
{
defaultMessage:
'First time using Heartbeat? See the [Getting Started Guide]({heartbeatLink}).\n\
'First time using Heartbeat? See the [Quick Start]({heartbeatLink}).\n\
1. Download the Heartbeat Windows zip file from the [Download]({elasticLink}) page.\n\
2. Extract the contents of the zip file into {folderPath}.\n\
3. Rename the {directoryName} directory to `Heartbeat`.\n\
Expand All @@ -92,7 +92,8 @@ export const createHeartbeatInstructions = (context?: TutorialContext) => ({
values: {
directoryName: '`heartbeat-{config.kibana.version}-windows`',
folderPath: '`C:\\Program Files`',
heartbeatLink: '{config.docs.beats.heartbeat}/heartbeat-getting-started.html',
heartbeatLink:
'{config.docs.beats.heartbeat}/heartbeat-installation-configuration.html',
elasticLink: 'https://www.elastic.co/downloads/beats/heartbeat',
},
}
Expand Down Expand Up @@ -357,7 +358,7 @@ export function heartbeatEnableInstructionsOnPrem() {
'Where {hostTemplate} is your monitored URL, For more details on how to configure Monitors in \
Heartbeat, read the [Heartbeat configuration docs.]({configureLink})',
values: {
configureLink: '{config.docs.beats.heartbeat}/heartbeat-configuration.html',
configureLink: '{config.docs.beats.heartbeat}/configuring-howto-heartbeat.html',
hostTemplate: '`<http://localhost:9200>`',
},
}
Expand Down Expand Up @@ -428,7 +429,7 @@ export function heartbeatEnableInstructionsCloud() {
{
defaultMessage:
'For more details on how to configure Monitors in Heartbeat, read the [Heartbeat configuration docs.]({configureLink})',
values: { configureLink: '{config.docs.beats.heartbeat}/heartbeat-configuration.html' },
values: { configureLink: '{config.docs.beats.heartbeat}/configuring-howto-heartbeat.html' },
}
);
return {
Expand Down
23 changes: 15 additions & 8 deletions src/plugins/home/server/tutorials/instructions/metricbeat_instructions.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,8 +31,10 @@ export const createMetricbeatInstructions = (context?: TutorialContext) => ({
defaultMessage: 'Download and install Metricbeat',
}),
textPre: i18n.translate('home.tutorials.common.metricbeatInstructions.install.osxTextPre', {
defaultMessage: 'First time using Metricbeat? See the [Getting Started Guide]({link}).',
values: { link: '{config.docs.beats.metricbeat}/metricbeat-getting-started.html' },
defaultMessage: 'First time using Metricbeat? See the [Quick Start]({link}).',
values: {
link: '{config.docs.beats.metricbeat}/metricbeat-installation-configuration.html',
},
}),
commands: [
'curl -L -O https://artifacts.elastic.co/downloads/beats/metricbeat/metricbeat-{config.kibana.version}-darwin-x86_64.tar.gz',
Expand All @@ -45,8 +47,10 @@ export const createMetricbeatInstructions = (context?: TutorialContext) => ({
defaultMessage: 'Download and install Metricbeat',
}),
textPre: i18n.translate('home.tutorials.common.metricbeatInstructions.install.debTextPre', {
defaultMessage: 'First time using Metricbeat? See the [Getting Started Guide]({link}).',
values: { link: '{config.docs.beats.metricbeat}/metricbeat-getting-started.html' },
defaultMessage: 'First time using Metricbeat? See the [Quick Start]({link}).',
values: {
link: '{config.docs.beats.metricbeat}/metricbeat-installation-configuration.html',
},
}),
commands: [
'curl -L -O https://artifacts.elastic.co/downloads/beats/metricbeat/metricbeat-{config.kibana.version}-amd64.deb',
Expand All @@ -62,8 +66,10 @@ export const createMetricbeatInstructions = (context?: TutorialContext) => ({
defaultMessage: 'Download and install Metricbeat',
}),
textPre: i18n.translate('home.tutorials.common.metricbeatInstructions.install.rpmTextPre', {
defaultMessage: 'First time using Metricbeat? See the [Getting Started Guide]({link}).',
values: { link: '{config.docs.beats.metricbeat}/metricbeat-getting-started.html' },
defaultMessage: 'First time using Metricbeat? See the [Quick Start]({link}).',
values: {
link: '{config.docs.beats.metricbeat}/metricbeat-installation-configuration.html',
},
}),
commands: [
'curl -L -O https://artifacts.elastic.co/downloads/beats/metricbeat/metricbeat-{config.kibana.version}-x86_64.rpm',
Expand All @@ -82,7 +88,7 @@ export const createMetricbeatInstructions = (context?: TutorialContext) => ({
'home.tutorials.common.metricbeatInstructions.install.windowsTextPre',
{
defaultMessage:
'First time using Metricbeat? See the [Getting Started Guide]({metricbeatLink}).\n\
'First time using Metricbeat? See the [Quick Start]({metricbeatLink}).\n\
1. Download the Metricbeat Windows zip file from the [Download]({elasticLink}) page.\n\
2. Extract the contents of the zip file into {folderPath}.\n\
3. Rename the {directoryName} directory to `Metricbeat`.\n\
Expand All @@ -92,7 +98,8 @@ export const createMetricbeatInstructions = (context?: TutorialContext) => ({
values: {
directoryName: '`metricbeat-{config.kibana.version}-windows`',
folderPath: '`C:\\Program Files`',
metricbeatLink: '{config.docs.beats.metricbeat}/metricbeat-getting-started.html',
metricbeatLink:
'{config.docs.beats.metricbeat}/metricbeat-installation-configuration.html',
elasticLink: 'https://www.elastic.co/downloads/beats/metricbeat',
},
}
Expand Down
Loading