Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

[DOCS] Improve/fix documentation on stored scripts #119921

Merged
merged 6 commits into from
Jan 10, 2025
Merged

[DOCS] Improve/fix documentation on stored scripts #119921

merged 6 commits into from
Jan 10, 2025

Conversation

consulthys
Copy link
Contributor

Fixes #119919

This PR amends the verbiage used around stored scripts:

  • compilation time of stored script is not reduced in comparison to inline scripts
  • stored scripts do not necessarily run faster than inline scripts
  • stored scripts facilitate collaboration and allow different people to focus on their own part (script vs query)

The changes are done in two different places

@consulthys consulthys added >docs General docs changes :Core/Infra/Scripting Scripting abstractions, Painless, and Mustache backport Team:Docs Meta label for docs team labels Jan 10, 2025
@consulthys consulthys self-assigned this Jan 10, 2025
@github-actions GitHub Actions
Copy link
Contributor

Documentation preview:

@elasticsearchmachine
Copy link
Collaborator

@consulthys please enable the option "Allow edits and access to secrets by maintainers" on your PR. For more information, see the documentation.

@elasticsearchmachine elasticsearchmachine added the external-contributor Pull request authored by a developer outside the Elasticsearch team label Jan 10, 2025
leemthompo
leemthompo reviewed Jan 10, 2025
View reviewed changes
Copy link
Contributor

@leemthompo leemthompo left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I made a couple of rewording suggestions, let me know what you think.

docs/reference/scripting/using.asciidoc Outdated Show resolved Hide resolved
docs/reference/scripting/using.asciidoc Outdated Show resolved Hide resolved
docs/reference/transform/painless-examples.asciidoc Outdated Show resolved Hide resolved
@leemthompo leemthompo added the auto-backport Automatically create backport pull requests when merged label Jan 10, 2025
@consulthys
Copy link
Contributor Author

Thank you @leemthompo looks great to me 👍

leemthompo
leemthompo approved these changes Jan 10, 2025
View reviewed changes
Copy link
Contributor

@leemthompo leemthompo left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for updating the docs!

@consulthys consulthys enabled auto-merge (squash) January 10, 2025 15:50
@consulthys consulthys merged commit 1e608dc into main Jan 10, 2025
5 of 6 checks passed
@consulthys consulthys deleted the fix-stored-script-doc branch January 10, 2025 16:13
This was referenced Jan 10, 2025
Merged
Merged
Merged
leemthompo pushed a commit to leemthompo/elasticsearch that referenced this pull request Jan 10, 2025
@consulthys
[DOCS] Improve/fix documentation on stored scripts (elastic#119921)
91da577 
* Improve/fix documentation on stored scripts

* Update docs/reference/scripting/using.asciidoc

Co-authored-by: Liam Thompson <[email protected]>

* Update docs/reference/scripting/using.asciidoc

Co-authored-by: Liam Thompson <[email protected]>

* Update docs/reference/transform/painless-examples.asciidoc

Co-authored-by: Liam Thompson <[email protected]>

---------

Co-authored-by: Liam Thompson <[email protected]>
(cherry picked from commit 1e608dc)
leemthompo pushed a commit to leemthompo/elasticsearch that referenced this pull request Jan 10, 2025
@consulthys
[DOCS] Improve/fix documentation on stored scripts (elastic#119921)
eb1a6b5 
* Improve/fix documentation on stored scripts

* Update docs/reference/scripting/using.asciidoc

Co-authored-by: Liam Thompson <[email protected]>

* Update docs/reference/scripting/using.asciidoc

Co-authored-by: Liam Thompson <[email protected]>

* Update docs/reference/transform/painless-examples.asciidoc

Co-authored-by: Liam Thompson <[email protected]>

---------

Co-authored-by: Liam Thompson <[email protected]>
(cherry picked from commit 1e608dc)
leemthompo pushed a commit to leemthompo/elasticsearch that referenced this pull request Jan 10, 2025
@consulthys
[DOCS] Improve/fix documentation on stored scripts (elastic#119921)
b456cb6 
* Improve/fix documentation on stored scripts

* Update docs/reference/scripting/using.asciidoc

Co-authored-by: Liam Thompson <[email protected]>

* Update docs/reference/scripting/using.asciidoc

Co-authored-by: Liam Thompson <[email protected]>

* Update docs/reference/transform/painless-examples.asciidoc

Co-authored-by: Liam Thompson <[email protected]>

---------

Co-authored-by: Liam Thompson <[email protected]>
(cherry picked from commit 1e608dc)
elasticsearchmachine pushed a commit that referenced this pull request Jan 10, 2025
@leemthompo @consulthys
[DOCS] Improve/fix documentation on stored scripts (#119921) (#119971)
be6a058 
* Improve/fix documentation on stored scripts

* Update docs/reference/scripting/using.asciidoc

Co-authored-by: Liam Thompson <[email protected]>

* Update docs/reference/scripting/using.asciidoc

Co-authored-by: Liam Thompson <[email protected]>

* Update docs/reference/transform/painless-examples.asciidoc

Co-authored-by: Liam Thompson <[email protected]>

---------

Co-authored-by: Liam Thompson <[email protected]>
(cherry picked from commit 1e608dc)

Co-authored-by: Valentin Crettaz <[email protected]>
elasticsearchmachine pushed a commit that referenced this pull request Jan 10, 2025
@leemthompo @consulthys
[DOCS] Improve/fix documentation on stored scripts (#119921) (#119970)
3b012c0 
* Improve/fix documentation on stored scripts

* Update docs/reference/scripting/using.asciidoc

Co-authored-by: Liam Thompson <[email protected]>

* Update docs/reference/scripting/using.asciidoc

Co-authored-by: Liam Thompson <[email protected]>

* Update docs/reference/transform/painless-examples.asciidoc

Co-authored-by: Liam Thompson <[email protected]>

---------

Co-authored-by: Liam Thompson <[email protected]>
(cherry picked from commit 1e608dc)

Co-authored-by: Valentin Crettaz <[email protected]>
elasticsearchmachine pushed a commit that referenced this pull request Jan 10, 2025
@leemthompo @consulthys
[DOCS] Improve/fix documentation on stored scripts (#119921) (#119972)
304d45d 
* Improve/fix documentation on stored scripts

* Update docs/reference/scripting/using.asciidoc

Co-authored-by: Liam Thompson <[email protected]>

* Update docs/reference/scripting/using.asciidoc

Co-authored-by: Liam Thompson <[email protected]>

* Update docs/reference/transform/painless-examples.asciidoc

Co-authored-by: Liam Thompson <[email protected]>

---------

Co-authored-by: Liam Thompson <[email protected]>
(cherry picked from commit 1e608dc)

Co-authored-by: Valentin Crettaz <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@leemthompo leemthompo leemthompo approved these changes

Assignees

@consulthys consulthys

Labels
auto-backport Automatically create backport pull requests when merged backport :Core/Infra/Scripting Scripting abstractions, Painless, and Mustache >docs General docs changes external-contributor Pull request authored by a developer outside the Elasticsearch team Team:Docs Meta label for docs team v7.17.28 v8.16.4 v8.17.2 v8.18.0 v9.0.0
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

[DOCS] Clarify stored scripts documentation
3 participants
@consulthys @elasticsearchmachine @leemthompo