Skip to content

[DOCS] Focus scripting docs on Painless #69748

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
Merged
merged 34 commits into from
Mar 18, 2021
Merged

[DOCS] Focus scripting docs on Painless #69748

merged 34 commits into from
Mar 18, 2021

Conversation

lockewritesdocs
Copy link
Contributor

@lockewritesdocs lockewritesdocs commented Mar 1, 2021 •
edited
Loading

This PR seeks to:

  • Refocus the scripting docs around Painless
  • Provide an on-ramp to Painless for new users
  • Simplify the onboarding process for writing Painless scripts

Preview links:

@lockewritesdocs lockewritesdocs self-assigned this Mar 1, 2021
jdconrad
jdconrad approved these changes Mar 1, 2021
View reviewed changes
Copy link
Contributor

@jdconrad jdconrad left a comment

Choose a reason for hiding this comment

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

@lockewritesdocs This is a great start! I want to get this in quickly as it's a big improvement. As a follow up, I think for a beginner's guide we need to focus on simplifying some of the information given here. The types section strikes me as particularly advanced right now. I'm happy to help out with this.

@lockewritesdocs lockewritesdocs added the >docs General docs changes label Mar 2, 2021
@lockewritesdocs
Copy link
Contributor Author

@elasticmachine update branch

@lockewritesdocs
Copy link
Contributor Author

@elasticmachine update branch

stu-elastic
stu-elastic approved these changes Mar 17, 2021
View reviewed changes
Copy link
Contributor

@stu-elastic stu-elastic left a comment

Choose a reason for hiding this comment

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

Great change!

Just fix up those last comments and wait for CI to pass.

@lockewritesdocs
Copy link
Contributor Author

@elasticmachine update branch

jdconrad
jdconrad approved these changes Mar 18, 2021
View reviewed changes
Copy link
Contributor

@jdconrad jdconrad left a comment

Choose a reason for hiding this comment

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

@lockewritesdocs Thank you for the massive effort here. This is a huge improvement. These docs read soooo nicely now.

I left one very minor comment.

@lockewritesdocs lockewritesdocs merged commit aba4422 into elastic:master Mar 18, 2021
@lockewritesdocs lockewritesdocs deleted the docs__update-scripting-for-painless branch March 18, 2021 19:58
@lockewritesdocs lockewritesdocs mentioned this pull request Mar 18, 2021
Merged
lockewritesdocs pushed a commit to lockewritesdocs/elasticsearch that referenced this pull request Mar 18, 2021
@elasticmachine
[DOCS] [7.12] Focus scripting docs on Painless (elastic#69748)
34e30ed 
* Initial changes for scripting.

* Shorten script examples.

* Expanding types docs.

* Updating types.

* Fixing broken cross-link.

* Fixing map error.

* Incorporating review feedback.

* Fixing broken table.

* Adding more info about reference types.

* Fixing broken path.

* Adding more info an examples for def type.

* Adding more info on operators.

* Incorporating review feedback.

* Adding notconsole for example.

* Removing comments in example.

* More review feedback.

* Editorial changes.

* Incorporating more reviewer feedback.

* Rewrites based on review feedback.

* Adding new sections for storing scripts and shortening scripts.

* Adding redirect for stored scripts.

* Adding DELETE for stored script plus link.

* Adding section for updating docs with scripts.

* Incorporating final feedback from reviews.

* Tightening up a few areas.

* Minor change around other languages.

Co-authored-by: Elastic Machine <[email protected]>
This was referenced Mar 18, 2021
Merged
Closed
lockewritesdocs pushed a commit that referenced this pull request Mar 18, 2021
@elasticmachine
[DOCS] [7.x] Focus scripting docs on Painless (#69748) (#70588)
ab6eba4 
* Initial changes for scripting.

* Shorten script examples.

* Expanding types docs.

* Updating types.

* Fixing broken cross-link.

* Fixing map error.

* Incorporating review feedback.

* Fixing broken table.

* Adding more info about reference types.

* Fixing broken path.

* Adding more info an examples for def type.

* Adding more info on operators.

* Incorporating review feedback.

* Adding notconsole for example.

* Removing comments in example.

* More review feedback.

* Editorial changes.

* Incorporating more reviewer feedback.

* Rewrites based on review feedback.

* Adding new sections for storing scripts and shortening scripts.

* Adding redirect for stored scripts.

* Adding DELETE for stored script plus link.

* Adding section for updating docs with scripts.

* Incorporating final feedback from reviews.

* Tightening up a few areas.

* Minor change around other languages.

Co-authored-by: Elastic Machine <[email protected]>

Co-authored-by: Elastic Machine <[email protected]>
lockewritesdocs pushed a commit that referenced this pull request Mar 19, 2021
@elasticmachine
[DOCS] [7.12] Focus scripting docs on Painless (#69748) (#70589)
71f6155 
* Initial changes for scripting.

* Shorten script examples.

* Expanding types docs.

* Updating types.

* Fixing broken cross-link.

* Fixing map error.

* Incorporating review feedback.

* Fixing broken table.

* Adding more info about reference types.

* Fixing broken path.

* Adding more info an examples for def type.

* Adding more info on operators.

* Incorporating review feedback.

* Adding notconsole for example.

* Removing comments in example.

* More review feedback.

* Editorial changes.

* Incorporating more reviewer feedback.

* Rewrites based on review feedback.

* Adding new sections for storing scripts and shortening scripts.

* Adding redirect for stored scripts.

* Adding DELETE for stored script plus link.

* Adding section for updating docs with scripts.

* Incorporating final feedback from reviews.

* Tightening up a few areas.

* Minor change around other languages.

Co-authored-by: Elastic Machine <[email protected]>

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

@jdconrad jdconrad jdconrad approved these changes

@stu-elastic stu-elastic stu-elastic approved these changes

@rjernst rjernst Awaiting requested review from rjernst

Assignees

@lockewritesdocs lockewritesdocs

Labels
:Core/Infra/Scripting Scripting abstractions, Painless, and Mustache >docs General docs changes Team:Core/Infra Meta label for core/infra team Team:Docs Meta label for docs team v7.12.0 v7.13.0 v8.0.0-alpha1
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
6 participants
@lockewritesdocs @elasticmachine @rjernst @jdconrad @stu-elastic @jakelandis