Skip to content

Commit a0c782f

Browse files
authored
Painless docs overhaul (explore & analyze) (#3580)
This refreshes the [Scripting](http://localhost:3000/explore-analyze/scripting) section of the Explore and Analyze docs, based on the Painless doc project. The content has had both technical and writer reviews, so this is essentially a port from the gdoc project folder into the V3 docs system. All changes are in this [Introduction to Painless](https://docs-v3-preview.elastic.dev/elastic/docs-content/pull/3580/explore-analyze/scripting/modules-scripting-painless) section. Rel: elastic/docs-content-internal#299
1 parent e083f7b commit a0c782f

22 files changed

+2358
-473
lines changed

deploy-manage/_snippets/field-doc-sec-limitations.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -40,5 +40,5 @@ When a user’s role enables document or [field level security](/deploy-manage/u
4040

4141
* The request cache is disabled for search requests if either of the following are true:
4242

43-
* The role query that defines document level security is [templated](/deploy-manage/users-roles/cluster-or-deployment-auth/controlling-access-at-document-field-level.md#templating-role-query) using a [stored script](/explore-analyze/scripting/modules-scripting-using.md#script-stored-scripts).
43+
* The role query that defines document level security is [templated](/deploy-manage/users-roles/cluster-or-deployment-auth/controlling-access-at-document-field-level.md#templating-role-query) using a [stored script](/explore-analyze/scripting/modules-scripting-store-and-retrieve.md).
4444
* The target indices are a mix of local and remote indices.

deploy-manage/tools/snapshot-and-restore.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -91,7 +91,7 @@ By default, a snapshot of a cluster contains the cluster state, all regular data
9191
- [Legacy index templates](https://www.elastic.co/guide/en/elasticsearch/reference/8.18/indices-templates-v1.html)
9292
- [Ingest pipelines](/manage-data/ingest/transform-enrich/ingest-pipelines.md)
9393
- [ILM policies](/manage-data/lifecycle/index-lifecycle-management.md)
94-
- [Stored scripts](/explore-analyze/scripting/modules-scripting-using.md#script-stored-scripts)
94+
- [Stored scripts](/explore-analyze/scripting/modules-scripting-store-and-retrieve.md)
9595
- For snapshots taken after 7.12.0, [feature states](#feature-state)
9696

9797
You can also take snapshots of only specific data streams or indices in the cluster. A snapshot that includes a data stream or index automatically includes its aliases. When you restore a snapshot, you can choose whether to restore these aliases.

explore-analyze/alerts-cases/watcher/how-watcher-works.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -184,7 +184,7 @@ Deactivating a watch also enables you to keep it around for future use without d
184184

185185
You can use scripts and templates when defining a watch. Scripts and templates can reference elements in the watch execution context, including the watch payload. The execution context defines variables you can use in a script and parameter placeholders in a template.
186186

187-
{{watcher}} uses the Elasticsearch script infrastructure, which supports [inline](#inline-templates-scripts) and [stored](#stored-templates-scripts). Scripts and templates are compiled and cached by Elasticsearch to optimize recurring execution. Autoloading is also supported. For more information, see [Scripting](../../scripting.md) and [*How to write scripts*](../../scripting/modules-scripting-using.md).
187+
{{watcher}} uses the Elasticsearch script infrastructure, which supports [inline](#inline-templates-scripts) and [stored](#stored-templates-scripts). Scripts and templates are compiled and cached by Elasticsearch to optimize recurring execution. Autoloading is also supported. For more information, see [Scripting](../../scripting.md) and [*How to write Painless scripts*](../../scripting/modules-scripting-using.md).
188188

189189

190190
### Watch execution context [watch-execution-context]

explore-analyze/scripting/common-script-uses.md

Lines changed: 13 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -8,10 +8,19 @@ products:
88
- id: elasticsearch
99
---
1010

11-
# Common scripting use cases [common-script-uses]
11+
# Painless script tutorials [common-script-uses]
1212

13-
You can write a script to do almost anything, and sometimes, that’s the trouble. It’s challenging to know what’s possible with scripts, so the following examples address common uses cases where scripts are really helpful.
14-
15-
* [Field extraction](scripting-field-extraction.md)
13+
You can write a script to do almost anything, and sometimes, that’s the challenge. It’s difficult to know what’s possible with scripts, so these tutorials address common use cases where scripts are particularly helpful.
1614

15+
Painless scripting becomes powerful when applied to real-world scenarios. These tutorials walk you through essential patterns and operations, providing working examples you can modify for your specific use cases.
1716

17+
* [Accessing document fields and special variables](/explore-analyze/scripting/modules-scripting-fields.md)
18+
* [Accessing fields in a document](/explore-analyze/scripting/script-fields-api.md)
19+
* [Converting data types](/explore-analyze/scripting/modules-scripting-type-casting-tutorial.md)
20+
* [Dissecting data](/explore-analyze/scripting/dissect.md)
21+
* [Extracting fields](/explore-analyze/scripting/scripting-field-extraction.md)
22+
* [Grokking grok](/explore-analyze/scripting/grok.md)
23+
* [Scripts, caching, and search speed](/explore-analyze/scripting/scripts-search-speed.md)
24+
* [Updating documents](/explore-analyze/scripting/modules-scripting-document-update-tutorial.md)
25+
* [Using Painless regular expressions](/explore-analyze/scripting/modules-scripting-regular-expressions-tutorial.md)
26+
* [Working with dates](/explore-analyze/scripting/modules-scripting-datetime-tutorial.md)

0 commit comments

Comments
 (0)