forked from elastic/kibana
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
[DOCS] Updates docs for Console (elastic#35505)
* update docs and screenshots * [DOCS] Updates Console text and images
- Loading branch information
Showing
17 changed files
with
104 additions
and
81 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,19 +1,20 @@ | ||
[[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: | ||
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*. | ||
|
||
.Auto Indent a request | ||
image::images/auto_format_before.png["Auto format before",width=500,align="center"] | ||
For example, you might have a request that is formatted like this: | ||
|
||
Console will adjust the JSON body of the request and it will now look like this: | ||
[role="screenshot"] | ||
image::dev-tools/console/images/copy-curl.png["Console close-up"] | ||
|
||
.A formatted request | ||
image::images/auto_format_after.png["Auto format after",width=500,align="center"] | ||
Console adjusts the JSON body of the request to apply the indents. | ||
|
||
If you select Auto Indent on a request that is already perfectly formatted, Console will collapse the | ||
request body to a single line per document. This is very handy when working with Elasticsearch's bulk APIs: | ||
[role="screenshot"] | ||
image::dev-tools/console/images/request.png["Console close-up"] | ||
|
||
.One doc per line | ||
image::images/auto_format_bulk.png["Auto format bulk",width=550,align="center"] | ||
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]. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,6 +1,26 @@ | ||
[[configuring-console]] | ||
=== Configuring Console | ||
|
||
You can add the following options in the `config/kibana.yml` file: | ||
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 don’t 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. | ||
|
||
|
||
|
||
`console.enabled`:: *Default: true* Set to false to disable Console. Toggling this will cause the server to regenerate assets on the next startup, which may cause a delay before pages start being served. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file was deleted.
Oops, something went wrong.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,21 +1,22 @@ | ||
[[keyboard-shortcuts]] | ||
=== Keyboard shortcuts | ||
|
||
Console comes with a set of nifty keyboard shortcuts making working with it even more efficient. Here is an overview: | ||
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 Auto complete (even if not typing). | ||
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 auto-complete is visible | ||
==== When autocomplete 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. | ||
Esc:: Close auto-complete menu. | ||
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. |
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.