Add Painless debugging section #4784
Conversation
Vale Linting ResultsSummary: 2 suggestions found 💡 Suggestions (2)
The Vale linter checks documentation changes against the Elastic Docs style guide. To use Vale locally or report issues, refer to Elastic style guide for Vale. |
kilfoyle
changed the title
yetanothertw
left a comment
yetanothertw
left a comment
There was a problem hiding this comment.
I think this Debugging section works so well! Great idea 👏
Thanks for incorporating the notes sections into the intros, the information flows much better IMHO. 🎉
| * [Type casting issues](/explore-analyze/scripting/painless-type-casting-issues.md) | ||
|
|
||
| ## Additional resources | ||
| * [Introduction to Painless](/explore-analyze/scripting/modules-scripting-painless.md) |
There was a problem hiding this comment.
Is it a bit odd to link to the parent section? (Are we operating under the every page is page one assumption?)
I do think we should link the other way around, from the Introduction to Painless to the debugging section, maybe in the Start scripting section?
|
|
||
| ## Additional resources | ||
| * [Introduction to Painless](/explore-analyze/scripting/modules-scripting-painless.md) | ||
| * [A Brief Painless walkthrough](elasticsearch://reference/scripting-languages/painless/brief-painless-walkthrough.md) No newline at end of file |
There was a problem hiding this comment.
Not related to this PR but I noticed that the title on this page doesn't capitalise Painless
2 participants
Summary
This replaces the Painless section that was proposed for the Troubleshooting section of the docs, to instead be a Debugging Painless scripts section in the Explore & Analyze Painless docs.
To my mind, this has two advantages:
@yetanothertw I made changes as we talked about, except that I didn't move the "root cause" sections. As I read through I realized that these are specific to each example, so they wouldn't make sense where the description is. But, I have moved the "Notes" sections to be part of the descriptions at the top of each page (above the fold).
Generative AI disclosure