Ver Fonte

[Docs] [8.19] Add docs for ES|QL autocomplete in Console (#132541)

* add docs to 8.19

* Attempting to fix CI error + update text

* attempt 2

* attempt 3
wajihaparvez há 2 meses atrás
pai
commit
fdd2c9ae1b

+ 1 - 2
docs/reference/esql/esql-kibana.asciidoc

@@ -57,8 +57,7 @@ in-product reference documentation for all commands and functions or to get
 recommended queries that will help you get started.
 
 // tag::autocomplete[]
-To make it easier to write queries, auto-complete offers suggestions with
-possible commands and functions:
+Discover suggests possible commands and functions to autocomplete your query:
 
 image::images/esql/esql-kibana-auto-complete.png[align="center"]
 // end::autocomplete[]

+ 9 - 5
docs/reference/esql/esql-rest.asciidoc

@@ -38,12 +38,12 @@ James S.A. Corey |Leviathan Wakes     |561            |2011-06-02T00:00:00.000Z
 
 [discrete]
 [[esql-kibana-console]]
-==== Kibana Console
+==== Run the {esql} query API in Console
 
-If you are using {kibana-ref}/console-kibana.html[Kibana Console] (which is
-highly recommended), take advantage of the triple quotes `"""` when creating the
-query. This not only automatically escapes double quotes (`"`) inside the query
-string but also supports multi-line requests:
+We recommend using {kibana-ref}/console-kibana.html[Console] to run the {esql} 
+query API. When creating the query, using triple quotes (`"""`) allows you to 
+use special characters like quotes (`"`) without having to escape them. They 
+also make it easier to write multi-line requests:
 
 // tag::esql-query-api[]
 [source,console]
@@ -60,6 +60,10 @@ POST /_query?format=txt
 ----
 // TEST[setup:library]
 
+Inside quotes, Console suggests possible commands and functions to autocomplete your query:
+
+image::images/esql/console-esql-autocomplete.png[align="center"]
+
 [discrete]
 [[esql-rest-format]]
 ==== Response formats

BIN
docs/reference/images/esql/console-esql-autocomplete.png


+ 6 - 1
docs/reference/tab-widgets/esql/esql-getting-started-discover-console.asciidoc

@@ -23,10 +23,15 @@ example:
 POST /_query?format=txt
 {
   "query": """
-FROM sample_data
+FROM kibana_sample_data_logs
   """
 }
 ----
+
+Inside quotes, Console suggests possible commands and functions to autocomplete your query:
+
+image::images/esql/console-esql-autocomplete.png[align="center"]
+
 // end::console[]