Skip to content

[ES|QL] Add Documentation for MMR command#143809

Merged
markjhoy merged 12 commits intoelastic:mainfrom
markjhoy:markjhoy/add_mmr_esql_documentation
Mar 30, 2026
Merged

[ES|QL] Add Documentation for MMR command#143809
markjhoy merged 12 commits intoelastic:mainfrom
markjhoy:markjhoy/add_mmr_esql_documentation

Conversation

@markjhoy
Copy link
Copy Markdown
Contributor

@markjhoy markjhoy commented Mar 8, 2026

Adds documentation for the ES|QL MMR command.

@github-actions
Copy link
Copy Markdown
Contributor

github-actions bot commented Mar 8, 2026

🔍 Preview links for changed docs

@github-actions
Copy link
Copy Markdown
Contributor

github-actions bot commented Mar 8, 2026

ℹ️ 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?

@markjhoy markjhoy requested review from a team and ioanatia March 8, 2026 21:28
@markjhoy markjhoy added >docs General docs changes >non-issue labels Mar 8, 2026
@markjhoy markjhoy marked this pull request as ready for review March 8, 2026 21:28
@markjhoy markjhoy requested a review from a team as a code owner March 8, 2026 21:28
@elasticsearchmachine elasticsearchmachine added the needs:triage Requires assignment of a team area label label Mar 8, 2026
@markjhoy markjhoy added the Team:Search Relevance Meta label for the Search Relevance team in Elasticsearch label Mar 8, 2026
@elasticsearchmachine elasticsearchmachine removed the Team:Search Relevance Meta label for the Search Relevance team in Elasticsearch label Mar 8, 2026
Copy link
Copy Markdown
Member

@carlosdelest carlosdelest left a comment

Choose a reason for hiding this comment

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

LGTM - please double check the applies_to versions, as they look wrong

Copy link
Copy Markdown
Member

@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.

Docs wise: one question and one ++ :)

- file: esql/commands/keep.md
- file: esql/commands/limit.md
- file: esql/commands/lookup-join.md
- file: esql/commands/mmr.md
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

FYI we shouldn't merge this until the command is live on serverless

If you want to merge in hidden mode, you can do the following, and publish at a later date

Suggested change
- file: esql/commands/mmr.md
- hidden: esql/commands/mmr.md

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

FYI this PR is now merged so the command should be available.

Copy link
Copy Markdown
Member

@ioanatia ioanatia left a comment

Choose a reason for hiding this comment

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

Before we merge this PR, we need to make sure that MMR is available outside of release builds - we need to regen the syntax:

| {this.isDevVersion()}? mmrCommand

and also make sure this capability is available in release builds:

also let's make sure we remove this capability before we make this available in release builds:

We only need MMR_V2 when we release.

@markjhoy
Copy link
Copy Markdown
Contributor Author

markjhoy commented Mar 9, 2026

Before we merge this PR, we need to make sure that MMR is available outside of release builds - we need to regen the syntax:

| {this.isDevVersion()}? mmrCommand

and also make sure this capability is available in release builds:

also let's make sure we remove this capability before we make this available in release builds:

We only need MMR_V2 when we release.

Thanks for calling this out - I'll open up a new PR today for this, then circle back to these docs

@markjhoy
Copy link
Copy Markdown
Contributor Author

markjhoy commented Mar 9, 2026

Before we merge this PR, we need to make sure that MMR is available outside of release builds - we need to regen the syntax:
We only need MMR_V2 when we release.

Thanks for calling this out - I'll open up a new PR today for this, then circle back to these docs

PR created to pull this out of dev/snapshot builds: #143867

@markjhoy markjhoy requested review from ioanatia and leemthompo March 10, 2026 17:14
@markjhoy
Copy link
Copy Markdown
Contributor Author

PR created to pull this out of dev/snapshot builds: #143867

FYI - this PR is merged now. cc: @ioanatia

@mayya-sharipova mayya-sharipova added :Search Relevance/ES|QL Search functionality in ES|QL and removed needs:triage Requires assignment of a team area label labels Mar 10, 2026
@elasticsearchmachine elasticsearchmachine added the Team:Search Relevance Meta label for the Search Relevance team in Elasticsearch label Mar 10, 2026
@elasticsearchmachine
Copy link
Copy Markdown
Collaborator

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

@markjhoy markjhoy requested a review from ioanatia March 24, 2026 12:43
@markjhoy
Copy link
Copy Markdown
Contributor Author

pinging @ioanatia for review

Copy link
Copy Markdown
Member

@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.

One last version tag and LGTM

@markjhoy markjhoy enabled auto-merge (squash) March 30, 2026 17:10
@markjhoy markjhoy merged commit e6c9c34 into elastic:main Mar 30, 2026
36 checks passed
mouhc1ne pushed a commit to shmuelhanoch/elasticsearch that referenced this pull request Mar 31, 2026
* add docs for MMR command

* remove 9.4 label for layout

* doc updates

* update docs; add command comments per Nik

* update regen docs

* doc cleanups
leemthompo added a commit that referenced this pull request Mar 31, 2026
leemthompo added a commit that referenced this pull request Mar 31, 2026
seanzatzdev pushed a commit to seanzatzdev/elasticsearch that referenced this pull request Mar 31, 2026
seanzatzdev pushed a commit to seanzatzdev/elasticsearch that referenced this pull request Mar 31, 2026
ncordon pushed a commit to ncordon/elasticsearch that referenced this pull request Apr 1, 2026
* add docs for MMR command

* remove 9.4 label for layout

* doc updates

* update docs; add command comments per Nik

* update regen docs

* doc cleanups
ncordon pushed a commit to ncordon/elasticsearch that referenced this pull request Apr 1, 2026
mromaios pushed a commit to mromaios/elasticsearch that referenced this pull request Apr 9, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

>docs General docs changes >non-issue :Search Relevance/ES|QL Search functionality in ES|QL Team:Search Relevance Meta label for the Search Relevance team in Elasticsearch v9.4.0

Projects

None yet

Development

Successfully merging this pull request may close these issues.

6 participants