Skip to content

Conversation

@kilfoyle
Copy link
Contributor

@kilfoyle kilfoyle commented Jan 23, 2026

~~ DRAFT ONLY ~~

Nothing to see here. 👀
Not yet ready for review. :-)


Summary

This replaces the Painless section that was proposed for the Troubleshooting section of the docs, to instead be a "Debugging Painless scripts" section within the Explore & Analyze Painless docs.

To my mind, this has two advantages:

  • These Painless pages aren't true "troubleshooting" docs ,and I think would not fit well into the Symptoms / Diagnosis / Resolution format that is now standard for that section. Debugging, here, is something that people need to be mindful of as they're composing their scripts, rather than a spontaneous error that needs diagnosis and recovery.
  • Embedding this content into the existing Explore and Analyze section means that we have our Painless info in two locations (narrative + reference), rather than split across three separate parts of the docs. Much better as a user experience, IMHO.

Other changes still to come, based on @yetanothertw's comments in the roiginal PR.

Generative AI disclosure

  1. Did you use a generative AI (GenAI) tool to assist in creating this contribution?
  • Yes
  • No

@github-actions
Copy link
Contributor

Vale Linting Results

Summary: 4 suggestions found

💡 Suggestions (4)
File Line Rule Message
explore-analyze/scripting/painless-regex-pattern-matching-failures.md 14 Elastic.WordChoice Consider using 'deactivated, deselected, hidden, turned off, unavailable' instead of 'disabled', unless the term is in the UI.
explore-analyze/scripting/painless-regex-pattern-matching-failures.md 14 Elastic.WordChoice Consider using 'can, might' instead of 'may', unless the term is in the UI.
explore-analyze/scripting/painless-type-casting-issues.md 109 Elastic.Wordiness Consider using 'because' instead of 'since'.
explore-analyze/scripting/painless-type-casting-issues.md 109 Elastic.WordChoice Consider using 'can, might' instead of 'may', unless the term is in the UI.

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant