[DOCS] Updates Console doc (#41371) (#41813)

* [DOCS] Updates Console doc

* [DOCS] Incorporates comments on Console docs

* [DOCS] Updated Console images
This commit is contained in:
gchaps 2019-07-23 11:27:57 -07:00 committed by GitHub
parent f6e716721d
commit 53ed5186f2
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
6 changed files with 69 additions and 98 deletions

View file

@ -1,20 +0,0 @@
[[auto-formatting]]
=== Auto formatting
Console can help you format requests. Select one or more requests that you
want to format, click the action icon (image:dev-tools/console/images/wrench.png[]),
and select *Auto indent*.
For example, you might have a request that is formatted like this:
[role="screenshot"]
image::dev-tools/console/images/copy-curl.png["Console close-up"]
Console adjusts the JSON body of the request to apply the indents.
[role="screenshot"]
image::dev-tools/console/images/request.png["Console close-up"]
If you select *Auto indent* on a request that is already well formatted,
Console collapses the request body to a single line per document.
This is helpful when working with {es}'s {ref}/docs-bulk.html[bulk APIs].

View file

@ -1,26 +0,0 @@
[[configuring-console]]
=== Configuring Console
You can configure Console to your preferences.
[float]
==== Configuring settings
*Settings* allows you to modify the font size and set the fileds for
autocomplete.
[role="screenshot"]
image::dev-tools/console/images/console-settings.png["Console settings"]
[float]
[[console-settings]]
==== Disabling Console
If you dont want to use Console, you can disable it by setting `console.enabled`
to false in your `kibana.yml` configuration file. Changing this setting
causes the server to regenerate assets on the next startup,
which might cause a delay before pages start being served.

View file

@ -1,22 +1,20 @@
[[console-kibana]]
== Console
Console enables you to interact with the REST API of {es}. *Note:* You cannot
interact with {kib} API endpoints via Console.
Console enables you to interact with the REST API of {es}. You can:
Go to *Dev Tools > Console* to get started.
* Send requests to {es} and view the responses
* View API documentation
* Get your request history
Console has two main areas:
* The *editor*, where you compose requests to send to {es}.
* The *response* pane, which displays the responses to the request.
To get started, go to *Dev Tools > Console*.
[role="screenshot"]
image::dev-tools/console/images/console.png["Console"]
[float]
[[console-api]]
=== Writing requests
=== Write requests
Console understands commands in a cURL-like syntax.
For example, the following is a `GET` request to the {es} `_search` API.
@ -47,51 +45,92 @@ If you paste the above command into Console, {kib} automatically converts it
to Console syntax. Alternatively, if you want to want to see Console syntax in cURL,
click the action icon (image:dev-tools/console/images/wrench.png[]) and select *Copy as cURL*.
For help with formatting requests, you can use Console's <<auto-formatting, auto formatting>>
feature.
[float]
[[console-autocomplete]]
==== Autocomplete
When you're typing a command, Console makes context-sensitive suggestions.
These suggestions show you the parameters for each API and speed up your typing.
To configure your preferences for autocomplete, go to
<<configuring-console, Settings>>.
[float]
[[auto-formatting]]
==== Auto-formatting
The auto-formatting
capability can help you format requests. Select one or more requests that you
want to format, click the action icon (image:dev-tools/console/images/wrench.png[]),
and then select *Auto indent*.
For example, you might have a request formatted like this:
[role="screenshot"]
image::dev-tools/console/images/copy-curl.png["Console close-up"]
Console adjusts the JSON body of the request to apply the indents.
[role="screenshot"]
image::dev-tools/console/images/request.png["Console close-up"]
If you select *Auto indent* on a request that is already well formatted,
Console collapses the request body to a single line per document.
This is helpful when working with the {es} {ref}/docs-bulk.html[bulk APIs].
[float]
[[console-request]]
=== Submitting requests
=== Submit requests
Once you enter a command in the editor, click the
green triangle to submit the request to {es}.
When you're ready to submit the request to {es}, click the
green triangle.
You can select multiple requests and submit them together.
Console sends the requests to {es} one by one and shows the output
in the response pane. Submitting multiple request is helpful when you're debugging an issue or trying query
combinations in multiple scenarios.
[float]
[[console-autocomplete]]
=== Using autocomplete
When typing a command, Console makes context-sensitive suggestions.
These suggestions can help you explore parameters for each API and speed up typing.
To configure your preferences for autocomplete, go to
<<configuring-console, Settings>>.
[float]
[[console-view-api]]
=== Viewing API docs
=== View API docs
You can view the documentation for an API endpoint by clicking
the action icon (image:dev-tools/console/images/wrench.png[]) and selecting
To view the documentation for an API endpoint, click
the action icon (image:dev-tools/console/images/wrench.png[]) and select
*Open documentation*.
[float]
[[console-history]]
=== Getting your request history
=== Get your request history
Console maintains a list of the last 500 requests that {es} successfully executed.
To view your most recent requests, click *History*. If you select a request
and click *Apply*, {kib} adds it to the editor at the current cursor position.
[float]
[[configuring-console]]
=== Configure Console settings
You can configure the Console font size, JSON syntax,
and autocomplete suggestions in *Settings*.
[role="screenshot"]
image::dev-tools/console/images/console-settings.png["Console Settings"]
[float]
[[keyboard-shortcuts]]
=== Get keyboard shortcuts
For a list of available keyboard
shortcuts, click *Help*.
[float]
[[console-settings]]
=== Disable Console
If you dont want to use Console, you can disable it by setting `console.enabled`
to `false` in your `kibana.yml` configuration file. Changing this setting
causes the server to regenerate assets on the next startup,
which might cause a delay before pages start being served.
include::auto-formatting.asciidoc[]
include::keyboard-shortcuts.asciidoc[]
include::configuring-console.asciidoc[]

Binary file not shown.

Before

Width:  |  Height:  |  Size: 116 KiB

After

Width:  |  Height:  |  Size: 129 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 200 KiB

After

Width:  |  Height:  |  Size: 175 KiB

View file

@ -1,22 +0,0 @@
[[keyboard-shortcuts]]
=== Keyboard shortcuts
The keyboard shortcuts below can help you move quickly through Console. You can
also view these shortcuts by clicking *Help* in Console.
[float]
==== General editing
Ctrl/Cmd + I:: Auto indent current request.
Ctrl + Space:: Open Autocomplete (even if not typing).
Ctrl/Cmd + Enter:: Submit request.
Ctrl/Cmd + Up/Down:: Jump to the previous/next request start or end.
Ctrl/Cmd + Alt + L:: Collapse/expand current scope.
Ctrl/Cmd + Option + 0:: Collapse all scopes but the current one. Expand by adding a shift.
[float]
==== When autocomplete is visible
Down arrow:: Switch focus to autocomplete menu. Use arrows to further select a term.
Enter/Tab:: Select the currently selected or the top most term in autocomplete menu.
Esc:: Close autocomplete menu.