Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
6 changes: 3 additions & 3 deletions oas_docs/output/kibana.serverless.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ tags:
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.
externalDocs:
description: Alerting documentation
url: https://www.elastic.co/docs/current/serverless/rules
url: https://www.elastic.co/docs/explore-analyze/alerts-cases/alerts
x-displayName: Alerting
- description: |
Adjust APM agent configuration without need to redeploy your application.
Expand All @@ -72,7 +72,7 @@ tags:
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.
externalDocs:
description: Connector documentation
url: https://www.elastic.co/docs/current/serverless/action-connectors
url: https://www.elastic.co/docs/reference/kibana/connectors-kibana
x-displayName: Connectors
- name: Dashboards
- name: Data streams
Expand Down Expand Up @@ -227,7 +227,7 @@ tags:
Get information about the system status, resource usage, and installed plugins.
- externalDocs:
description: Task manager
url: https://www.elastic.co/guide/en/kibana/current/task-manager-production-considerations.html
url: https://www.elastic.co/docs/deploy-manage/distributed-architecture/kibana-tasks-management
name: task manager
x-displayName: Task manager
paths:
Expand Down
8 changes: 4 additions & 4 deletions oas_docs/output/kibana.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@ tags:
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.
externalDocs:
description: Alerting documentation
url: https://www.elastic.co/guide/en/kibana/master/alerting-getting-started.html
url: https://www.elastic.co/docs/explore-analyze/alerts-cases/alerts
x-displayName: Alerting
- description: |
Adjust APM agent configuration without need to redeploy your application.
Expand All @@ -78,15 +78,15 @@ tags:
name: cases
externalDocs:
description: Cases documentation
url: https://www.elastic.co/guide/en/kibana/master/cases.html
url: https://www.elastic.co/docs/explore-analyze/alerts-cases/cases
x-displayName: Cases
- name: CCR Remote synced integrations
- name: connectors
description: |
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.
externalDocs:
description: Connector documentation
url: https://www.elastic.co/guide/en/kibana/current/action-types.html
url: https://www.elastic.co/docs/reference/kibana/connectors-kibana
x-displayName: Connectors
- name: Dashboards
- name: Data streams
Expand Down Expand Up @@ -264,7 +264,7 @@ tags:
x-displayName: System
- externalDocs:
description: Task manager
url: https://www.elastic.co/guide/en/kibana/current/task-manager-production-considerations.html
url: https://www.elastic.co/docs/deploy-manage/distributed-architecture/kibana-tasks-management
name: task manager
x-displayName: Task manager
- description: The assistant helps you prepare for the next major version of Elasticsearch.
Expand Down
21 changes: 0 additions & 21 deletions oas_docs/overlays/kibana.overlays.serverless.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -16,33 +16,12 @@ actions:
kibana_url:
default: <KIBANA_URL>
# Add some tag descriptions and displayNames
- target: '$.tags[?(@.name=="alerting")]'
description: Change tag description and displayName
update:
description: >
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.
externalDocs:
description: Alerting documentation
url: https://www.elastic.co/docs/current/serverless/rules
x-displayName: "Alerting"
- target: '$.tags[?(@.name=="streams")]'
description: Change tag description and displayName
update:
description: >
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.
x-displayName: "Streams"
- target: '$.tags[?(@.name=="connectors")]'
description: Change tag description and displayName
update:
description: >
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.
externalDocs:
description: Connector documentation
url: https://www.elastic.co/docs/current/serverless/action-connectors
x-displayName: "Connectors"
- target: '$.tags[?(@.name=="data views")]'
description: Change displayName
update:
Expand Down
33 changes: 33 additions & 0 deletions oas_docs/overlays/kibana.overlays.shared.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,39 @@ info:
title: Overlays that are applicable to both serverless and non-serverless documentas
version: 0.0.1
actions:
# Add some tag descriptions and displayNames
- target: '$.tags[?(@.name=="alerting")]'
description: Change tag description and displayName
update:
description: >
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.
externalDocs:
description: Alerting documentation
url: https://www.elastic.co/docs/explore-analyze/alerts-cases/alerts
x-displayName: "Alerting"
- target: '$.tags[?(@.name=="cases")]'
description: Change tag description and displayName
update:
description: >
Cases are used to open and track issues.
You can add assignees and tags to your cases, set their severity and status, and add alerts, comments, and visualizations.
You can also send cases to external incident management systems by configuring connectors.
externalDocs:
description: Cases documentation
url: https://www.elastic.co/docs/explore-analyze/alerts-cases/cases
x-displayName: "Cases"
- target: '$.tags[?(@.name=="connectors")]'
description: Change tag description and displayName
update:
description: >
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.
externalDocs:
description: Connector documentation
url: https://www.elastic.co/docs/reference/kibana/connectors-kibana
x-displayName: "Connectors"
# Add some spaces API examples
- target: "$.paths['/api/spaces/space']['post']"
description: "Add example to create space API"
Expand Down
32 changes: 0 additions & 32 deletions oas_docs/overlays/kibana.overlays.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -36,44 +36,12 @@ actions:

