mirror of
https://github.com/elastic/elasticsearch.git
synced 2025-06-29 01:44:36 -04:00
96227a1970
This takes a stab at generating the markdown files that Kibana uses for its inline help. It doesn't include all of the examples because the `@Example` annotation is not filled in - we're tracking that in https://github.com/elastic/elasticsearch/issues/104247#issuecomment-2018944371 There are some links in the output and they are in markdown syntax. We should figure out how to make them work for kibana.
23 lines
1.1 KiB
Markdown
23 lines
1.1 KiB
Markdown
The files in these subdirectories are generated by ESQL's test suite:
|
|
* `description` - description of each function scraped from `@FunctionInfo#description`
|
|
* `examples` - examples of each function scraped from `@FunctionInfo#examples`
|
|
* `parameters` - description of each function's parameters scraped from `@Param`
|
|
* `signature` - railroad diagram of the syntax to invoke each function
|
|
* `types` - a table of each combination of support type for each parameter. These are generated from tests.
|
|
* `layout` - a fully generated description for each function
|
|
* `kibana/definition` - function definitions for kibana's ESQL editor
|
|
* `kibana/docs` - the inline docs for kibana
|
|
|
|
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:
|
|
```
|
|
./gradlew :x-pack:plugin:esql:test -Dtests.class='*SinTests'
|
|
```
|
|
|
|
To regenerate the files for all functions run all of ESQL's tests using gradle:
|
|
```
|
|
./gradlew :x-pack:plugin:esql:test
|
|
```
|