Skip to content

Commit

Permalink
[DOCS] Edit the Watcher summaries and descriptions (#3345)
Browse files Browse the repository at this point in the history
(cherry picked from commit f6c1c74)
  • Loading branch information
lcawl committed Dec 18, 2024
1 parent 2f823ff commit 59655e3
Show file tree
Hide file tree
Showing 15 changed files with 242 additions and 97 deletions.
79 changes: 42 additions & 37 deletions docs/overlays/elasticsearch-shared-overlays.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -42,21 +42,21 @@ 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/8.x/es-connectors-tutorial-api.html
description: Connector API tutorial
url: https://www.elastic.co/guide/en/elasticsearch/reference/8.17/es-connectors-tutorial-api.html
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
url: https://www.elastic.co/guide/en/elasticsearch/reference/8.x/data-streams.html
description: Learn more about data streams.
url: https://www.elastic.co/guide/en/elasticsearch/reference/8.17/data-streams.html
- name: document
x-displayName: Document
externalDocs:
description: Reading and writing documents
url: https://www.elastic.co/guide/en/elasticsearch/reference/8.x/docs-replication.html
description: Learn more about reading and writing documents.
url: https://www.elastic.co/guide/en/elasticsearch/reference/8.17/docs-replication.html
# E
- name: enrich
x-displayName: Enrich
Expand All @@ -65,15 +65,15 @@ actions:
description: >
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/8.x/eql.html
description: EQL search
url: https://www.elastic.co/guide/en/elasticsearch/reference/8.17/eql.html
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/8.x/esql.html
description: ES|QL overview and tutorials
url: https://www.elastic.co/guide/en/elasticsearch/reference/8.17/esql.html
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 @@ -86,8 +86,8 @@ actions:
description: >
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/8.x/xpack-graph.html
description: Getting started with Graph
url: https://www.elastic.co/guide/en/kibana/8.17/xpack-graph.html
description: Get started with Graph.
# I
- name: indices
x-displayName: Index
Expand All @@ -96,8 +96,8 @@ actions:
- name: ilm
x-displayName: Index lifecycle management
externalDocs:
url: https://www.elastic.co/guide/en/elasticsearch/reference/8.x/index-lifecycle-management.html
description: Manage the index lifecycle
url: https://www.elastic.co/guide/en/elasticsearch/reference/8.17/index-lifecycle-management.html
description: Learn more about managing the index lifecycle.
- name: inference
x-displayName: Inference
description: >
Expand All @@ -115,35 +115,35 @@ 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/8.x/logstash-centralized-pipeline-management.html
description: Centralized pipeline management
url: https://www.elastic.co/guide/en/logstash/8.17/logstash-centralized-pipeline-management.html
description: Learn more about centralized pipeline management.
# M
- name: ml
x-displayName: Machine learning
- name: ml anomaly
x-displayName: Machine learning anomaly detection
# description:
externalDocs:
url: https://www.elastic.co/guide/en/machine-learning/8.x/ml-ad-finding-anomalies.html
description: Finding anomalies
url: https://www.elastic.co/guide/en/machine-learning/8.17/ml-ad-finding-anomalies.html
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/8.x/ml-dfa-overview.html
description: Data frame analytics overview
url: https://www.elastic.co/guide/en/machine-learning/8.17/ml-dfa-overview.html
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/8.x/ml-nlp-overview.html
description: Natural language processing overview
url: https://www.elastic.co/guide/en/machine-learning/8.17/ml-nlp-overview.html
description: Learn more about natural language processing.
- name: migration
x-displayName: Migration
- name: monitoring
Expand All @@ -162,8 +162,8 @@ actions:
If a query matches one or more rules in the ruleset, the query is re-written to apply the rules before searching.
This allows pinning documents for only queries that match a specific term.
externalDocs:
url: https://www.elastic.co/guide/en/elasticsearch/reference/8.x/query-dsl-rule-query.html
description: Rule query
url: https://www.elastic.co/guide/en/elasticsearch/reference/8.17/query-dsl-rule-query.html
description: Learn more about the rule query.
# R
- name: rollup
x-displayName: Rollup
Expand All @@ -183,22 +183,22 @@ actions:
description: >
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/8.x/snapshot-restore.html
description: Snapshot and restore
url: https://www.elastic.co/guide/en/elasticsearch/reference/8.17/snapshot-restore.html
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/8.x/snapshots-take-snapshot.html
description: Create a snapshot
url: https://www.elastic.co/guide/en/elasticsearch/reference/8.17/snapshots-take-snapshot.html
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/8.x/xpack-sql.html
description: An overview and tutorials for the Elasticsearch SQL features
url: https://www.elastic.co/guide/en/elasticsearch/reference/8.17/xpack-sql.html
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/8.17/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 Expand Up @@ -250,7 +255,7 @@ actions:
x-model: true
externalDocs:
description: Templating a role query
url: https://www.elastic.co/guide/en/elasticsearch/reference/8.x/field-and-document-access-control.html#templating-role-query
url: https://www.elastic.co/guide/en/elasticsearch/reference/8.17/field-and-document-access-control.html#templating-role-query
- target: "$.components['schemas']['_types.query_dsl:DistanceFeatureQuery']"
description: Add x-model for distance feature query
update:
Expand Down Expand Up @@ -999,7 +1004,7 @@ actions:
All the options that are supported by Elasticsearch can be used, as this object is passed verbatim to Elasticsearch.
By default, this property has the following value: `{"match_all": {"boost": 1}}`.
externalDocs:
url: https://www.elastic.co/guide/en/elasticsearch/reference/8.x/query-dsl.html
url: https://www.elastic.co/guide/en/elasticsearch/reference/8.17/query-dsl.html
description: Query DSL
- target: "$.components['schemas']['ml._types:CategorizationAnalyzerDefinition'].properties.tokenizer"
description: Remove tokenizer object from ML anomaly detection analysis config
Expand All @@ -1020,7 +1025,7 @@ actions:
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).
`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`.
externalDocs:
url: https://www.elastic.co/guide/en/elasticsearch/reference/8.x/analysis-tokenizers.html
url: https://www.elastic.co/guide/en/elasticsearch/reference/8.17/analysis-tokenizers.html
description: Tokenizer reference
- target: "$.components['schemas']['ml._types:DataframeAnalyticsSource'].properties.query"
description: Remove query object from data frame analytics source
Expand All @@ -1037,7 +1042,7 @@ actions:
All the options that are supported by Elasticsearch can be used, as this object is passed verbatim to Elasticsearch.
By default, this property has the following value: `{"match_all": {}}`.
externalDocs:
url: https://www.elastic.co/guide/en/elasticsearch/reference/8.x/query-dsl.html
url: https://www.elastic.co/guide/en/elasticsearch/reference/8.17/query-dsl.html
description: Query DSL
- target: "$.components['schemas']['transform._types:Source'].properties.query"
description: Remove query object from transform source
Expand All @@ -1051,14 +1056,14 @@ actions:
description: >
A query clause that retrieves a subset of data from the source index.
externalDocs:
url: https://www.elastic.co/guide/en/elasticsearch/reference/8.x/query-dsl.html
url: https://www.elastic.co/guide/en/elasticsearch/reference/8.17/query-dsl.html
description: Query DSL
- target: "$.components['schemas']['_global.search._types:FieldCollapse']"
description: Add x-model and externalDocs
update:
x-model: true
externalDocs:
url: https://www.elastic.co/guide/en/elasticsearch/reference/8.x/collapse-search-results.html
url: https://www.elastic.co/guide/en/elasticsearch/reference/8.17/collapse-search-results.html
- target: "$.components['schemas']['_global.msearch:MultisearchBody'].properties"
description: Add x-model
update:
Expand Down
Loading

0 comments on commit 59655e3

Please sign in to comment.