-
Notifications
You must be signed in to change notification settings - Fork 25.6k
ESQL - generate docs for snapshot functions #113080
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
ESQL - generate docs for snapshot functions #113080
Conversation
Documentation preview: |
Pinging @elastic/es-analytical-engine (Team:Analytics) |
cc @jan-elastic since the there is also the |
Rate still has no |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM, thank you @carlosdelest !
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
For this to work and be in the docs, it also has to be linked in one of the root asciidocs.
In this case, it would be this one: https://github.com/elastic/elasticsearch/blob/a21242054b87e456f6e301dfa017e612b83ebbd6/docs/reference/esql/functions/grouping-functions.asciidoc
That said, do we want to include snapshot-only functions in the global docs?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Making the files without plugging them in shouldn't hurt anything if that's what we want to do. I think we're ok doing that. I am. We should just make sure folks know having the generated asciidoc doesn't mean it's there - you have to look for the inclusion. For qstr I believe the plan is to include it only in snapshot docs. INLINESTATS works that way:
ifeval::["{release-state}"=="unreleased"]
* experimental:[] <<esql-inlinestats-by>>
endif::[]
...
ifeval::["{release-state}"=="unreleased"]
include::processing-commands/inlinestats.asciidoc[]
endif::[]
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Making the files without plugging them in shouldn't hurt anything
Indeed, but I feel like adding those without actually including them leaves things half-done. And it's harder later to know which ones are missing.
Btw, didn't know we had those conditionals! I'd include it with them, and that's all. About making sure it's done, it feels a bit more complex, and I can't think of a good way that doesn't pass through autogenerating those files too 👀 (Which feels like the eventual solution...)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
That is correct - for now, we're not including the docs as these functions are not production ready yet.
Including functions docs should be ok if they are not linked to the global docs - they can exist but not be connected until we do so for production readiness.
After conversations in this PR, we'll be adding docs generation to functions available on snapshot builds.
This PR adds that capability, and includes the generated docs for the
Categorize
function