Update the guide to add a new ESQL function #134081
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Contributor
mouhc1ne
commented
Sep 3, 2025
mouhc1ne
commented
- Update the list of doc files that get generated upon successful unit test run of the new ESQL function
- Update the command to generate full docs locally, and reflect the fact it doesn't need Docker anymore
- Mention the need to update the expected ESQL functions count in 60_usage.yml
- Other minor changes
There was a problem hiding this comment.
Pull Request Overview
This PR updates the developer guide for adding new ESQL functions with current tooling and process improvements. The changes modernize the documentation workflow and clarify various aspects of function development.
Key changes:
- Updated documentation generation process to use the new docs-builder tool instead of Docker-based approach
- Added guidance for snapshot functions and testing considerations
- Enhanced the list of generated documentation files to be more comprehensive
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
mouhc1ne
added
>docs
nik9000
approved these changes
Sep 4, 2025
- Update the list of doc files that get generated upon successful unit test run of the new ESQL function - Update the command to generate full docs locally, and reflect the fact it doesn't need Docker anymore - Mention the need to update the expected ESQL functions count in 60_usage.yml - Other minor changes
|
Pinging @elastic/es-analytical-engine (Team:Analytics) |
|
Pinging @elastic/core-docs (Team:Docs) |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.