Skip to content

[AI Infra] Update scripts that generates ES|QL documentation for AI Assistants#247656

Closed
qn895 wants to merge 14 commits intoelastic:mainfrom
qn895:update-scripts-esql
Closed

[AI Infra] Update scripts that generates ES|QL documentation for AI Assistants#247656
qn895 wants to merge 14 commits intoelastic:mainfrom
qn895:update-scripts-esql

Conversation

@qn895
Copy link
Copy Markdown
Member

@qn895 qn895 commented Dec 30, 2025

Summary

Addresses #244745. This PR updates the scripts to grab ES|QL documentation directly from the compiled markdown zipped files from Elastic's documentation. The changed files produced as a result of this script change is in a separate PR.

There are 2 steps:

  1. Grab ES|QL related docs from llm.zip file, do some extra processing to remove redundant metadata. This will yield a deterministic file based on the Elastic's documentation.
  2. If connectorId is provided, use it to connect to Inference plugin in order to enrich the markdown file with description for ES|QL examples.

Checklist

Check the PR satisfies following conditions.

Reviewers should verify this PR satisfies this list as well.

  • Any text added follows EUI's writing guidelines, uses sentence case text and includes i18n support
  • Documentation was added for features that require explanation or tutorials
  • Unit or functional tests were updated or added to match the most common scenarios
  • If a plugin configuration key changed, check if it needs to be allowlisted in the cloud and added to the docker list
  • This was checked for breaking HTTP API changes, and any breaking changes have been approved by the breaking-change committee. The release_note:breaking label should be applied in these situations.
  • Flaky Test Runner was used on any tests changed
  • The PR description includes the appropriate Release Notes section, and the correct release_note:* label is applied per the guidelines
  • Review the backport guidelines and apply applicable backport:* labels.

Identify risks

Does this PR introduce any risks? For example, consider risks like hard to test bugs, performance regression, potential of data loss.

Describe the risk, its severity, and mitigation for each identified risk. Invite stakeholders and evaluate how to proceed before merging.

@qn895 qn895 added :ml Team:ML Team label for ML (also use :ml) t// Team:AI Infra Platform AppEx AI Infrastructure Team t// Feature: AI Infra Relating to the AI Assistant flow and any work impacting/involving the AI/Inference Connector labels Jan 5, 2026
@qn895 qn895 self-assigned this Jan 5, 2026
@qn895 qn895 force-pushed the update-scripts-esql branch from 5122c5b to f45940f Compare January 14, 2026 19:10
@qn895 qn895 changed the title [AI Infra] Update script that generates ES|QL documentation for AI Assistants [AI Infra] Update scripts that generates ES|QL documentation for AI Assistants Jan 14, 2026
@qn895
Copy link
Copy Markdown
Member Author

qn895 commented Jan 20, 2026

@elasticmachine merge upstream

@qn895 qn895 marked this pull request as ready for review January 21, 2026 19:09
@qn895 qn895 requested a review from a team as a code owner January 21, 2026 19:09
@elasticmachine
Copy link
Copy Markdown
Contributor

Pinging @elastic/ml-ui (:ml)

@elasticmachine
Copy link
Copy Markdown
Contributor

Pinging @elastic/appex-ai-infra (Team:AI Infra)

@qn895 qn895 added release_note:skip Skip the PR/issue when compiling release notes backport:version Backport to applied version labels v9.4.0 labels Jan 21, 2026
@github-actions
Copy link
Copy Markdown
Contributor

🔍 Preview links for changed docs

@qn895 qn895 force-pushed the update-scripts-esql branch from 7da6511 to 05dcc6f Compare January 22, 2026 17:07
@qn895
Copy link
Copy Markdown
Member Author

qn895 commented Jan 22, 2026

Closing due to bad rebase

@qn895 qn895 closed this Jan 22, 2026
@elasticmachine
Copy link
Copy Markdown
Contributor

elasticmachine commented Jan 22, 2026

💔 Build Failed

Failed CI Steps

History

cc @qn895

@qn895 qn895 removed request for a team January 22, 2026 22:04
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

backport:version Backport to applied version labels Feature: AI Infra Relating to the AI Assistant flow and any work impacting/involving the AI/Inference Connector :ml release_note:skip Skip the PR/issue when compiling release notes Team:AI Infra Platform AppEx AI Infrastructure Team t// Team:ML Team label for ML (also use :ml) t// v9.4.0

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants