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.

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] Edit the Watcher summaries and descriptions #3345

Merged
merged 2 commits into from
Dec 18, 2024
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
37 changes: 21 additions & 16 deletions docs/overlays/elasticsearch-shared-overlays.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -43,19 +43,19 @@ actions:
This API provides an alternative to relying solely on Kibana UI for connector and sync job management. The API comes with a set of validations and assertions to ensure that the state representation in the internal index remains valid.
externalDocs:
url: https://www.elastic.co/guide/en/elasticsearch/reference/master/es-connectors-tutorial-api.html
description: Connector API tutorial
description: Check out the connector API tutorial
- name: ccr
x-displayName: Cross-cluster replication
# D
- name: data stream
x-displayName: Data stream
externalDocs:
description: Data stream overview
description: Learn more about data streams.
url: https://www.elastic.co/guide/en/elasticsearch/reference/master/data-streams.html
- name: document
x-displayName: Document
externalDocs:
description: Reading and writing documents
description: Learn more about reading and writing documents.
url: https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-replication.html
# E
- name: enrich
Expand All @@ -66,14 +66,14 @@ actions:
Event Query Language (EQL) is a query language for event-based time series data, such as logs, metrics, and traces.
externalDocs:
url: https://www.elastic.co/guide/en/elasticsearch/reference/master/eql.html
description: EQL search
description: Learn more about EQL search.
- name: esql
x-displayName: ES|QL
description: >
The Elasticsearch Query Language (ES|QL) provides a powerful way to filter, transform, and analyze data stored in Elasticsearch, and in the future in other runtimes.
externalDocs:
url: https://www.elastic.co/guide/en/elasticsearch/reference/master/esql.html
description: ES|QL overview and tutorials
description: Learn more about ES|QL.
# F
- name: features
description: The feature APIs enable you to introspect and manage features provided by Elasticsearch and Elasticsearch plugins.
Expand All @@ -87,7 +87,7 @@ actions:
The graph explore API enables you to extract and summarize information about the documents and terms in an Elasticsearch data stream or index.
externalDocs:
url: https://www.elastic.co/guide/en/kibana/master/xpack-graph.html
description: Getting started with Graph
description: Get started with Graph.
# I
- name: indices
x-displayName: Index
Expand All @@ -97,7 +97,7 @@ actions:
x-displayName: Index lifecycle management
externalDocs:
url: https://www.elastic.co/guide/en/elasticsearch/reference/master/index-lifecycle-management.html
description: Manage the index lifecycle
description: Learn more about managing the index lifecycle.
- name: inference
x-displayName: Inference
description: >
Expand All @@ -115,14 +115,14 @@ actions:
description: Licensing APIs enable you to manage your licenses.
externalDocs:
url: https://www.elastic.co/subscriptions
description: For more information about the different types of licenses, refer to Elastic subscriptions
description: For more information about the different types of licenses, refer to Elastic subscriptions.
- name: logstash
x-displayName: Logstash
description: >
Logstash APIs enable you to manage pipelines that are used by Logstash Central Management.
externalDocs:
url: https://www.elastic.co/guide/en/logstash/master/logstash-centralized-pipeline-management.html
description: Centralized pipeline management
description: Learn more about centralized pipeline management.
# M
- name: ml
x-displayName: Machine learning
Expand All @@ -131,19 +131,19 @@ actions:
# description:
externalDocs:
url: https://www.elastic.co/guide/en/machine-learning/master/ml-ad-finding-anomalies.html
description: Finding anomalies
description: Learn more about finding anomalies.
- name: ml data frame
x-displayName: Machine learning data frame analytics
# description:
externalDocs:
url: https://www.elastic.co/guide/en/machine-learning/master/ml-dfa-overview.html
description: Data frame analytics overview
description: Learn more about data frame analytics.
- name: ml trained model
x-displayName: Machine learning trained model
# description:
externalDocs:
url: https://www.elastic.co/guide/en/machine-learning/master/ml-nlp-overview.html
description: Natural language processing overview
description: Learn more about natural language processing.
- name: migration
x-displayName: Migration
- name: monitoring
Expand All @@ -163,7 +163,7 @@ actions:
This allows pinning documents for only queries that match a specific term.
externalDocs:
url: https://www.elastic.co/guide/en/elasticsearch/reference/master/query-dsl-rule-query.html
description: Rule query
description: Learn more about the rule query.
# R
- name: rollup
x-displayName: Rollup
Expand All @@ -184,21 +184,21 @@ actions:
Snapshot and restore APIs enable you to set up snapshot repositories, manage snapshot backups, and restore snapshots to a running cluster.
externalDocs:
url: https://www.elastic.co/guide/en/elasticsearch/reference/master/snapshot-restore.html
description: Snapshot and restore
description: Learn more about snapshot and restore operations.
- name: slm
x-displayName: Snapshot lifecycle management
description: >
Snapshot lifecycle management (SLM) APIs enable you to set up policies to automatically take snapshots and control how long they are retained.
externalDocs:
url: https://www.elastic.co/guide/en/elasticsearch/reference/master/snapshots-take-snapshot.html
description: Create a snapshot
description: Learn more about creating a snapshot.
- name: sql
x-displayName: SQL
description: >
Elasticsearch's SQL APIs enable you to run SQL queries on Elasticsearch indices and data streams.
externalDocs:
url: https://www.elastic.co/guide/en/elasticsearch/reference/master/xpack-sql.html
description: An overview and tutorials for the Elasticsearch SQL features
description: Check out the overview and tutorials for the Elasticsearch SQL features.
- name: synonyms
x-displayName: Synonyms
description: >
Expand All @@ -218,6 +218,11 @@ actions:
# W
- name: watcher
x-displayName: Watcher
description: >
You can use Watcher to watch for changes or anomalies in your data and perform the necessary actions in response.
externalDocs:
url: https://www.elastic.co/guide/en/elasticsearch/reference/master/xpack-alerting.html
description: Learn more about Watcher.
# Add x-model and/or abbreviate schemas that should point to other references
- target: "$.components['schemas']['_types.query_dsl:QueryContainer']"
description: Add x-model for the QueryContainer object
Expand Down
Loading
Loading