Skip to content

Commit f6c1c74

Browse files
authored
[DOCS] Edit the Watcher summaries and descriptions (#3345)
1 parent 14ddb71 commit f6c1c74

15 files changed

+221
-76
lines changed

docs/overlays/elasticsearch-shared-overlays.yaml

+21-16
Original file line numberDiff line numberDiff line change
@@ -43,19 +43,19 @@ actions:
4343
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.
4444
externalDocs:
4545
url: https://www.elastic.co/guide/en/elasticsearch/reference/master/es-connectors-tutorial-api.html
46-
description: Connector API tutorial
46+
description: Check out the connector API tutorial
4747
- name: ccr
4848
x-displayName: Cross-cluster replication
4949
# D
5050
- name: data stream
5151
x-displayName: Data stream
5252
externalDocs:
53-
description: Data stream overview
53+
description: Learn more about data streams.
5454
url: https://www.elastic.co/guide/en/elasticsearch/reference/master/data-streams.html
5555
- name: document
5656
x-displayName: Document
5757
externalDocs:
58-
description: Reading and writing documents
58+
description: Learn more about reading and writing documents.
5959
url: https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-replication.html
6060
# E
6161
- name: enrich
@@ -66,14 +66,14 @@ actions:
6666
Event Query Language (EQL) is a query language for event-based time series data, such as logs, metrics, and traces.
6767
externalDocs:
6868
url: https://www.elastic.co/guide/en/elasticsearch/reference/master/eql.html
69-
description: EQL search
69+
description: Learn more about EQL search.
7070
- name: esql
7171
x-displayName: ES|QL
7272
description: >
7373
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.
7474
externalDocs:
7575
url: https://www.elastic.co/guide/en/elasticsearch/reference/master/esql.html
76-
description: ES|QL overview and tutorials
76+
description: Learn more about ES|QL.
7777
# F
7878
- name: features
7979
description: The feature APIs enable you to introspect and manage features provided by Elasticsearch and Elasticsearch plugins.
@@ -87,7 +87,7 @@ actions:
8787
The graph explore API enables you to extract and summarize information about the documents and terms in an Elasticsearch data stream or index.
8888
externalDocs:
8989
url: https://www.elastic.co/guide/en/kibana/master/xpack-graph.html
90-
description: Getting started with Graph
90+
description: Get started with Graph.
9191
# I
9292
- name: indices
9393
x-displayName: Index
@@ -97,7 +97,7 @@ actions:
9797
x-displayName: Index lifecycle management
9898
externalDocs:
9999
url: https://www.elastic.co/guide/en/elasticsearch/reference/master/index-lifecycle-management.html
100-
description: Manage the index lifecycle
100+
description: Learn more about managing the index lifecycle.
101101
- name: inference
102102
x-displayName: Inference
103103
description: >
@@ -115,14 +115,14 @@ actions:
115115
description: Licensing APIs enable you to manage your licenses.
116116
externalDocs:
117117
url: https://www.elastic.co/subscriptions
118-
description: For more information about the different types of licenses, refer to Elastic subscriptions
118+
description: For more information about the different types of licenses, refer to Elastic subscriptions.
119119
- name: logstash
120120
x-displayName: Logstash
121121
description: >
122122
Logstash APIs enable you to manage pipelines that are used by Logstash Central Management.
123123
externalDocs:
124124
url: https://www.elastic.co/guide/en/logstash/master/logstash-centralized-pipeline-management.html
125-
description: Centralized pipeline management
125+
description: Learn more about centralized pipeline management.
126126
# M
127127
- name: ml
128128
x-displayName: Machine learning
@@ -131,19 +131,19 @@ actions:
131131
# description:
132132
externalDocs:
133133
url: https://www.elastic.co/guide/en/machine-learning/master/ml-ad-finding-anomalies.html
134-
description: Finding anomalies
134+
description: Learn more about finding anomalies.
135135
- name: ml data frame
136136
x-displayName: Machine learning data frame analytics
137137
# description:
138138
externalDocs:
139139
url: https://www.elastic.co/guide/en/machine-learning/master/ml-dfa-overview.html
140-
description: Data frame analytics overview
140+
description: Learn more about data frame analytics.
141141
- name: ml trained model
142142
x-displayName: Machine learning trained model
143143
# description:
144144
externalDocs:
145145
url: https://www.elastic.co/guide/en/machine-learning/master/ml-nlp-overview.html
146-
description: Natural language processing overview
146+
description: Learn more about natural language processing.
147147
- name: migration
148148
x-displayName: Migration
149149
- name: monitoring
@@ -163,7 +163,7 @@ actions:
163163
This allows pinning documents for only queries that match a specific term.
164164
externalDocs:
165165
url: https://www.elastic.co/guide/en/elasticsearch/reference/master/query-dsl-rule-query.html
166-
description: Rule query
166+
description: Learn more about the rule query.
167167
# R
168168
- name: rollup
169169
x-displayName: Rollup
@@ -184,21 +184,21 @@ actions:
184184
Snapshot and restore APIs enable you to set up snapshot repositories, manage snapshot backups, and restore snapshots to a running cluster.
185185
externalDocs:
186186
url: https://www.elastic.co/guide/en/elasticsearch/reference/master/snapshot-restore.html
187-
description: Snapshot and restore
187+
description: Learn more about snapshot and restore operations.
188188
- name: slm
189189
x-displayName: Snapshot lifecycle management
190190
description: >
191191
Snapshot lifecycle management (SLM) APIs enable you to set up policies to automatically take snapshots and control how long they are retained.
192192
externalDocs:
193193
url: https://www.elastic.co/guide/en/elasticsearch/reference/master/snapshots-take-snapshot.html
194-
description: Create a snapshot
194+
description: Learn more about creating a snapshot.
195195
- name: sql
196196
x-displayName: SQL
197197
description: >
198198
Elasticsearch's SQL APIs enable you to run SQL queries on Elasticsearch indices and data streams.
199199
externalDocs:
200200
url: https://www.elastic.co/guide/en/elasticsearch/reference/master/xpack-sql.html
201-
description: An overview and tutorials for the Elasticsearch SQL features
201+
description: Check out the overview and tutorials for the Elasticsearch SQL features.
202202
- name: synonyms
203203
x-displayName: Synonyms
204204
description: >
@@ -218,6 +218,11 @@ actions:
218218
# W
219219
- name: watcher
220220
x-displayName: Watcher
221+
description: >
222+
You can use Watcher to watch for changes or anomalies in your data and perform the necessary actions in response.
223+
externalDocs:
224+
url: https://www.elastic.co/guide/en/elasticsearch/reference/master/xpack-alerting.html
225+
description: Learn more about Watcher.
221226
# Add x-model and/or abbreviate schemas that should point to other references
222227
- target: "$.components['schemas']['_types.query_dsl:QueryContainer']"
223228
description: Add x-model for the QueryContainer object

0 commit comments

Comments
 (0)