Skip to content

Painless docs overhaul (reference) #137211

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
Open
wants to merge 25 commits into
base: main
Choose a base branch
from
Open

Painless docs overhaul (reference) #137211

wants to merge 25 commits into from

Conversation

@kilfoyle
Copy link
Contributor

@kilfoyle kilfoyle commented Oct 27, 2025 •
edited
Loading

This refreshes the Painless reference docs based on the revamp project done with the Kibernum team. All changes can be previewed in this Painless section. Sorry about the large size!

Related:

@github-actions
Copy link
Contributor

github-actions bot commented Oct 27, 2025 •
edited
Loading

🔍 Preview links for changed docs

More links …

@github-actions
Copy link
Contributor

github-actions bot commented Oct 27, 2025

ℹ️ Important: Docs version tagging

👋 Thanks for updating the docs! Just a friendly reminder that our docs are now cumulative. This means all 9.x versions are documented on the same page and published off of the main branch, instead of creating separate pages for each minor version.

We use applies_to tags to mark version-specific features and changes.

Expand for a quick overview

When to use applies_to tags:

✅ At the page level to indicate which products/deployments the content applies to (mandatory)
✅ When features change state (e.g. preview, ga) in a specific version
✅ When availability differs across deployments and environments

What NOT to do:

❌ Don't remove or replace information that applies to an older version
❌ Don't add new information that applies to a specific version without an applies_to tag
❌ Don't forget that applies_to tags can be used at the page, section, and inline level

🤔 Need help?

@kilfoyle kilfoyle marked this pull request as ready for review November 26, 2025 20:39
@elasticsearchmachine elasticsearchmachine added the needs:triage Requires assignment of a team area label label Nov 26, 2025
@kilfoyle kilfoyle requested a review from a team November 26, 2025 20:40
@kilfoyle kilfoyle changed the title [DRAFT] Painless docs overhaul (reference) Painless docs overhaul (reference) Nov 26, 2025
@kilfoyle kilfoyle added >docs General docs changes Team:Docs Meta label for docs team labels Nov 26, 2025
@elasticsearchmachine elasticsearchmachine removed the needs:triage Requires assignment of a team area label label Nov 26, 2025
@elasticsearchmachine
Copy link
Collaborator

elasticsearchmachine commented Nov 26, 2025

Pinging @elastic/core-docs (Team:Docs)

@kilfoyle kilfoyle mentioned this pull request Nov 28, 2025
Open
@kilfoyle kilfoyle requested a review from jdconrad November 28, 2025 15:42
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@jdconrad jdconrad Awaiting requested review from jdconrad

At least 1 approving review is required to merge this pull request.

Assignees

No one assigned

Labels

>docs General docs changes Team:Docs Meta label for docs team v9.3.0

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@kilfoyle @elasticsearchmachine