github-mirrors/kibana
1
0
Fork 0
mirror of https://github.com/elastic/kibana.git synced 2025-04-24 09:48:58 -04:00
Code Issues Projects Releases Packages Wiki Activity

[Synthetics] Fix doc links for alerts and documentation (#168486)

Browse source 
Fixes #167688  

## Summary

Updates the links to Synthetics from Uptime on the following:
1. "learn more" link on Monitor Status alert flyout
2. "learn more" link on TLS alert flyout
3. Synthetics app "Documentation" link (under _help_  top header button)
This commit is contained in:
Abdul Wahab Zahid 2023-10-11 17:56:10 +02:00 • committed by GitHub
parent 96de7662fc
commit 598adef415
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
5 changed files with 6 additions and 4 deletions
Download patch file Download diff file Expand all files Collapse all files

1
packages/kbn-doc-links/src/get_doc_links.ts
View file

@ -543,6 +543,7 @@ export const getDocLinks = ({ kibanaBranch }: GetDocLinkOptions): DocLinks => {
monitorUptimeSynthetics: `${ELASTIC_WEBSITE_URL}guide/en/observability/${DOC_LINK_VERSION}/monitor-uptime-synthetics.html`,
userExperience: `${ELASTIC_WEBSITE_URL}guide/en/observability/${DOC_LINK_VERSION}/user-experience.html`,
createAlerts: `${ELASTIC_WEBSITE_URL}guide/en/observability/${DOC_LINK_VERSION}/create-alerts.html`,
syntheticsAlerting: `${ELASTIC_WEBSITE_URL}guide/en/observability/${DOC_LINK_VERSION}/synthetics-settings.html#synthetics-settings-alerting`,
syntheticsCommandReference: `${ELASTIC_WEBSITE_URL}guide/en/observability/${DOC_LINK_VERSION}/synthetics-configuration.html#synthetics-configuration-playwright-options`,
syntheticsProjectMonitors: `${ELASTIC_WEBSITE_URL}guide/en/observability/${DOC_LINK_VERSION}/synthetic-run-tests.html#synthetic-monitor-choose-project`,
syntheticsMigrateFromIntegration: `${ELASTIC_WEBSITE_URL}guide/en/observability/${DOC_LINK_VERSION}/synthetics-migrate-from-integration.html`,

1
packages/kbn-doc-links/src/types.ts
View file

@ -415,6 +415,7 @@ export interface DocLinks {
monitorUptimeSynthetics: string;
userExperience: string;
createAlerts: string;
syntheticsAlerting: string;
syntheticsCommandReference: string;
syntheticsProjectMonitors: string;
syntheticsMigrateFromIntegration: string;

2
x-pack/plugins/synthetics/public/apps/synthetics/lib/alert_types/monitor_status.tsx
View file

@ -30,7 +30,7 @@ export const initMonitorStatusAlertType: AlertTypeInitializer = ({
description,
iconClass: 'uptimeApp',
documentationUrl(docLinks) {
return `${docLinks.links.observability.monitorStatus}`;
return `${docLinks.links.observability.syntheticsAlerting}`;
},
ruleParamsExpression: (paramProps: RuleTypeParamsExpressionProps<StatusRuleParams>) => (
<MonitorStatusAlert core={core} plugins={plugins} params={paramProps} />

2
x-pack/plugins/synthetics/public/apps/synthetics/lib/alert_types/tls.tsx
View file

@ -27,7 +27,7 @@ export const initTlsAlertType: AlertTypeInitializer = ({
id: SYNTHETICS_ALERT_RULE_TYPES.TLS,
iconClass: 'uptimeApp',
documentationUrl(docLinks) {
return `${docLinks.links.observability.tlsCertificate}`;
return `${docLinks.links.observability.syntheticsAlerting}`;
},
ruleParamsExpression: (params: RuleTypeParamsExpressionProps<TLSParams>) => (
<TLSAlert

4
x-pack/plugins/synthetics/public/apps/synthetics/render_app.tsx
View file

@ -62,11 +62,11 @@ export function renderApp(
links: [
{
linkType: 'documentation',
href: `${docLinks.links.observability.monitorUptime}`, // TODO: Include synthetics link
href: `${docLinks.links.observability.monitorUptimeSynthetics}`,
},
{
linkType: 'discuss',
href: 'https://discuss.elastic.co/c/uptime', // TODO: Include synthetics link
href: 'https://discuss.elastic.co/c/uptime', // Redirects to https://discuss.elastic.co/c/observability/synthetics/75
},
],
}),