94cad286bc
In a few previous PR's we restructured the ES|QL docs to make it possible to generate them dynamically. This PR just moves a few files around to make the query languages docs easier to work with, and a little more organized like the ES|QL docs. A bit part of this was setting up redirects to the new locations, so other repo's could correctly link to the elasticsearch docs. |
||
|---|---|---|
| .. | ||
| _snippets | ||
| images | ||
| kibana | ||
| processing-commands | ||
| esql-commands.md | ||
| esql-enrich-data.md | ||
| esql-examples.md | ||
| esql-functions-operators.md | ||
| esql-implicit-casting.md | ||
| esql-lookup-join.md | ||
| esql-metadata-fields.md | ||
| esql-multivalued-fields.md | ||
| esql-process-data-with-dissect-grok.md | ||
| esql-syntax.md | ||
| esql-time-spans.md | ||
| limitations.md | ||
| README.md | ||
The ES|QL documentation is composed of static content and generated content.
The static content exists in this directory and can be edited by hand.
However, the sub-directories _snippets, images and kibana contain mostly
generated content.
_snippets
In _snippets there are files that can be included within other files
using the File Inclusion
feature of the Elastic Docs V3 system.
Most, but not all, files in this directory are generated.
In particular the directories _snippets/functions/* and _snippets/operators/*
contain subdirectories that are mostly generated:
description- description of each function scraped from@FunctionInfo#descriptionexamples- examples of each function scraped from@FunctionInfo#examplesparameters- description of each function's parameters scraped from@Paramsignature- railroad diagram of the syntax to invoke each functiontypes- a table of each combination of support type for each parameter. These are generated from tests.layout- a fully generated description for each function
Most functions can use the generated docs generated in the layout directory.
If we need something more custom for the function we can make a file in this
directory that can include:: any parts of the files above.
To regenerate the files for a function run its tests using gradle.
For example to generate docs for the CASE function:
./gradlew :x-pack:plugin:esql:test -Dtests.class='CaseTests'
To regenerate the files for all functions run all of ESQL's tests using gradle:
./gradlew :x-pack:plugin:esql:test
images
The images directory contains functions and operators sub-directories with
the *.svg files used to describe the syntax of each function or operator.
These are all generated by the same tests that generate the functions and operators docs above.
kibana
The kibana directory contains definition and docs sub-directories that are generated:
kibana/definition- function definitions for kibana's ESQL editorkibana/docs- the inline docs for kibana
These are also generated as part of the unit tests described above.