Skip to content

Commit 46ec7bc

Browse files
authored
[DOCS] Edit the Watcher summaries and descriptions (#3345) (#3354)
(cherry picked from commit f6c1c74)
1 parent 1fb4336 commit 46ec7bc

File tree

15 files changed

+242
-97
lines changed

15 files changed

+242
-97
lines changed

docs/overlays/elasticsearch-shared-overlays.yaml

Lines changed: 42 additions & 37 deletions
Original file line numberDiff line numberDiff line change
@@ -42,21 +42,21 @@ actions:
4242
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:
45-
url: https://www.elastic.co/guide/en/elasticsearch/reference/8.x/es-connectors-tutorial-api.html
46-
description: Connector API tutorial
45+
url: https://www.elastic.co/guide/en/elasticsearch/reference/8.17/es-connectors-tutorial-api.html
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
54-
url: https://www.elastic.co/guide/en/elasticsearch/reference/8.x/data-streams.html
53+
description: Learn more about data streams.
54+
url: https://www.elastic.co/guide/en/elasticsearch/reference/8.17/data-streams.html
5555
- name: document
5656
x-displayName: Document
5757
externalDocs:
58-
description: Reading and writing documents
59-
url: https://www.elastic.co/guide/en/elasticsearch/reference/8.x/docs-replication.html
58+
description: Learn more about reading and writing documents.
59+
url: https://www.elastic.co/guide/en/elasticsearch/reference/8.17/docs-replication.html
6060
# E
6161
- name: enrich
6262
x-displayName: Enrich
@@ -65,15 +65,15 @@ actions:
6565
description: >
6666
Event Query Language (EQL) is a query language for event-based time series data, such as logs, metrics, and traces.
6767
externalDocs:
68-
url: https://www.elastic.co/guide/en/elasticsearch/reference/8.x/eql.html
69-
description: EQL search
68+
url: https://www.elastic.co/guide/en/elasticsearch/reference/8.17/eql.html
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:
75-
url: https://www.elastic.co/guide/en/elasticsearch/reference/8.x/esql.html
76-
description: ES|QL overview and tutorials
75+
url: https://www.elastic.co/guide/en/elasticsearch/reference/8.17/esql.html
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.
@@ -86,8 +86,8 @@ actions:
8686
description: >
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:
89-
url: https://www.elastic.co/guide/en/kibana/8.x/xpack-graph.html
90-
description: Getting started with Graph
89+
url: https://www.elastic.co/guide/en/kibana/8.17/xpack-graph.html
90+
description: Get started with Graph.
9191
# I
9292
- name: indices
9393
x-displayName: Index
@@ -96,8 +96,8 @@ actions:
9696
- name: ilm
9797
x-displayName: Index lifecycle management
9898
externalDocs:
99-
url: https://www.elastic.co/guide/en/elasticsearch/reference/8.x/index-lifecycle-management.html
100-
description: Manage the index lifecycle
99+
url: https://www.elastic.co/guide/en/elasticsearch/reference/8.17/index-lifecycle-management.html
100+
description: Learn more about managing the index lifecycle.
101101
- name: inference
102102
x-displayName: Inference
103103
description: >
@@ -115,35 +115,35 @@ 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:
124-
url: https://www.elastic.co/guide/en/logstash/8.x/logstash-centralized-pipeline-management.html
125-
description: Centralized pipeline management
124+
url: https://www.elastic.co/guide/en/logstash/8.17/logstash-centralized-pipeline-management.html
125+
description: Learn more about centralized pipeline management.
126126
# M
127127
- name: ml
128128
x-displayName: Machine learning
129129
- name: ml anomaly
130130
x-displayName: Machine learning anomaly detection
131131
# description:
132132
externalDocs:
133-
url: https://www.elastic.co/guide/en/machine-learning/8.x/ml-ad-finding-anomalies.html
134-
description: Finding anomalies
133+
url: https://www.elastic.co/guide/en/machine-learning/8.17/ml-ad-finding-anomalies.html
134+
description: Learn more about finding anomalies.
135135
- name: ml data frame
136136
x-displayName: Machine learning data frame analytics
137137
# description:
138138
externalDocs:
139-
url: https://www.elastic.co/guide/en/machine-learning/8.x/ml-dfa-overview.html
140-
description: Data frame analytics overview
139+
url: https://www.elastic.co/guide/en/machine-learning/8.17/ml-dfa-overview.html
140+
description: Learn more about data frame analytics.
141141
- name: ml trained model
142142
x-displayName: Machine learning trained model
143143
# description:
144144
externalDocs:
145-
url: https://www.elastic.co/guide/en/machine-learning/8.x/ml-nlp-overview.html
146-
description: Natural language processing overview
145+
url: https://www.elastic.co/guide/en/machine-learning/8.17/ml-nlp-overview.html
146+
description: Learn more about natural language processing.
147147
- name: migration
148148
x-displayName: Migration
149149
- name: monitoring
@@ -162,8 +162,8 @@ actions:
162162
If a query matches one or more rules in the ruleset, the query is re-written to apply the rules before searching.
163163
This allows pinning documents for only queries that match a specific term.
164164
externalDocs:
165-
url: https://www.elastic.co/guide/en/elasticsearch/reference/8.x/query-dsl-rule-query.html
166-
description: Rule query
165+
url: https://www.elastic.co/guide/en/elasticsearch/reference/8.17/query-dsl-rule-query.html
166+
description: Learn more about the rule query.
167167
# R
168168
- name: rollup
169169
x-displayName: Rollup
@@ -183,22 +183,22 @@ actions:
183183
description: >
184184
Snapshot and restore APIs enable you to set up snapshot repositories, manage snapshot backups, and restore snapshots to a running cluster.
185185
externalDocs:
186-
url: https://www.elastic.co/guide/en/elasticsearch/reference/8.x/snapshot-restore.html
187-
description: Snapshot and restore
186+
url: https://www.elastic.co/guide/en/elasticsearch/reference/8.17/snapshot-restore.html
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:
193-
url: https://www.elastic.co/guide/en/elasticsearch/reference/8.x/snapshots-take-snapshot.html
194-
description: Create a snapshot
193+
url: https://www.elastic.co/guide/en/elasticsearch/reference/8.17/snapshots-take-snapshot.html
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:
200-
url: https://www.elastic.co/guide/en/elasticsearch/reference/8.x/xpack-sql.html
201-
description: An overview and tutorials for the Elasticsearch SQL features
200+
url: https://www.elastic.co/guide/en/elasticsearch/reference/8.17/xpack-sql.html
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/8.17/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
@@ -250,7 +255,7 @@ actions:
250255
x-model: true
251256
externalDocs:
252257
description: Templating a role query
253-
url: https://www.elastic.co/guide/en/elasticsearch/reference/8.x/field-and-document-access-control.html#templating-role-query
258+
url: https://www.elastic.co/guide/en/elasticsearch/reference/8.17/field-and-document-access-control.html#templating-role-query
254259
- target: "$.components['schemas']['_types.query_dsl:DistanceFeatureQuery']"
255260
description: Add x-model for distance feature query
256261
update:
@@ -999,7 +1004,7 @@ actions:
9991004
All the options that are supported by Elasticsearch can be used, as this object is passed verbatim to Elasticsearch.
10001005
By default, this property has the following value: `{"match_all": {"boost": 1}}`.
10011006
externalDocs:
1002-
url: https://www.elastic.co/guide/en/elasticsearch/reference/8.x/query-dsl.html
1007+
url: https://www.elastic.co/guide/en/elasticsearch/reference/8.17/query-dsl.html
10031008
description: Query DSL
10041009
- target: "$.components['schemas']['ml._types:CategorizationAnalyzerDefinition'].properties.tokenizer"
10051010
description: Remove tokenizer object from ML anomaly detection analysis config
@@ -1020,7 +1025,7 @@ actions:
10201025
Additionally, the `ml_classic` tokenizer is available, which tokenizes in the same way as the non-customizable tokenizer in old versions of the product (before 6.2).
10211026
`ml_classic` was the default categorization tokenizer in versions 6.2 to 7.13, so if you need categorization identical to the default for jobs created in these versions, specify `"tokenizer": "ml_classic"` in your `categorization_analyzer`.
10221027
externalDocs:
1023-
url: https://www.elastic.co/guide/en/elasticsearch/reference/8.x/analysis-tokenizers.html
1028+
url: https://www.elastic.co/guide/en/elasticsearch/reference/8.17/analysis-tokenizers.html
10241029
description: Tokenizer reference
10251030
- target: "$.components['schemas']['ml._types:DataframeAnalyticsSource'].properties.query"
10261031
description: Remove query object from data frame analytics source
@@ -1037,7 +1042,7 @@ actions:
10371042
All the options that are supported by Elasticsearch can be used, as this object is passed verbatim to Elasticsearch.
10381043
By default, this property has the following value: `{"match_all": {}}`.
10391044
externalDocs:
1040-
url: https://www.elastic.co/guide/en/elasticsearch/reference/8.x/query-dsl.html
1045+
url: https://www.elastic.co/guide/en/elasticsearch/reference/8.17/query-dsl.html
10411046
description: Query DSL
10421047
- target: "$.components['schemas']['transform._types:Source'].properties.query"
10431048
description: Remove query object from transform source
@@ -1051,14 +1056,14 @@ actions:
10511056
description: >
10521057
A query clause that retrieves a subset of data from the source index.
10531058
externalDocs:
1054-
url: https://www.elastic.co/guide/en/elasticsearch/reference/8.x/query-dsl.html
1059+
url: https://www.elastic.co/guide/en/elasticsearch/reference/8.17/query-dsl.html
10551060
description: Query DSL
10561061
- target: "$.components['schemas']['_global.search._types:FieldCollapse']"
10571062
description: Add x-model and externalDocs
10581063
update:
10591064
x-model: true
10601065
externalDocs:
1061-
url: https://www.elastic.co/guide/en/elasticsearch/reference/8.x/collapse-search-results.html
1066+
url: https://www.elastic.co/guide/en/elasticsearch/reference/8.17/collapse-search-results.html
10621067
- target: "$.components['schemas']['_global.msearch:MultisearchBody'].properties"
10631068
description: Add x-model
10641069
update:

0 commit comments

Comments
 (0)