ES|QL sample documentation #129350
ES|QL sample documentation #129350
Conversation
jan-elastic
added
>non-issue
:ml
|
Pinging @elastic/ml-core (Team:ML) |
jan-elastic
force-pushed
the
esql-sample-docs
branch
3 times, most recently
from
0edaacb to
83899fd
Compare
jan-elastic
force-pushed
the
esql-sample-docs
branch
from
83899fd to
1c813a0
Compare
docs/reference/query-languages/esql/_snippets/commands/layout/sample.md
Outdated
Show resolved
Hide resolved
…sample.md Co-authored-by: Liam Thompson <[email protected]>
| // Hardcode the sample values to work around the limitations of the CSV tests in the | ||
| // presence of randomness, and be able to specify an expected result for the docs. | ||
| | STATS emp_no = COUNT() | ||
| | EVAL emp_no = [10018, 10024, 10062, 10081] | ||
| | MV_EXPAND emp_no |
There was a problem hiding this comment.
Haha, this is beautiful. But I like that we're making sure the syntax is valid, even though the output is not related to the query that's in the docs!
There was a problem hiding this comment.
Yeah, I know. Within the system's current limitations, I don't see anything better than this...
| ## `SAMPLE` [esql-sample] | ||
|
|
||
| ```yaml {applies_to} | ||
| stack: preview 9.1 |
There was a problem hiding this comment.
@alex-spies this is the correct way of marking versioning/lifecycle (preview/beta/GA) in the new docs
We haven't consolidated all the existing pages yet, (see #128576) but we should start using this on a go-forward basis
The docs build will render the preview pill and there will be more explicit tooltips soon too :)
There was a problem hiding this comment.
It's much nicer because we're using structured metadata that doesn't require as much manual maintenance, because the docs build handles the output
Say this goes GA in 9.3, all we have to do is append a comma-separated version and the docs will be up-to-date and version-aware on the page without having to switch versions using different URLs:
eg
stack: preview 9.1, ga 9.3
There was a problem hiding this comment.
Oh, this is great. Thanks for the explanation!
No description provided.