[DOCS] Add Dev Tools to Kibana Guide (#12438)

This commit is contained in:
Lisa Cawley 2017-06-21 16:07:12 -07:00 committed by GitHub
parent 3269965dfb
commit c33aee3df8
9 changed files with 24 additions and 15 deletions

View file

@ -1,8 +1,6 @@
[[console-kibana]]
= Console
== Console
[partintro]
--
The Console plugin provides a UI to interact with the REST API of Elasticsearch. Console has two main areas: the *editor*,
where you compose requests to Elasticsearch, and the *response* pane, which displays the responses to the request.
Enter the address of your Elasticsearch server in the text box on the top of screen. The default value of this address
@ -61,11 +59,11 @@ image::images/introduction_output.png[Screenshot]
[float]
[[console-ui]]
== The Console UI
=== The Console UI
In this section you will find a more detailed description of UI of Console. The basic aspects of the UI are explained
in the <<console-kibana>> section.
--
include::console/multi-requests.asciidoc[]

View file

@ -1,5 +1,5 @@
[[auto-formatting]]
== Auto Formatting
=== Auto Formatting
Console allows you to auto format messy requests. To do so, position the cursor on the request you would like to format
and select Auto Indent from the action menu:

View file

@ -1,5 +1,5 @@
[[configuring-console]]
== Configuring Console
=== Configuring Console
You can add the following options in the `config/kibana.yml` file:

View file

@ -1,5 +1,5 @@
[[history]]
== History
=== History
Console maintains a list of the last 500 requests that were successfully executed by Elasticsearch. The history
is available by clicking the clock icon on the top right side of the window. The icons opens the history panel

View file

@ -1,10 +1,10 @@
[[keyboard-shortcuts]]
== Keyboard shortcuts
=== Keyboard shortcuts
Console comes with a set of nifty keyboard shortcuts making working with it even more efficient. Here is an overview:
[float]
=== General editing
==== General editing
Ctrl/Cmd + I:: Auto indent current request.
Ctrl + Space:: Open Auto complete (even if not typing).
@ -14,7 +14,7 @@ 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 auto-complete is visible
==== When auto-complete is visible
Down arrow:: Switch focus to auto-complete menu. Use arrows to further select a term.
Enter/Tab:: Select the currently selected or the top most term in auto-complete menu.

View file

@ -1,5 +1,5 @@
[[multi-requests]]
== Multiple Requests Support
=== Multiple Requests Support
The Console editor allows writing multiple requests below each other. As shown in the <<console-kibana>> section, you
can submit a request to Elasticsearch by positioning the cursor and using the <<action_menu,Action Menu>>. Similarly

View file

@ -1,5 +1,5 @@
[[console-settings]]
== Settings
=== Settings
Console has multiple settings you can set. All of them are available in the Settings panel. To open the panel
click on the cog icon on the top right.

View file

@ -0,0 +1,11 @@
[[devtools-kibana]]
= Dev Tools
[partintro]
--
The *Dev Tools* page contains development tools that you can use to interact
with your data in Kibana.
--
include::console.asciidoc[]

View file

@ -35,7 +35,7 @@ include::dashboard.asciidoc[]
include::timelion.asciidoc[]
include::console.asciidoc[]
include::index-shared3.asciidoc[]
include::management.asciidoc[]
@ -45,4 +45,4 @@ include::development.asciidoc[]
include::limitations.asciidoc[]
include::release-notes.asciidoc[]
include::release-notes.asciidoc[]