To learn more, check out [Spaces](https://www.elastic.co/guide/en/kibana/master/xpack-spaces.html).
# Add some tag descriptions and displayNames
- target: '$.tags[?(@.name=="alerting")]'
description: Change tag description and displayName
update:
description: >
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.
externalDocs:
description: Alerting documentation
url: https://www.elastic.co/guide/en/kibana/master/alerting-getting-started.html
x-displayName: "Alerting"
- target: '$.tags[?(@.name=="streams")]'
description: Change tag description and displayName
update:
description: >
Streams is a new and experimental way to manage your data in Kibana (currently experimental - expect changes).
x-displayName: "Streams"
- target: '$.tags[?(@.name=="cases")]'
description: Change tag description and displayName
update:
description: >
Cases are used to open and track issues.
You can add assignees and tags to your cases, set their severity and status, and add alerts, comments, and visualizations.
You can also send cases to external incident management systems by configuring connectors.
externalDocs:
description: Cases documentation
url: https://www.elastic.co/guide/en/kibana/master/cases.html
x-displayName: "Cases"
- target: '$.tags[?(@.name=="connectors")]'
description: Change tag description and displayName
update:
description: >
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.
externalDocs:
description: Connector documentation
url: https://www.elastic.co/guide/en/kibana/current/action-types.html
x-displayName: "Connectors"
- target: '$.tags[?(@.name=="data views")]'
description: Change displayName
update:
Expand Down
86 changes: 34 additions & 52 deletions src/platform/packages/shared/kbn-doc-links/src/get_doc_links.ts
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,7 @@ export const getDocLinks = ({ kibanaBranch, buildFlavor }: GetDocLinkOptions): D
const ELASTIC_WEBSITE_URL = meta.elasticWebsiteUrl;
const ELASTIC_GITHUB = meta.elasticGithubUrl;
const SEARCH_LABS_URL = meta.searchLabsUrl;
const ELASTIC_DOCS = meta.docsWebsiteUrl;

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

return deepFreeze({
settings: `${ELASTIC_WEBSITE_URL}guide/en/kibana/${DOC_LINK_VERSION}/settings.html`,
settings: `${ELASTIC_DOCS}reference/kibana/configuration-reference`,
elasticStackGetStarted: isServerless
? `${SERVERLESS_DOCS}intro.html`
: `${ELASTIC_WEBSITE_URL}guide/en/index.html`,
apiReference: `${ELASTIC_WEBSITE_URL}guide/en/starting-with-the-elasticsearch-platform-and-its-solutions/current/api-reference.html`,
? `${ELASTIC_DOCS}deploy-manage/deploy/elastic-cloud/serverless`
: `${ELASTIC_DOCS}get-started`,
apiReference: `${ELASTIC_DOCS}apis`,
upgrade: {
upgradingStackOnPrem: `${ELASTIC_WEBSITE_URL}guide/en/elastic-stack/current/upgrading-elastic-stack-on-prem.html`,
upgradingStackOnCloud: `${ELASTIC_WEBSITE_URL}guide/en/elastic-stack/current/upgrade-elastic-stack-for-elastic-cloud.html`,
Expand Down Expand Up @@ -604,49 +605,34 @@ export const getDocLinks = ({ kibanaBranch, buildFlavor }: GetDocLinkOptions): D
aiAssistant: `${OBSERVABILITY_DOCS}obs-ai-assistant.html`,
},
alerting: {
guide: isServerless
? `${SERVERLESS_DOCS}rules.html`
: `${KIBANA_DOCS}create-and-manage-rules.html`,
actionTypes: isServerless
? `${SERVERLESS_DOCS}action-connectors.html`
: `${KIBANA_DOCS}action-types.html`,
apmRulesErrorCount: isServerless
? `${SERVERLESS_DOCS}observability-create-error-count-threshold-alert-rule.html`
: `${KIBANA_DOCS}apm-alerts.html`,
apmRulesTransactionDuration: isServerless
? `${SERVERLESS_DOCS}observability-create-latency-threshold-alert-rule.html`
: `${KIBANA_DOCS}apm-alerts.html`,
apmRulesTransactionError: isServerless
? `${SERVERLESS_DOCS}observability-create-failed-transaction-rate-threshold-alert-rule.html`
: `${KIBANA_DOCS}apm-alerts.html`,
apmRulesAnomaly: isServerless
? `${SERVERLESS_DOCS}observability-create-anomaly-alert-rule.html`
: `${KIBANA_DOCS}apm-alerts.html`,
emailAction: `${KIBANA_DOCS}email-action-type.html`,
emailActionConfig: `${KIBANA_DOCS}email-action-type.html`,
emailExchangeClientSecretConfig: `${KIBANA_DOCS}email-action-type.html#exchange-client-secret`,
emailExchangeClientIdConfig: `${KIBANA_DOCS}email-action-type.html#exchange-client-tenant-id`,
generalSettings: `${KIBANA_DOCS}alert-action-settings-kb.html#general-alert-action-settings`,
indexAction: `${KIBANA_DOCS}index-action-type.html`,
esQuery: `${KIBANA_DOCS}rule-type-es-query.html`,
indexThreshold: `${KIBANA_DOCS}rule-type-index-threshold.html`,
maintenanceWindows: isServerless
? `${SERVERLESS_DOCS}maintenance-windows.html`
: `${KIBANA_DOCS}maintenance-windows.html`,
pagerDutyAction: `${KIBANA_DOCS}pagerduty-action-type.html`,
preconfiguredConnectors: `${KIBANA_DOCS}pre-configured-connectors.html`,
preconfiguredAlertHistoryConnector: `${KIBANA_DOCS}pre-configured-connectors.html#preconfigured-connector-alert-history`,
serviceNowAction: `${KIBANA_DOCS}servicenow-action-type.html#configuring-servicenow`,
serviceNowSIRAction: `${KIBANA_DOCS}servicenow-sir-action-type.html`,
setupPrerequisites: `${KIBANA_DOCS}alerting-setup.html#alerting-prerequisites`,
slackAction: `${KIBANA_DOCS}slack-action-type.html#configuring-slack-webhook`,
slackApiAction: `${KIBANA_DOCS}slack-action-type.html#configuring-slack-web-api`,
teamsAction: `${KIBANA_DOCS}teams-action-type.html#configuring-teams`,
connectors: `${KIBANA_DOCS}action-types.html`,
legacyRuleApiDeprecations: `${KIBANA_DOCS}breaking-changes-summary.html#breaking-201550`,
guide: `${ELASTIC_DOCS}explore-analyze/alerts-cases/alerts/create-manage-rules`,
actionTypes: `${ELASTIC_DOCS}reference/kibana/connectors-kibana`,
apmRulesErrorCount: `${ELASTIC_DOCS}solutions/observability/incident-management/create-an-error-count-threshold-rule`,
apmRulesTransactionDuration: `${ELASTIC_DOCS}solutions/observability/incident-management/create-latency-threshold-rule`,
apmRulesTransactionError: `${ELASTIC_DOCS}solutions/observability/incident-management/create-failed-transaction-rate-threshold-rule`,
apmRulesAnomaly: `${ELASTIC_DOCS}solutions/observability/incident-management/create-an-apm-anomaly-rule`,
emailAction: `${ELASTIC_DOCS}reference/kibana/connectors-kibana/email-action-type`,
emailActionConfig: `${ELASTIC_DOCS}reference/kibana/connectors-kibana/email-action-type`,
emailExchangeClientSecretConfig: `${ELASTIC_DOCS}reference/kibana/connectors-kibana/email-action-type#exchange-client-secret`,
emailExchangeClientIdConfig: `${ELASTIC_DOCS}reference/kibana/connectors-kibana/email-action-type#exchange-client-tenant-id`,
generalSettings: `${ELASTIC_DOCS}reference/kibana/configuration-reference/alerting-settings#general-alert-action-settings`,
indexAction: `${ELASTIC_DOCS}reference/kibana/connectors-kibana/index-action-type`,
esQuery: `${ELASTIC_DOCS}explore-analyze/alerts-cases/alerts/rule-type-es-query`,
indexThreshold: `${ELASTIC_DOCS}explore-analyze/alerts-cases/alerts/rule-type-index-threshold`,
maintenanceWindows: `${ELASTIC_DOCS}explore-analyze/alerts-cases/alerts/maintenance-windows`,
pagerDutyAction: `${ELASTIC_DOCS}reference/kibana/connectors-kibana/pagerduty-action-type`,
preconfiguredConnectors: `${ELASTIC_DOCS}reference/kibana/connectors-kibana/pre-configured-connectors`,
preconfiguredAlertHistoryConnector: `${ELASTIC_DOCS}reference/kibana/connectors-kibana/pre-configured-connectors#preconfigured-connector-alert-history`,
serviceNowAction: `${ELASTIC_DOCS}reference/kibana/connectors-kibana/servicenow-action-type#configuring-servicenow`,
serviceNowSIRAction: `${ELASTIC_DOCS}reference/kibana/connectors-kibana/servicenow-sir-action-type`,
setupPrerequisites: `${ELASTIC_DOCS}explore-analyze/alerts-cases/alerts/alerting-setup#alerting-prerequisites`,
slackAction: `${ELASTIC_DOCS}reference/kibana/connectors-kibana/slack-action-type#configuring-slack-webhook`,
slackApiAction: `${ELASTIC_DOCS}reference/kibana/connectors-kibana/slack-action-type#configuring-slack-web-api`,
teamsAction: `${ELASTIC_DOCS}reference/kibana/connectors-kibana/teams-action-type#configuring-teams`,
connectors: `${ELASTIC_DOCS}reference/kibana/connectors-kibana`,
},
taskManager: {
healthMonitoring: `${KIBANA_DOCS}task-manager-health-monitoring.html`,
healthMonitoring: `${ELASTIC_DOCS}deploy-manage/monitor/kibana-task-manager-health-monitoring`,
},
maps: {
connectToEms: `${KIBANA_DOCS}maps-connect-to-ems.html`,
Expand All @@ -672,10 +658,9 @@ export const getDocLinks = ({ kibanaBranch, buildFlavor }: GetDocLinkOptions): D
troubleshootKibana: `${KIBANA_DOCS}monitor-troubleshooting.html`,
},
reporting: {
cloudMinimumRequirements: `${KIBANA_DOCS}reporting-getting-started.html#reporting-on-cloud-resource-requirements`,
grantUserAccess: `${KIBANA_DOCS}secure-reporting.html#grant-user-access`,
browserSystemDependencies: `${KIBANA_DOCS}secure-reporting.html#install-reporting-packages`,
browserSandboxDependencies: `${KIBANA_DOCS}reporting-troubleshooting-pdf.html#reporting-troubleshooting-sandbox-dependency`,
cloudMinimumRequirements: `${ELASTIC_DOCS}explore-analyze/report-and-share#_embed_outside_of_kib`,
browserSystemDependencies: `${ELASTIC_DOCS}deploy-manage/kibana-reporting-configuration#install-reporting-packages`,
browserSandboxDependencies: `${ELASTIC_DOCS}explore-analyze/report-and-share/reporting-troubleshooting-pdf#reporting-troubleshooting-sandbox-dependency`,
},
security: {
apiKeyServiceSettings: `${ELASTICSEARCH_DOCS}security-settings.html#api-key-service-settings`,
Expand Down Expand Up @@ -979,9 +964,6 @@ export const getDocLinks = ({ kibanaBranch, buildFlavor }: GetDocLinkOptions): D
inferenceManagement: {
inferenceAPIDocumentation: `${ELASTIC_WEBSITE_URL}docs/api/doc/elasticsearch/operation/operation-inference-put`,
},
cases: {
legacyApiDeprecations: `${KIBANA_DOCS}breaking-changes-summary.html#breaking-201004`,
},
synonyms: {
synonymsAPIDocumentation: `${ELASTIC_WEBSITE_URL}guide/en/elasticsearch/reference/current/synonyms-apis.html`,
},
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ export const getDocLinksMeta = ({
ecs_version: 'current',
elasticWebsiteUrl: 'https://www.elastic.co/',
elasticGithubUrl: 'https://github.com/elastic/',
docsWebsiteUrl: 'https://docs.elastic.co/',
docsWebsiteUrl: 'https://www.elastic.co/docs/',
searchLabsUrl: 'https://search-labs.elastic.co/',
};
};
5 changes: 0 additions & 5 deletions src/platform/packages/shared/kbn-doc-links/src/types.ts
Original file line number Diff line number Diff line change
Expand Up @@ -433,7 +433,6 @@ export interface DocLinks {
slackApiAction: string;
teamsAction: string;
connectors: string;
legacyRuleApiDeprecations: string;
}>;
readonly taskManager: Readonly<{
healthMonitoring: string;
Expand All @@ -448,7 +447,6 @@ export interface DocLinks {
readonly monitoring: Record<string, string>;
readonly reporting: Readonly<{
cloudMinimumRequirements: string;
grantUserAccess: string;
browserSystemDependencies: string;
browserSandboxDependencies: string;
}>;
Expand Down Expand Up @@ -641,9 +639,6 @@ export interface DocLinks {
readonly inferenceManagement: {
readonly inferenceAPIDocumentation: string;
};
readonly cases: {
readonly legacyApiDeprecations: string;
};
readonly synonyms: {
readonly synonymsAPIDocumentation: string;
};
Expand Down
Loading