[docs] Prepare for docs-assembler (#125118)

* reorg files for docs-assembler and create toc.yml files

* fix build error, add redirects

* only toc

* move images
This commit is contained in:
Colleen McGinnis 2025-03-20 12:09:12 -05:00 committed by GitHub
parent 52bc96240c
commit 9bcd59596d
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
396 changed files with 1905 additions and 2214 deletions

View file

@ -5,7 +5,7 @@ mapped_pages:
# Bucket script aggregation context [painless-bucket-script-agg-context]
Use a Painless script in an [`bucket_script` pipeline aggregation](/reference/data-analysis/aggregations/search-aggregations-pipeline-bucket-script-aggregation.md) to calculate a value as a result in a bucket.
Use a Painless script in an [`bucket_script` pipeline aggregation](/reference/aggregations/search-aggregations-pipeline-bucket-script-aggregation.md) to calculate a value as a result in a bucket.
## Variables [_variables]

View file

@ -5,7 +5,7 @@ mapped_pages:
# Bucket selector aggregation context [painless-bucket-selector-agg-context]
Use a Painless script in an [`bucket_selector` aggregation](/reference/data-analysis/aggregations/search-aggregations-pipeline-bucket-selector-aggregation.md) to determine if a bucket should be retained or filtered out.
Use a Painless script in an [`bucket_selector` aggregation](/reference/aggregations/search-aggregations-pipeline-bucket-selector-aggregation.md) to determine if a bucket should be retained or filtered out.
## Variables [_variables_2]

View file

@ -12,7 +12,7 @@ Painless scripts typically run within one of the contexts in the following table
| Name | Painless Documentation | Elasticsearch Documentation |
| --- | --- | --- |
| Runtime field | [Painless Documentation](/reference/scripting-languages/painless/painless-runtime-fields-context.md) | [Elasticsearch Documentation](docs-content://manage-data/data-store/mapping/runtime-fields.md) |
| Ingest processor | [Painless Documentation](/reference/scripting-languages/painless/painless-ingest-processor-context.md) | [Elasticsearch Documentation](/reference/ingestion-tools/enrich-processor/script-processor.md) |
| Ingest processor | [Painless Documentation](/reference/scripting-languages/painless/painless-ingest-processor-context.md) | [Elasticsearch Documentation](/reference/enrich-processor/script-processor.md) |
| Update | [Painless Documentation](/reference/scripting-languages/painless/painless-update-context.md) | [Elasticsearch Documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-update) |
| Update by query | [Painless Documentation](/reference/scripting-languages/painless/painless-update-by-query-context.md) | [Elasticsearch Documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-update-by-query) |
| Reindex | [Painless Documentation](/reference/scripting-languages/painless/painless-reindex-context.md) | [Elasticsearch Documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-reindex) |
@ -23,12 +23,12 @@ Painless scripts typically run within one of the contexts in the following table
| Field | [Painless Documentation](/reference/scripting-languages/painless/painless-field-context.md) | [Elasticsearch Documentation](/reference/elasticsearch/rest-apis/retrieve-selected-fields.md#script-fields) |
| Filter | [Painless Documentation](/reference/scripting-languages/painless/painless-filter-context.md) | [Elasticsearch Documentation](/reference/query-languages/query-dsl/query-dsl-script-query.md) |
| Minimum should match | [Painless Documentation](/reference/scripting-languages/painless/painless-min-should-match-context.md) | [Elasticsearch Documentation](/reference/query-languages/query-dsl/query-dsl-terms-set-query.md) |
| Metric aggregation initialization | [Painless Documentation](/reference/scripting-languages/painless/painless-metric-agg-init-context.md) | [Elasticsearch Documentation](/reference/data-analysis/aggregations/search-aggregations-metrics-scripted-metric-aggregation.md) |
| Metric aggregation map | [Painless Documentation](/reference/scripting-languages/painless/painless-metric-agg-map-context.md) | [Elasticsearch Documentation](/reference/data-analysis/aggregations/search-aggregations-metrics-scripted-metric-aggregation.md) |
| Metric aggregation combine | [Painless Documentation](/reference/scripting-languages/painless/painless-metric-agg-combine-context.md) | [Elasticsearch Documentation](/reference/data-analysis/aggregations/search-aggregations-metrics-scripted-metric-aggregation.md) |
| Metric aggregation reduce | [Painless Documentation](/reference/scripting-languages/painless/painless-metric-agg-reduce-context.md) | [Elasticsearch Documentation](/reference/data-analysis/aggregations/search-aggregations-metrics-scripted-metric-aggregation.md) |
| Bucket script aggregation | [Painless Documentation](/reference/scripting-languages/painless/painless-bucket-script-agg-context.md) | [Elasticsearch Documentation](/reference/data-analysis/aggregations/search-aggregations-pipeline-bucket-script-aggregation.md) |
| Bucket selector aggregation | [Painless Documentation](/reference/scripting-languages/painless/painless-bucket-selector-agg-context.md) | [Elasticsearch Documentation](/reference/data-analysis/aggregations/search-aggregations-pipeline-bucket-selector-aggregation.md) |
| Metric aggregation initialization | [Painless Documentation](/reference/scripting-languages/painless/painless-metric-agg-init-context.md) | [Elasticsearch Documentation](/reference/aggregations/search-aggregations-metrics-scripted-metric-aggregation.md) |
| Metric aggregation map | [Painless Documentation](/reference/scripting-languages/painless/painless-metric-agg-map-context.md) | [Elasticsearch Documentation](/reference/aggregations/search-aggregations-metrics-scripted-metric-aggregation.md) |
| Metric aggregation combine | [Painless Documentation](/reference/scripting-languages/painless/painless-metric-agg-combine-context.md) | [Elasticsearch Documentation](/reference/aggregations/search-aggregations-metrics-scripted-metric-aggregation.md) |
| Metric aggregation reduce | [Painless Documentation](/reference/scripting-languages/painless/painless-metric-agg-reduce-context.md) | [Elasticsearch Documentation](/reference/aggregations/search-aggregations-metrics-scripted-metric-aggregation.md) |
| Bucket script aggregation | [Painless Documentation](/reference/scripting-languages/painless/painless-bucket-script-agg-context.md) | [Elasticsearch Documentation](/reference/aggregations/search-aggregations-pipeline-bucket-script-aggregation.md) |
| Bucket selector aggregation | [Painless Documentation](/reference/scripting-languages/painless/painless-bucket-selector-agg-context.md) | [Elasticsearch Documentation](/reference/aggregations/search-aggregations-pipeline-bucket-selector-aggregation.md) |
| Watcher condition | [Painless Documentation](/reference/scripting-languages/painless/painless-watcher-condition-context.md) | [Elasticsearch Documentation](docs-content://explore-analyze/alerts-cases/watcher/condition-script.md) |
| Watcher transform | [Painless Documentation](/reference/scripting-languages/painless/painless-watcher-transform-context.md) | [Elasticsearch Documentation](docs-content://explore-analyze/alerts-cases/watcher/transform-script.md) |

View file

@ -5,7 +5,7 @@ mapped_pages:
# Ingest processor context [painless-ingest-processor-context]
Use a Painless script in an [ingest processor](/reference/ingestion-tools/enrich-processor/script-processor.md) to modify documents upon insertion.
Use a Painless script in an [ingest processor](/reference/enrich-processor/script-processor.md) to modify documents upon insertion.
**Variables**

View file

@ -5,7 +5,7 @@ mapped_pages:
# Metric aggregation combine context [painless-metric-agg-combine-context]
Use a Painless script to [combine](/reference/data-analysis/aggregations/search-aggregations-metrics-scripted-metric-aggregation.md) values for use in a scripted metric aggregation. A combine script is run once per shard following a [map script](/reference/scripting-languages/painless/painless-metric-agg-map-context.md) and is optional as part of a full metric aggregation.
Use a Painless script to [combine](/reference/aggregations/search-aggregations-metrics-scripted-metric-aggregation.md) values for use in a scripted metric aggregation. A combine script is run once per shard following a [map script](/reference/scripting-languages/painless/painless-metric-agg-map-context.md) and is optional as part of a full metric aggregation.
**Variables**

View file

@ -5,7 +5,7 @@ mapped_pages:
# Metric aggregation initialization context [painless-metric-agg-init-context]
Use a Painless script to [initialize](/reference/data-analysis/aggregations/search-aggregations-metrics-scripted-metric-aggregation.md) values for use in a scripted metric aggregation. An initialization script is run prior to document collection once per shard and is optional as part of the full metric aggregation.
Use a Painless script to [initialize](/reference/aggregations/search-aggregations-metrics-scripted-metric-aggregation.md) values for use in a scripted metric aggregation. An initialization script is run prior to document collection once per shard and is optional as part of the full metric aggregation.
**Variables**

View file

@ -5,7 +5,7 @@ mapped_pages:
# Metric aggregation map context [painless-metric-agg-map-context]
Use a Painless script to [map](/reference/data-analysis/aggregations/search-aggregations-metrics-scripted-metric-aggregation.md) values for use in a scripted metric aggregation. A map script is run once per collected document following an optional [initialization script](/reference/scripting-languages/painless/painless-metric-agg-init-context.md) and is required as part of a full metric aggregation.
Use a Painless script to [map](/reference/aggregations/search-aggregations-metrics-scripted-metric-aggregation.md) values for use in a scripted metric aggregation. A map script is run once per collected document following an optional [initialization script](/reference/scripting-languages/painless/painless-metric-agg-init-context.md) and is required as part of a full metric aggregation.
**Variables**

View file

@ -5,7 +5,7 @@ mapped_pages:
# Metric aggregation reduce context [painless-metric-agg-reduce-context]
Use a Painless script to [reduce](/reference/data-analysis/aggregations/search-aggregations-metrics-scripted-metric-aggregation.md) values to produce the result of a scripted metric aggregation. A reduce script is run once on the coordinating node following a [combine script](/reference/scripting-languages/painless/painless-metric-agg-combine-context.md) (or a [map script](/reference/scripting-languages/painless/painless-metric-agg-map-context.md) if no combine script is specified) and is optional as part of a full metric aggregation.
Use a Painless script to [reduce](/reference/aggregations/search-aggregations-metrics-scripted-metric-aggregation.md) values to produce the result of a scripted metric aggregation. A reduce script is run once on the coordinating node following a [combine script](/reference/scripting-languages/painless/painless-metric-agg-combine-context.md) (or a [map script](/reference/scripting-languages/painless/painless-metric-agg-map-context.md) if no combine script is specified) and is optional as part of a full metric aggregation.
**Variables**

View file

@ -51,7 +51,7 @@ $$$runtime-emit-method$$$
`grok`
: Defines a [grok pattern](/reference/ingestion-tools/enrich-processor/grok-processor.md) to extract structured fields out of a single text field within a document. A grok pattern is like a regular expression that supports aliased expressions that can be reused. See [Define a runtime field with a grok pattern](docs-content://manage-data/data-store/mapping/explore-data-with-runtime-fields.md#runtime-examples-grok).
: Defines a [grok pattern](/reference/enrich-processor/grok-processor.md) to extract structured fields out of a single text field within a document. A grok pattern is like a regular expression that supports aliased expressions that can be reused. See [Define a runtime field with a grok pattern](docs-content://manage-data/data-store/mapping/explore-data-with-runtime-fields.md#runtime-examples-grok).
::::{dropdown} Properties of `grok`
`extract`
@ -61,7 +61,7 @@ $$$runtime-emit-method$$$
`dissect`
: Defines a [dissect pattern](/reference/ingestion-tools/enrich-processor/dissect-processor.md). Dissect operates much like grok, but does not accept regular expressions. See [Define a runtime field with a dissect pattern](docs-content://manage-data/data-store/mapping/explore-data-with-runtime-fields.md#runtime-examples-dissect).
: Defines a [dissect pattern](/reference/enrich-processor/dissect-processor.md). Dissect operates much like grok, but does not accept regular expressions. See [Define a runtime field with a dissect pattern](docs-content://manage-data/data-store/mapping/explore-data-with-runtime-fields.md#runtime-examples-dissect).
::::{dropdown} Properties of `dissect`
`extract`

View file

@ -707,7 +707,7 @@ Run the following curl commands to load the data necessary for the context examp
### Day-of-the-Week Bucket Aggregation Example [_day_of_the_week_bucket_aggregation_example]
The following example uses a [terms aggregation](/reference/data-analysis/aggregations/search-aggregations-bucket-terms-aggregation.md#search-aggregations-bucket-terms-aggregation-script) as part of the [bucket script aggregation context](/reference/scripting-languages/painless/painless-bucket-script-agg-context.md) to display the number of messages from each day-of-the-week.
The following example uses a [terms aggregation](/reference/aggregations/search-aggregations-bucket-terms-aggregation.md#search-aggregations-bucket-terms-aggregation-script) as part of the [bucket script aggregation context](/reference/scripting-languages/painless/painless-bucket-script-agg-context.md) to display the number of messages from each day-of-the-week.
```console
GET /messages/_search?pretty=true
@ -725,7 +725,7 @@ GET /messages/_search?pretty=true
### Morning/Evening Bucket Aggregation Example [_morningevening_bucket_aggregation_example]
The following example uses a [terms aggregation](/reference/data-analysis/aggregations/search-aggregations-bucket-terms-aggregation.md#search-aggregations-bucket-terms-aggregation-script) as part of the [bucket script aggregation context](/reference/scripting-languages/painless/painless-bucket-script-agg-context.md) to display the number of messages received in the morning versus the evening.
The following example uses a [terms aggregation](/reference/aggregations/search-aggregations-bucket-terms-aggregation.md#search-aggregations-bucket-terms-aggregation-script) as part of the [bucket script aggregation context](/reference/scripting-languages/painless/painless-bucket-script-agg-context.md) to display the number of messages received in the morning versus the evening.
```console
GET /messages/_search?pretty=true

View file

@ -5,7 +5,7 @@ mapped_pages:
# Using ingest processors in Painless [painless-ingest]
Some [ingest processors](/reference/ingestion-tools/enrich-processor/index.md) expose behavior through Painless methods that can be called in Painless scripts that execute in ingest pipelines.
Some [ingest processors](/reference/enrich-processor/index.md) expose behavior through Painless methods that can be called in Painless scripts that execute in ingest pipelines.
## Method usage [_method_usage]
@ -42,7 +42,7 @@ POST /_ingest/pipeline/_simulate?verbose
### Byte conversion [_byte_conversion]
Use the [bytes processor](/reference/ingestion-tools/enrich-processor/bytes-processor.md) to return the number of bytes in the human-readable byte value supplied in the `value` parameter.
Use the [bytes processor](/reference/enrich-processor/bytes-processor.md) to return the number of bytes in the human-readable byte value supplied in the `value` parameter.
```painless
long bytes(String value);
@ -51,7 +51,7 @@ long bytes(String value);
### Lowercase conversion [_lowercase_conversion]
Use the [lowercase processor](/reference/ingestion-tools/enrich-processor/lowercase-processor.md) to convert the supplied string in the `value` parameter to its lowercase equivalent.
Use the [lowercase processor](/reference/enrich-processor/lowercase-processor.md) to convert the supplied string in the `value` parameter to its lowercase equivalent.
```painless
String lowercase(String value);
@ -60,7 +60,7 @@ String lowercase(String value);
### Uppercase conversion [_uppercase_conversion]
Use the [uppercase processor](/reference/ingestion-tools/enrich-processor/uppercase-processor.md) to convert the supplied string in the `value` parameter to its uppercase equivalent.
Use the [uppercase processor](/reference/enrich-processor/uppercase-processor.md) to convert the supplied string in the `value` parameter to its uppercase equivalent.
```painless
String uppercase(String value);
@ -69,7 +69,7 @@ String uppercase(String value);
### JSON parsing [_json_parsing]
Use the [JSON processor](/reference/ingestion-tools/enrich-processor/json-processor.md) to convert JSON strings to structured JSON objects. The first `json` method accepts a map and a key. The processor converts the JSON string in the map as specified by the `key` parameter to structured JSON content. That content is added directly to the `map` object.
Use the [JSON processor](/reference/enrich-processor/json-processor.md) to convert JSON strings to structured JSON objects. The first `json` method accepts a map and a key. The processor converts the JSON string in the map as specified by the `key` parameter to structured JSON content. That content is added directly to the `map` object.
The second `json` method accepts a JSON string in the `value` parameter and returns a structured JSON object.
@ -88,7 +88,7 @@ ctx.structuredJson = json;
### URL decoding [_url_decoding]
Use the [URL decode processor](/reference/ingestion-tools/enrich-processor/urldecode-processor.md) to URL-decode the string supplied in the `value` parameter.
Use the [URL decode processor](/reference/enrich-processor/urldecode-processor.md) to URL-decode the string supplied in the `value` parameter.
```painless
String urlDecode(String value);
@ -97,7 +97,7 @@ String urlDecode(String value);
### URI decomposition [_uri_decomposition]
Use the [URI parts processor](/reference/ingestion-tools/enrich-processor/uri-parts-processor.md) to decompose the URI string supplied in the `value` parameter. Returns a map of key-value pairs in which the key is the name of the URI component such as `domain` or `path` and the value is the corresponding value for that component.
Use the [URI parts processor](/reference/enrich-processor/uri-parts-processor.md) to decompose the URI string supplied in the `value` parameter. Returns a map of key-value pairs in which the key is the name of the URI component such as `domain` or `path` and the value is the corresponding value for that component.
```painless
String uriParts(String value);
@ -106,7 +106,7 @@ String uriParts(String value);
### Network community ID [_network_community_id]
Use the [community ID processor](/reference/ingestion-tools/enrich-processor/community-id-processor.md) to compute the network community ID for network flow data.
Use the [community ID processor](/reference/enrich-processor/community-id-processor.md) to compute the network community ID for network flow data.
```painless
String communityId(String sourceIpAddrString, String destIpAddrString, Object ianaNumber, Object transport, Object sourcePort, Object destinationPort, Object icmpType, Object icmpCode, int seed)

View file

@ -1,56 +1,55 @@
toc:
- file: scripting-languages/index.md
# - file: scripting-languages/reference/painless.md
- file: scripting-languages/painless/painless.md
- file: index.md
- file: painless/painless.md
children:
- file: scripting-languages/painless/brief-painless-walkthrough.md
- file: scripting-languages/painless/use-painless-scripts-in-runtime-fields.md
- file: scripting-languages/painless/using-datetime-in-painless.md
- file: scripting-languages/painless/how-painless-dispatches-function.md
- file: scripting-languages/painless/painless-debugging.md
- file: scripting-languages/painless/painless-api-examples.md
- file: scripting-languages/painless/using-ingest-processors-in-painless.md
- file: scripting-languages/painless/painless-language-specification.md
- file: painless/brief-painless-walkthrough.md
- file: painless/use-painless-scripts-in-runtime-fields.md
- file: painless/using-datetime-in-painless.md
- file: painless/how-painless-dispatches-function.md
- file: painless/painless-debugging.md
- file: painless/painless-api-examples.md
- file: painless/using-ingest-processors-in-painless.md
- file: painless/painless-language-specification.md
children:
- file: scripting-languages/painless/painless-comments.md
- file: scripting-languages/painless/painless-keywords.md
- file: scripting-languages/painless/painless-literals.md
- file: scripting-languages/painless/painless-identifiers.md
- file: scripting-languages/painless/painless-variables.md
- file: scripting-languages/painless/painless-types.md
- file: scripting-languages/painless/painless-casting.md
- file: scripting-languages/painless/painless-operators.md
- file: scripting-languages/painless/painless-operators-general.md
- file: scripting-languages/painless/painless-operators-numeric.md
- file: scripting-languages/painless/painless-operators-boolean.md
- file: scripting-languages/painless/painless-operators-reference.md
- file: scripting-languages/painless/painless-operators-array.md
- file: scripting-languages/painless/painless-statements.md
- file: scripting-languages/painless/painless-scripts.md
- file: scripting-languages/painless/painless-functions.md
- file: scripting-languages/painless/painless-lambdas.md
- file: scripting-languages/painless/painless-regexes.md
- file: scripting-languages/painless/painless-contexts.md
- file: painless/painless-comments.md
- file: painless/painless-keywords.md
- file: painless/painless-literals.md
- file: painless/painless-identifiers.md
- file: painless/painless-variables.md
- file: painless/painless-types.md
- file: painless/painless-casting.md
- file: painless/painless-operators.md
- file: painless/painless-operators-general.md
- file: painless/painless-operators-numeric.md
- file: painless/painless-operators-boolean.md
- file: painless/painless-operators-reference.md
- file: painless/painless-operators-array.md
- file: painless/painless-statements.md
- file: painless/painless-scripts.md
- file: painless/painless-functions.md
- file: painless/painless-lambdas.md
- file: painless/painless-regexes.md
- file: painless/painless-contexts.md
children:
- file: scripting-languages/painless/painless-context-examples.md
- file: scripting-languages/painless/painless-runtime-fields-context.md
- file: scripting-languages/painless/painless-ingest-processor-context.md
- file: scripting-languages/painless/painless-update-context.md
- file: scripting-languages/painless/painless-update-by-query-context.md
- file: scripting-languages/painless/painless-reindex-context.md
- file: scripting-languages/painless/painless-sort-context.md
- file: scripting-languages/painless/painless-similarity-context.md
- file: scripting-languages/painless/painless-weight-context.md
- file: scripting-languages/painless/painless-score-context.md
- file: scripting-languages/painless/painless-field-context.md
- file: scripting-languages/painless/painless-filter-context.md
- file: scripting-languages/painless/painless-min-should-match-context.md
- file: scripting-languages/painless/painless-metric-agg-init-context.md
- file: scripting-languages/painless/painless-metric-agg-map-context.md
- file: scripting-languages/painless/painless-metric-agg-combine-context.md
- file: scripting-languages/painless/painless-metric-agg-reduce-context.md
- file: scripting-languages/painless/painless-bucket-script-agg-context.md
- file: scripting-languages/painless/painless-bucket-selector-agg-context.md
- file: scripting-languages/painless/painless-analysis-predicate-context.md
- file: scripting-languages/painless/painless-watcher-condition-context.md
- file: scripting-languages/painless/painless-watcher-transform-context.md
- file: painless/painless-context-examples.md
- file: painless/painless-runtime-fields-context.md
- file: painless/painless-ingest-processor-context.md
- file: painless/painless-update-context.md
- file: painless/painless-update-by-query-context.md
- file: painless/painless-reindex-context.md
- file: painless/painless-sort-context.md
- file: painless/painless-similarity-context.md
- file: painless/painless-weight-context.md
- file: painless/painless-score-context.md
- file: painless/painless-field-context.md
- file: painless/painless-filter-context.md
- file: painless/painless-min-should-match-context.md
- file: painless/painless-metric-agg-init-context.md
- file: painless/painless-metric-agg-map-context.md
- file: painless/painless-metric-agg-combine-context.md
- file: painless/painless-metric-agg-reduce-context.md
- file: painless/painless-bucket-script-agg-context.md
- file: painless/painless-bucket-selector-agg-context.md
- file: painless/painless-analysis-predicate-context.md
- file: painless/painless-watcher-condition-context.md
- file: painless/painless-watcher-transform-context.md