Skip to content

[DOCS] Update esql docs readme with 9.x+ version differentiation guidance #130340

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 6 commits into from
Jul 1, 2025
Merged

[DOCS] Update esql docs readme with 9.x+ version differentiation guidance #130340

merged 6 commits into from
Jul 1, 2025

Conversation

leemthompo
Copy link
Contributor

@leemthompo leemthompo commented Jun 30, 2025 •
edited
Loading

closes https://github.com/elastic/developer-docs-team/issues/310

Adds info about working with applies_to in the ESQL docs

@leemthompo leemthompo self-assigned this Jun 30, 2025
@leemthompo leemthompo requested a review from craigtaverner June 30, 2025 15:31
@github-actions GitHub Actions
Copy link
Contributor

github-actions bot commented Jun 30, 2025 •
edited
Loading

🔍 Preview links for changed docs:

🔔 The preview site may take up to 3 minutes to finish building. These links will become live once it completes.

@elasticsearchmachine elasticsearchmachine added v9.2.0 needs:triage Requires assignment of a team area label labels Jun 30, 2025
@leemthompo leemthompo added >docs General docs changes Team:Analytics Meta label for analytical engine team (ESQL/Aggs/Geo) and removed needs:triage Requires assignment of a team area label labels Jun 30, 2025
@elasticsearchmachine elasticsearchmachine added Team:Docs Meta label for docs team and removed Team:Analytics Meta label for analytical engine team (ESQL/Aggs/Geo) labels Jun 30, 2025
@elasticsearchmachine
Copy link
Collaborator

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

@leemthompo leemthompo mentioned this pull request Jun 30, 2025
Merged
florent-leborgne
florent-leborgne reviewed Jun 30, 2025
View reviewed changes
@leemthompo leemthompo added auto-backport Automatically create backport pull requests when merged v9.0.0 v9.1.0 labels Jul 1, 2025
craigtaverner
craigtaverner approved these changes Jul 1, 2025
View reviewed changes
Copy link
Contributor

@craigtaverner craigtaverner left a comment

Choose a reason for hiding this comment

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

Very useful information. I approved the PR, but do have a few suggestions for improvements.

docs/reference/query-languages/esql/README.md Outdated

```java
preview = true,
@FunctionAppliesTo(lifeCycle = FunctionAppliesToLifecycle.PREVIEW, version = "9.0.0")
Copy link
Contributor

Choose a reason for hiding this comment

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

This is always within @FunctionInfo, so make an example with the complete @FunctionInfo.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

a83e11d

docs/reference/query-languages/esql/README.md Outdated
When a feature evolves from preview in `9.0` to GA in `9.2`, add a new entry alongside the existing preview entry and remove the `preview = true` boolean:

```java
@FunctionAppliesTo(lifeCycle = FunctionAppliesToLifecycle.PREVIEW, version = "9.0.0")
Copy link
Contributor

Choose a reason for hiding this comment

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

This should be a comma-separated list within the appliesTo = {} part of @FunctionInfo.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

a83e11d

docs/reference/query-languages/esql/README.md

### Key rules

1. **Use the `preview = true` boolean** for any tech preview feature - this is required for the Kibana inline docs
Copy link
Contributor

Choose a reason for hiding this comment

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

I feel like we could deduce this from the appliesTo and don't need a separate flag, but we can do that simplification separately.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Yeah definitely, just documenting the current state for now :)

@leemthompo leemthompo merged commit 137eac5 into elastic:main Jul 1, 2025
9 checks passed
@leemthompo leemthompo deleted the esql-docs-readme branch July 1, 2025 16:16
@leemthompo leemthompo mentioned this pull request Jul 1, 2025
Merged
leemthompo added a commit to leemthompo/elasticsearch that referenced this pull request Jul 1, 2025
@leemthompo
[DOCS] Update esql docs readme with 9.x+ version differentiation guid…
5a45682 
…ance (elastic#130340)
@elasticsearchmachine
Copy link
Collaborator

💔 Backport failed

Status Branch Result
❌ 9.0 Commit could not be cherrypicked due to conflicts
✅ 9.1

You can use sqren/backport to manually backport by running backport --upstream elastic/elasticsearch --pr 130340

elasticsearchmachine pushed a commit that referenced this pull request Jul 1, 2025
@leemthompo
[DOCS] Update esql docs readme with 9.x+ version differentiation guid…
c772528 
…ance (#130340) (#130400)
This was referenced Jul 2, 2025
Closed
Merged
@leemthompo
Copy link
Contributor Author

💚 All backports created successfully

Status Branch Result
✅ 9.0

Questions ?

Please refer to the Backport tool documentation

leemthompo added a commit to leemthompo/elasticsearch that referenced this pull request Jul 2, 2025
@leemthompo
[DOCS] Update esql docs readme with 9.x+ version differentiation guid…
ac53476 
…ance (elastic#130340)

(cherry picked from commit 137eac5)

# Conflicts:
#	docs/reference/query-languages/esql/README.md
elasticsearchmachine pushed a commit that referenced this pull request Jul 2, 2025
@leemthompo
[DOCS] Update esql docs readme with 9.x+ version differentiation guid…
1927c72 
…ance (#130340) (#130437)

(cherry picked from commit 137eac5)

# Conflicts:
#	docs/reference/query-languages/esql/README.md
mridula-s109 pushed a commit to mridula-s109/elasticsearch that referenced this pull request Jul 3, 2025
@leemthompo @mridula-s109
[DOCS] Update esql docs readme with 9.x+ version differentiation guid…
cd7b647 
…ance (elastic#130340)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@florent-leborgne florent-leborgne florent-leborgne left review comments

@craigtaverner craigtaverner craigtaverner approved these changes

Assignees

@leemthompo leemthompo

Labels
auto-backport Automatically create backport pull requests when merged backport pending >docs General docs changes Team:Docs Meta label for docs team v9.0.0 v9.1.0 v9.2.0
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@leemthompo @elasticsearchmachine @craigtaverner @florent-leborgne