Skip to content

Commit 3908dc8

Browse files
lcawllcawl
authored
[DOCS] Use new responseOps URLs in doc link service and APIs (#217601)
1 parent 388a6fc commit 3908dc8

File tree

16 files changed

+90
-138
lines changed

16 files changed

+90
-138
lines changed

‎oas_docs/output/kibana.serverless.yaml‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@ tags:
4949
Alerting enables you to define rules, which detect complex conditions within your data. When a condition is met, the rule tracks it as an alert and runs the actions that are defined in the rule. Actions typically involve the use of connectors to interact with Kibana services or third party integrations.
5050
externalDocs:
5151
description: Alerting documentation
52-
url: https://www.elastic.co/docs/current/serverless/rules
52+
url: https://www.elastic.co/docs/explore-analyze/alerts-cases/alerts
5353
x-displayName: Alerting
5454
- description: |
5555
Adjust APM agent configuration without need to redeploy your application.
@@ -72,7 +72,7 @@ tags:
7272
Connectors provide a central place to store connection information for services and integrations with Elastic or third party systems. Alerting rules can use connectors to run actions when rule conditions are met.
7373
externalDocs:
7474
description: Connector documentation
75-
url: https://www.elastic.co/docs/current/serverless/action-connectors
75+
url: https://www.elastic.co/docs/reference/kibana/connectors-kibana
7676
x-displayName: Connectors
7777
- name: Dashboards
7878
- name: Data streams
@@ -227,7 +227,7 @@ tags:
227227
Get information about the system status, resource usage, and installed plugins.
228228
- externalDocs:
229229
description: Task manager
230-
url: https://www.elastic.co/guide/en/kibana/current/task-manager-production-considerations.html
230+
url: https://www.elastic.co/docs/deploy-manage/distributed-architecture/kibana-tasks-management
231231
name: task manager
232232
x-displayName: Task manager
233233
paths:

‎oas_docs/output/kibana.yaml‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,7 @@ tags:
5656
Alerting enables you to define rules, which detect complex conditions within your data. When a condition is met, the rule tracks it as an alert and runs the actions that are defined in the rule. Actions typically involve the use of connectors to interact with Kibana services or third party integrations.
5757
externalDocs:
5858
description: Alerting documentation
59-
url: https://www.elastic.co/guide/en/kibana/master/alerting-getting-started.html
59+
url: https://www.elastic.co/docs/explore-analyze/alerts-cases/alerts
6060
x-displayName: Alerting
6161
- description: |
6262
Adjust APM agent configuration without need to redeploy your application.
@@ -78,15 +78,15 @@ tags:
7878
name: cases
7979
externalDocs:
8080
description: Cases documentation
81-
url: https://www.elastic.co/guide/en/kibana/master/cases.html
81+
url: https://www.elastic.co/docs/explore-analyze/alerts-cases/cases
8282
x-displayName: Cases
8383
- name: CCR Remote synced integrations
8484
- name: connectors
8585
description: |
8686
Connectors provide a central place to store connection information for services and integrations with Elastic or third party systems. Alerting rules can use connectors to run actions when rule conditions are met.
8787
externalDocs:
8888
description: Connector documentation
89-
url: https://www.elastic.co/guide/en/kibana/current/action-types.html
89+
url: https://www.elastic.co/docs/reference/kibana/connectors-kibana
9090
x-displayName: Connectors
9191
- name: Dashboards
9292
- name: Data streams
@@ -269,7 +269,7 @@ tags:
269269
x-displayName: System
270270
- externalDocs:
271271
description: Task manager
272-
url: https://www.elastic.co/guide/en/kibana/current/task-manager-production-considerations.html
272+
url: https://www.elastic.co/docs/deploy-manage/distributed-architecture/kibana-tasks-management
273273
name: task manager
274274
x-displayName: Task manager
275275
- description: The assistant helps you prepare for the next major version of Elasticsearch.

‎oas_docs/overlays/kibana.overlays.serverless.yaml‎

Lines changed: 0 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -16,33 +16,12 @@ actions:
1616
kibana_url:
1717
default: <KIBANA_URL>
1818
# Add some tag descriptions and displayNames
19-
- target: '$.tags[?(@.name=="alerting")]'
20-
description: Change tag description and displayName
21-
update:
22-
description: >
23-
Alerting enables you to define rules, which detect complex conditions within your data.
24-
When a condition is met, the rule tracks it as an alert and runs the actions that are defined in the rule.
25-
Actions typically involve the use of connectors to interact with Kibana services or third party integrations.
26-
externalDocs:
27-
description: Alerting documentation
28-
url: https://www.elastic.co/docs/current/serverless/rules
29-
x-displayName: "Alerting"
3019
- target: '$.tags[?(@.name=="streams")]'
3120
description: Change tag description and displayName
3221
update:
3322
description: >
3423
Streams is a new and experimental way to manage your data in Kibana. The API is currently not considered stable and can change at any point.
3524
x-displayName: "Streams"
36-
- target: '$.tags[?(@.name=="connectors")]'
37-
description: Change tag description and displayName
38-
update:
39-
description: >
40-
Connectors provide a central place to store connection information for services and integrations with Elastic or third party systems.
41-
Alerting rules can use connectors to run actions when rule conditions are met.
42-
externalDocs:
43-
description: Connector documentation
44-
url: https://www.elastic.co/docs/current/serverless/action-connectors
45-
x-displayName: "Connectors"
4625
- target: '$.tags[?(@.name=="data views")]'
4726
description: Change displayName
4827
update:

‎oas_docs/overlays/kibana.overlays.shared.yaml‎

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,39 @@ info:
44
title: Overlays that are applicable to both serverless and non-serverless documentas
55
version: 0.0.1
66
actions:
7+
# Add some tag descriptions and displayNames
8+
- target: '$.tags[?(@.name=="alerting")]'
9+
description: Change tag description and displayName
10+
update:
11+
description: >
12+
Alerting enables you to define rules, which detect complex conditions within your data.
13+
When a condition is met, the rule tracks it as an alert and runs the actions that are defined in the rule.
14+
Actions typically involve the use of connectors to interact with Kibana services or third party integrations.
15+
externalDocs:
16+
description: Alerting documentation
17+
url: https://www.elastic.co/docs/explore-analyze/alerts-cases/alerts
18+
x-displayName: "Alerting"
19+
- target: '$.tags[?(@.name=="cases")]'
20+
description: Change tag description and displayName
21+
update:
22+
description: >
23+
Cases are used to open and track issues.
24+
You can add assignees and tags to your cases, set their severity and status, and add alerts, comments, and visualizations.
25+
You can also send cases to external incident management systems by configuring connectors.
26+
externalDocs:
27+
description: Cases documentation
28+
url: https://www.elastic.co/docs/explore-analyze/alerts-cases/cases
29+
x-displayName: "Cases"
30+
- target: '$.tags[?(@.name=="connectors")]'
31+
description: Change tag description and displayName
32+
update:
33+
description: >
34+
Connectors provide a central place to store connection information for services and integrations with Elastic or third party systems.
35+
Alerting rules can use connectors to run actions when rule conditions are met.
36+
externalDocs:
37+
description: Connector documentation
38+
url: https://www.elastic.co/docs/reference/kibana/connectors-kibana
39+
x-displayName: "Connectors"
740
# Add some spaces API examples
841
- target: "$.paths['/api/spaces/space']['post']"
942
description: "Add example to create space API"

‎oas_docs/overlays/kibana.overlays.yaml‎

Lines changed: 0 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -36,44 +36,12 @@ actions:
3636
3737
To learn more, check out [Spaces](https://www.elastic.co/guide/en/kibana/master/xpack-spaces.html).
3838
# Add some tag descriptions and displayNames
39-
- target: '$.tags[?(@.name=="alerting")]'
40-
description: Change tag description and displayName
41-
update:
42-
description: >
43-
Alerting enables you to define rules, which detect complex conditions within your data.
44-
When a condition is met, the rule tracks it as an alert and runs the actions that are defined in the rule.
45-
Actions typically involve the use of connectors to interact with Kibana services or third party integrations.
46-
externalDocs:
47-
description: Alerting documentation
48-
url: https://www.elastic.co/guide/en/kibana/master/alerting-getting-started.html
49-
x-displayName: "Alerting"
5039
- target: '$.tags[?(@.name=="streams")]'
5140
description: Change tag description and displayName
5241
update:
5342
description: >
5443
Streams is a new and experimental way to manage your data in Kibana (currently experimental - expect changes).
5544
x-displayName: "Streams"
56-
- target: '$.tags[?(@.name=="cases")]'
57-
description: Change tag description and displayName
58-
update:
59-
description: >
60-
Cases are used to open and track issues.
61-
You can add assignees and tags to your cases, set their severity and status, and add alerts, comments, and visualizations.
62-
You can also send cases to external incident management systems by configuring connectors.
63-
externalDocs:
64-
description: Cases documentation
65-
url: https://www.elastic.co/guide/en/kibana/master/cases.html
66-
x-displayName: "Cases"
67-
- target: '$.tags[?(@.name=="connectors")]'
68-
description: Change tag description and displayName
69-
update:
70-
description: >
71-
Connectors provide a central place to store connection information for services and integrations with Elastic or third party systems.
72-
Alerting rules can use connectors to run actions when rule conditions are met.
73-
externalDocs:
74-
description: Connector documentation
75-
url: https://www.elastic.co/guide/en/kibana/current/action-types.html
76-
x-displayName: "Connectors"
7745
- target: '$.tags[?(@.name=="data views")]'
7846
description: Change displayName
7947
update:

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

Lines changed: 34 additions & 52 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,7 @@ export const getDocLinks = ({ kibanaBranch, buildFlavor }: GetDocLinkOptions): D
2424
const ELASTIC_WEBSITE_URL = meta.elasticWebsiteUrl;
2525
const ELASTIC_GITHUB = meta.elasticGithubUrl;
2626
const SEARCH_LABS_URL = meta.searchLabsUrl;
27+
const ELASTIC_DOCS = meta.docsWebsiteUrl;
2728

2829
const ELASTICSEARCH_DOCS = `${ELASTIC_WEBSITE_URL}guide/en/elasticsearch/reference/${DOC_LINK_VERSION}/`;
2930
const KIBANA_DOCS = `${ELASTIC_WEBSITE_URL}guide/en/kibana/${DOC_LINK_VERSION}/`;
@@ -41,11 +42,11 @@ export const getDocLinks = ({ kibanaBranch, buildFlavor }: GetDocLinkOptions): D
4142
const isServerless = buildFlavor === 'serverless';
4243

4344
return deepFreeze({
44-
settings: `${ELASTIC_WEBSITE_URL}guide/en/kibana/${DOC_LINK_VERSION}/settings.html`,
45+
settings: `${ELASTIC_DOCS}reference/kibana/configuration-reference`,
4546
elasticStackGetStarted: isServerless
46-
? `${SERVERLESS_DOCS}intro.html`
47-
: `${ELASTIC_WEBSITE_URL}guide/en/index.html`,
48-
apiReference: `${ELASTIC_WEBSITE_URL}guide/en/starting-with-the-elasticsearch-platform-and-its-solutions/current/api-reference.html`,
47+
? `${ELASTIC_DOCS}deploy-manage/deploy/elastic-cloud/serverless`
48+
: `${ELASTIC_DOCS}get-started`,
49+
apiReference: `${ELASTIC_DOCS}apis`,
4950
upgrade: {
5051
upgradingStackOnPrem: `${ELASTIC_WEBSITE_URL}guide/en/elastic-stack/current/upgrading-elastic-stack-on-prem.html`,
5152
upgradingStackOnCloud: `${ELASTIC_WEBSITE_URL}guide/en/elastic-stack/current/upgrade-elastic-stack-for-elastic-cloud.html`,
@@ -604,49 +605,34 @@ export const getDocLinks = ({ kibanaBranch, buildFlavor }: GetDocLinkOptions): D
604605
aiAssistant: `${OBSERVABILITY_DOCS}obs-ai-assistant.html`,
605606
},
606607
alerting: {
607-
guide: isServerless
608-
? `${SERVERLESS_DOCS}rules.html`
609-
: `${KIBANA_DOCS}create-and-manage-rules.html`,
610-
actionTypes: isServerless
611-
? `${SERVERLESS_DOCS}action-connectors.html`
612-
: `${KIBANA_DOCS}action-types.html`,
613-
apmRulesErrorCount: isServerless
614-
? `${SERVERLESS_DOCS}observability-create-error-count-threshold-alert-rule.html`
615-
: `${KIBANA_DOCS}apm-alerts.html`,
616-
apmRulesTransactionDuration: isServerless
617-
? `${SERVERLESS_DOCS}observability-create-latency-threshold-alert-rule.html`
618-
: `${KIBANA_DOCS}apm-alerts.html`,
619-
apmRulesTransactionError: isServerless
620-
? `${SERVERLESS_DOCS}observability-create-failed-transaction-rate-threshold-alert-rule.html`
621-
: `${KIBANA_DOCS}apm-alerts.html`,
622-
apmRulesAnomaly: isServerless
623-
? `${SERVERLESS_DOCS}observability-create-anomaly-alert-rule.html`
624-
: `${KIBANA_DOCS}apm-alerts.html`,
625-
emailAction: `${KIBANA_DOCS}email-action-type.html`,
626-
emailActionConfig: `${KIBANA_DOCS}email-action-type.html`,
627-
emailExchangeClientSecretConfig: `${KIBANA_DOCS}email-action-type.html#exchange-client-secret`,
628-
emailExchangeClientIdConfig: `${KIBANA_DOCS}email-action-type.html#exchange-client-tenant-id`,
629-
generalSettings: `${KIBANA_DOCS}alert-action-settings-kb.html#general-alert-action-settings`,
630-
indexAction: `${KIBANA_DOCS}index-action-type.html`,
631-
esQuery: `${KIBANA_DOCS}rule-type-es-query.html`,
632-
indexThreshold: `${KIBANA_DOCS}rule-type-index-threshold.html`,
633-
maintenanceWindows: isServerless
634-
? `${SERVERLESS_DOCS}maintenance-windows.html`
635-
: `${KIBANA_DOCS}maintenance-windows.html`,
636-
pagerDutyAction: `${KIBANA_DOCS}pagerduty-action-type.html`,
637-
preconfiguredConnectors: `${KIBANA_DOCS}pre-configured-connectors.html`,
638-
preconfiguredAlertHistoryConnector: `${KIBANA_DOCS}pre-configured-connectors.html#preconfigured-connector-alert-history`,
639-
serviceNowAction: `${KIBANA_DOCS}servicenow-action-type.html#configuring-servicenow`,
640-
serviceNowSIRAction: `${KIBANA_DOCS}servicenow-sir-action-type.html`,
641-
setupPrerequisites: `${KIBANA_DOCS}alerting-setup.html#alerting-prerequisites`,
642-
slackAction: `${KIBANA_DOCS}slack-action-type.html#configuring-slack-webhook`,
643-
slackApiAction: `${KIBANA_DOCS}slack-action-type.html#configuring-slack-web-api`,
644-
teamsAction: `${KIBANA_DOCS}teams-action-type.html#configuring-teams`,
645-
connectors: `${KIBANA_DOCS}action-types.html`,
646-
legacyRuleApiDeprecations: `${KIBANA_DOCS}breaking-changes-summary.html#breaking-201550`,
608+
guide: `${ELASTIC_DOCS}explore-analyze/alerts-cases/alerts/create-manage-rules`,
609+
actionTypes: `${ELASTIC_DOCS}reference/kibana/connectors-kibana`,
610+
apmRulesErrorCount: `${ELASTIC_DOCS}solutions/observability/incident-management/create-an-error-count-threshold-rule`,
611+
apmRulesTransactionDuration: `${ELASTIC_DOCS}solutions/observability/incident-management/create-latency-threshold-rule`,
612+
apmRulesTransactionError: `${ELASTIC_DOCS}solutions/observability/incident-management/create-failed-transaction-rate-threshold-rule`,
613+
apmRulesAnomaly: `${ELASTIC_DOCS}solutions/observability/incident-management/create-an-apm-anomaly-rule`,
614+
emailAction: `${ELASTIC_DOCS}reference/kibana/connectors-kibana/email-action-type`,
615+
emailActionConfig: `${ELASTIC_DOCS}reference/kibana/connectors-kibana/email-action-type`,
616+
emailExchangeClientSecretConfig: `${ELASTIC_DOCS}reference/kibana/connectors-kibana/email-action-type#exchange-client-secret`,
617+
emailExchangeClientIdConfig: `${ELASTIC_DOCS}reference/kibana/connectors-kibana/email-action-type#exchange-client-tenant-id`,
618+
generalSettings: `${ELASTIC_DOCS}reference/kibana/configuration-reference/alerting-settings#general-alert-action-settings`,
619+
indexAction: `${ELASTIC_DOCS}reference/kibana/connectors-kibana/index-action-type`,
620+
esQuery: `${ELASTIC_DOCS}explore-analyze/alerts-cases/alerts/rule-type-es-query`,
621+
indexThreshold: `${ELASTIC_DOCS}explore-analyze/alerts-cases/alerts/rule-type-index-threshold`,
622+
maintenanceWindows: `${ELASTIC_DOCS}explore-analyze/alerts-cases/alerts/maintenance-windows`,
623+
pagerDutyAction: `${ELASTIC_DOCS}reference/kibana/connectors-kibana/pagerduty-action-type`,
624+
preconfiguredConnectors: `${ELASTIC_DOCS}reference/kibana/connectors-kibana/pre-configured-connectors`,
625+
preconfiguredAlertHistoryConnector: `${ELASTIC_DOCS}reference/kibana/connectors-kibana/pre-configured-connectors#preconfigured-connector-alert-history`,
626+
serviceNowAction: `${ELASTIC_DOCS}reference/kibana/connectors-kibana/servicenow-action-type#configuring-servicenow`,
627+
serviceNowSIRAction: `${ELASTIC_DOCS}reference/kibana/connectors-kibana/servicenow-sir-action-type`,
628+
setupPrerequisites: `${ELASTIC_DOCS}explore-analyze/alerts-cases/alerts/alerting-setup#alerting-prerequisites`,
629+
slackAction: `${ELASTIC_DOCS}reference/kibana/connectors-kibana/slack-action-type#configuring-slack-webhook`,
630+
slackApiAction: `${ELASTIC_DOCS}reference/kibana/connectors-kibana/slack-action-type#configuring-slack-web-api`,
631+
teamsAction: `${ELASTIC_DOCS}reference/kibana/connectors-kibana/teams-action-type#configuring-teams`,
632+
connectors: `${ELASTIC_DOCS}reference/kibana/connectors-kibana`,
647633
},
648634
taskManager: {
649-
healthMonitoring: `${KIBANA_DOCS}task-manager-health-monitoring.html`,
635+
healthMonitoring: `${ELASTIC_DOCS}deploy-manage/monitor/kibana-task-manager-health-monitoring`,
650636
},
651637
maps: {
652638
connectToEms: `${KIBANA_DOCS}maps-connect-to-ems.html`,
@@ -672,10 +658,9 @@ export const getDocLinks = ({ kibanaBranch, buildFlavor }: GetDocLinkOptions): D
672658
troubleshootKibana: `${KIBANA_DOCS}monitor-troubleshooting.html`,
673659
},
674660
reporting: {
675-
cloudMinimumRequirements: `${KIBANA_DOCS}reporting-getting-started.html#reporting-on-cloud-resource-requirements`,
676-
grantUserAccess: `${KIBANA_DOCS}secure-reporting.html#grant-user-access`,
677-
browserSystemDependencies: `${KIBANA_DOCS}secure-reporting.html#install-reporting-packages`,
678-
browserSandboxDependencies: `${KIBANA_DOCS}reporting-troubleshooting-pdf.html#reporting-troubleshooting-sandbox-dependency`,
661+
cloudMinimumRequirements: `${ELASTIC_DOCS}explore-analyze/report-and-share#_embed_outside_of_kib`,
662+
browserSystemDependencies: `${ELASTIC_DOCS}deploy-manage/kibana-reporting-configuration#install-reporting-packages`,
663+
browserSandboxDependencies: `${ELASTIC_DOCS}explore-analyze/report-and-share/reporting-troubleshooting-pdf#reporting-troubleshooting-sandbox-dependency`,
679664
},
680665
security: {
681666
apiKeyServiceSettings: `${ELASTICSEARCH_DOCS}security-settings.html#api-key-service-settings`,
@@ -979,9 +964,6 @@ export const getDocLinks = ({ kibanaBranch, buildFlavor }: GetDocLinkOptions): D
979964
inferenceManagement: {
980965
inferenceAPIDocumentation: `${ELASTIC_WEBSITE_URL}docs/api/doc/elasticsearch/operation/operation-inference-put`,
981966
},
982-
cases: {
983-
legacyApiDeprecations: `${KIBANA_DOCS}breaking-changes-summary.html#breaking-201004`,
984-
},
985967
synonyms: {
986968
synonymsAPIDocumentation: `${ELASTIC_WEBSITE_URL}guide/en/elasticsearch/reference/current/synonyms-apis.html`,
987969
},

‎src/platform/packages/shared/kbn-doc-links/src/get_doc_meta.ts‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ export const getDocLinksMeta = ({
2323
ecs_version: 'current',
2424
elasticWebsiteUrl: 'https://www.elastic.co/',
2525
elasticGithubUrl: 'https://github.com/elastic/',
26-
docsWebsiteUrl: 'https://docs.elastic.co/',
26+
docsWebsiteUrl: 'https://www.elastic.co/docs/',
2727
searchLabsUrl: 'https://search-labs.elastic.co/',
2828
};
2929
};

‎src/platform/packages/shared/kbn-doc-links/src/types.ts‎

Lines changed: 0 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -433,7 +433,6 @@ export interface DocLinks {
433433
slackApiAction: string;
434434
teamsAction: string;
435435
connectors: string;
436-
legacyRuleApiDeprecations: string;
437436
}>;
438437
readonly taskManager: Readonly<{
439438
healthMonitoring: string;
@@ -448,7 +447,6 @@ export interface DocLinks {
448447
readonly monitoring: Record<string, string>;
449448
readonly reporting: Readonly<{
450449
cloudMinimumRequirements: string;
451-
grantUserAccess: string;
452450
browserSystemDependencies: string;
453451
browserSandboxDependencies: string;
454452
}>;
@@ -641,9 +639,6 @@ export interface DocLinks {
641639
readonly inferenceManagement: {
642640
readonly inferenceAPIDocumentation: string;
643641
};
644-
readonly cases: {
645-
readonly legacyApiDeprecations: string;
646-
};
647642
readonly synonyms: {
648643
readonly synonymsAPIDocumentation: string;
649644
};

0 commit comments

Comments
 (0)