Commit graph

13 commits

Author SHA1 Message Date
Craig Taverner
258e31cd70
Support depthOffset in MD docs headings for nesting functions (#126984) (#127092)
While this change appears subtle at this point, I am using this in a later PR that adds a lot more spatial functions, where nesting them in related groups like this looks much better.

The main impact of this is that the On this page navigator on the right panel of the docs will show the nesting

Co-authored-by: Liam Thompson <32779855+leemthompo@users.noreply.github.com>
2025-04-19 20:33:57 +10:00
Craig Taverner
942640eb8a
[9.0] Split ES|QL functions/operators/commands into separate pages for similar functions and make commands examples generated (#126279) (#126624)
* Split ES|QL functions/operators/commands into separate pages for similar functions and make commands examples generated (#126279)

While the internal structure of the docs is already split into many (over 1000) sub-pages, the final display for the `Functions and Operators` page is a single giant page, making navigation harder. This PR splits it into separate pages, one for each group of similar functions and one for the operators. Twelve new pages.

This PR also bundles a few other related changes. In total what is done is:
* Split functions/operators into 12 pages, one for each group, maintaining the existing split of each function/operator into a snippet with dynamically generated examples
* Split esql-commands.md into source-commands.md and processing-commands.md, each of which is split into individual snippets, one for each command
* Each command snippet has it's examples split out into separate files, if they were examples that were dynamically generated in the older asciidoc system
* The examples files are overwritten by the ES|QL unit tests, using a similar mechanism to the examples written for functions and operators)
* Some additional refinements to the Kibana definition and markdown files (nicer operator headings, and display text)

* After re-running tests to ensure we get 9.0 behaviour only
2025-04-11 03:20:07 +10:00
Nik Everett
00ffed0e49
ESQL: Hide some "extras" from docs (#124763) (#126122)
Hides some of the "extra" lines from ESQL's documentation. These lines
are required to make the documentation into nice tests which is
important to make sure the docs don't get out of date. But readers don't
need to see them.
2025-04-03 00:54:48 +11:00
Craig Taverner
d9fdcf7a56
Refine ESQL docs handling of applies_to (#125835) (#125923)
This primarily splits the old preview:true warning from the newer applies_to approach. Since all of our current applies_to examples are actually just behaviour modifications of current functions, we do not use the official docs {applies_to} syntax. However there is code to make use of that in the case where we have an entirely new function which will appear in a new version.

Co-authored-by: Alexander Spies <alexander.spies@elastic.co>
2025-03-31 21:30:45 +11:00
Craig Taverner
0722687e9a
9.0 esql docs backport (#125833)
Manual backport of two PRs: * #125155 * #125251 

Even though the docs are not needed in 9.0, due to all docs being
published off main, doing the backport makes future backports of
non-docs, but docs-adjacent PRs easier.
2025-03-28 21:22:05 +11:00
Alexander Spies
46c90388c6
ESQL: Sync esql docs entirely to main (#125691)
This entirely syncs the contents of docs/reference/query-languages/esql with main, just so we can continue auto-backporting easily, which will continue to be relevant.
2025-03-26 18:41:28 +01:00
Carlos Delgado
b08a6c035d
ES|QL: Add default values for match function options (#125282) (#125371) 2025-03-21 21:57:29 +11:00
Liam Thompson
d90c6b76a2
[9.0] [docs] Prepare for docs-assembler (#125118) (#125339)
* [docs] Prepare for docs-assembler (#125118)

* reorg files for docs-assembler and create toc.yml files

* fix build error, add redirects

* only toc

* move images

(cherry picked from commit 9bcd59596d)

# Conflicts:
#	docs/reference/aggregations/search-aggregations-pipeline-bucket-script-aggregation.md
#	docs/reference/aggregations/search-aggregations-pipeline-cumulative-cardinality-aggregation.md
#	docs/reference/aggregations/search-aggregations-pipeline-cumulative-sum-aggregation.md
#	docs/reference/aggregations/search-aggregations-pipeline-derivative-aggregation.md
#	docs/reference/aggregations/search-aggregations-pipeline-extended-stats-bucket-aggregation.md
#	docs/reference/aggregations/search-aggregations-pipeline-max-bucket-aggregation.md
#	docs/reference/aggregations/search-aggregations-pipeline-min-bucket-aggregation.md
#	docs/reference/aggregations/search-aggregations-pipeline-percentiles-bucket-aggregation.md
#	docs/reference/aggregations/search-aggregations-pipeline-stats-bucket-aggregation.md
#	docs/reference/aggregations/search-aggregations-pipeline-sum-bucket-aggregation.md
#	docs/reference/query-languages/esql/esql-commands.md
#	docs/reference/query-languages/esql/esql-lookup-join.md
#	docs/reference/query-languages/esql/esql-process-data-with-dissect-grok.md
#	docs/reference/query-languages/images/esql-lookup-join.png
#	docs/reference/query-languages/toc.yml
#	docs/reference/search-connectors/es-connectors-run-from-docker.md
#	docs/reference/text-analysis/analysis-apostrophe-tokenfilter.md
#	docs/reference/toc.yml

* remove markers

---------

Co-authored-by: Colleen McGinnis <colleen.mcginnis@elastic.co>
2025-03-20 22:20:12 +02:00
Liam Thompson
c36b4db253
[DOCS] fix external links (#124248) (#125340)
(cherry picked from commit 23be51a04f)

# Conflicts:
#	docs/reference/data-analysis/text-analysis/analysis-simplepattern-tokenizer.md
#	docs/reference/data-analysis/text-analysis/analysis-simplepatternsplit-tokenizer.md
#	docs/reference/query-languages/esql/_snippets/date-time-functions-orig.md
#	docs/reference/query-languages/esql/_snippets/functions/ceil.md
#	docs/reference/query-languages/esql/_snippets/functions/date_parse.md
#	docs/reference/query-languages/esql/_snippets/functions/description/floor.md
#	docs/reference/query-languages/esql/_snippets/functions/floor.md
#	docs/reference/query-languages/esql/_snippets/math-functions-orig.md
#	docs/reference/query-languages/query-dsl/query-dsl-geo-polygon-query.md

Co-authored-by: Colleen McGinnis <colleen.mcginnis@elastic.co>
2025-03-20 15:32:08 -04:00
Craig Taverner
a8b2428dd1
9.0 backport docs query languages (#125113)
* Restructure query-languages docs files for clarity (#124797)

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.

* After running tests, we revert a few features

* Fix build.gradle and improved some generating code

* After running tests

* Update x-pack/plugin/esql/build.gradle
2025-03-19 04:24:11 +11:00
Craig Taverner
d3d9a00fb1
[9.0] ESQL autogenerate docs v3 (#124312) (#124786)
Manual backport of https://github.com/elastic/elasticsearch/pull/124312
and https://github.com/elastic/elasticsearch/pull/124742
2025-03-14 06:33:18 +11:00
Liam Thompson
8275ac8d1f
Split ESQL functions/operators docs files (#123904) (#124214)
* Port from asciidocalypse

* Fix links for operator lists

* Remove unused image files after moving/editing them

* Fix lists links

* Fix like/rlike links

* Fix remaining bad references to /elasticsearch/docs

* Fix logstash and beats references

* Fix logstash and beats references

* Fix image links

(cherry picked from commit efe7379e67)

Co-authored-by: Craig Taverner <craig@amanzi.com>
2025-03-06 16:58:30 +01:00
Liam Thompson
b98606e712
[9.0] [docs] Migrate docs from AsciiDoc to Markdown (#123507) (#124124)
* [docs] Migrate docs from AsciiDoc to Markdown (#123507)

* delete asciidoc files

* add migrated files

* fix errors

* Disable docs tests

* Clarify release notes page titles

* Revert "Clarify release notes page titles"

This reverts commit 8be688648d.

* Comment out edternal URI images

* Clean up query languages landing pages, link to conceptual docs

* Add .md to url

* Fixes inference processor nesting.

---------

Co-authored-by: Liam Thompson <32779855+leemthompo@users.noreply.github.com>
Co-authored-by: Liam Thompson <leemthompo@gmail.com>
Co-authored-by: Martijn Laarman <Mpdreamz@gmail.com>
Co-authored-by: István Zoltán Szabó <szabosteve@gmail.com>
(cherry picked from commit b7e3a1e14b)

# Conflicts:
#	docs/build.gradle
#	docs/reference/migration/index.asciidoc
#	docs/reference/migration/migrate_9_0.asciidoc
#	docs/reference/release-notes.asciidoc
#	docs/reference/release-notes/9.0.0.asciidoc
#	docs/reference/release-notes/highlights.asciidoc

* Fix build file

* Really fix build file

---------

Co-authored-by: Colleen McGinnis <colleen.j.mcginnis@gmail.com>
2025-03-06 07:53:46 +01:00