Skip to content

ES|QL: Add docs for FORK #130314

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.

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

Merged
merged 7 commits into from
Jun 30, 2025
Merged

ES|QL: Add docs for FORK #130314

merged 7 commits into from
Jun 30, 2025

Conversation

ioanatia
Copy link
Contributor

#121950

Does what is says.
Now that FORK is out of snapshot and in tech preview, we need to document the feature.

@ioanatia ioanatia added >docs General docs changes auto-backport Automatically create backport pull requests when merged :Search Relevance/Search Catch all for Search Relevance v9.1.0 Team:Search - Relevance The Search organization Search Relevance team labels Jun 30, 2025
Copy link
Contributor

github-actions bot commented Jun 30, 2025

🔍 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 Team:Docs Meta label for docs team Team:Search Relevance Meta label for the Search Relevance team in Elasticsearch v9.2.0 and removed Team:Search - Relevance The Search organization Search Relevance team labels Jun 30, 2025
@elasticsearchmachine
Copy link
Collaborator

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

@elasticsearchmachine
Copy link
Collaborator

Pinging @elastic/es-search-relevance (Team:Search Relevance)

Copy link
Contributor

@leemthompo leemthompo left a comment

Choose a reason for hiding this comment

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

This looks good! I made a couple of comments earlier outside of a proper review, one of which should fix the broken build.

I have a few minor wording suggestions here, but otherwise I have 2 general remarks:

  • Maybe we could have a bit more "Why Use FORK?" information at the outset.
    • Explain when to use FORK (applying different processing logic to the same dataset)
    • Advantages over multiple separate queries or complex CASE statements
    • Common use cases
  • Add More Examples
    • Include comparison examples showing FORK vs alternatives

But that might be out of scope for initial release, so it could just be future food for thought :)

@ioanatia ioanatia requested a review from leemthompo June 30, 2025 12:52
Copy link
Contributor

@leemthompo leemthompo left a comment

Choose a reason for hiding this comment

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

I have just a few more suggestions to basically group related info (branch id, column handling, row ordering) in a more readable fashion. I'd still like to see a couple more illustrative examples but understand this might be good enough for now. :)

@ioanatia ioanatia mentioned this pull request Jun 30, 2025
23 tasks
@ioanatia ioanatia merged commit a239306 into elastic:main Jun 30, 2025
32 checks passed
@ioanatia ioanatia deleted the fork_docs branch June 30, 2025 18:04
@elasticsearchmachine
Copy link
Collaborator

💚 Backport successful

Status Branch Result
9.1

ioanatia added a commit to ioanatia/elasticsearch that referenced this pull request Jun 30, 2025
elasticsearchmachine pushed a commit that referenced this pull request Jun 30, 2025
mridula-s109 pushed a commit to mridula-s109/elasticsearch that referenced this pull request Jul 3, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
auto-backport Automatically create backport pull requests when merged >docs General docs changes :Search Relevance/Search Catch all for Search Relevance Team:Docs Meta label for docs team Team:Search Relevance Meta label for the Search Relevance team in Elasticsearch v9.1.0 v9.2.0
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants