Add docs for courier:batchSearches UI setting #46053
Merged
Conversation
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
|
Pinging @elastic/kibana-docs |
lukasolson
added
the
release_note:skip
💔 Build Failed |
|
Retest (potentially flaky test) |
|
@elasticmachine merge upstream (ABC) |
💚 Build Succeeded |
|
@elasticmachine merge upstream |
|
@AlonaNadler @gchaps Could you provide some feedback about the wording here? Thanks! |
💚 Build Succeeded |
lukasolson
force-pushed
the
batchSearchesDocs
branch
from
167d0f9 to
9882d51
Compare
💚 Build Succeeded |
💚 Build Succeeded |
💚 Build Succeeded |
gchaps
reviewed
Sep 25, 2019
| `Determines whether to send multiple concurrent search requests (such as from a dashboard from multiple | ||
| panels) as a single _msearch request, or multiple _search requests. Note that cancellation of queries (for | ||
| example, when a user navigates away from the page before the search has returned) is only supported when | ||
| using the _search Elasticsearch endpoint.`, |
There was a problem hiding this comment.
I think this content reads better without the content in the parens. Can we shorten the text to:
Determines whether to send concurrent search requests as a single _msearch request, or as multiple _search requests. Only the Elasticsearch endpoint supports cancellation of queries.
| 'times, but it also means that no single search request will be returned until the last has completed.', | ||
| `When disabled, dashboard panels will load individually, and search requests will be terminated when users | ||
| navigate away or update the query. When enabled, dashboard panels will load altogether when all of the | ||
| data has been loaded.`, | ||
| }), |
There was a problem hiding this comment.
I like this description. When I looked at the UI, I noticed that the switch is on by default. So how about we describe the default behavior and then explain what happens when you disable:
What do you think?
💚 Build Succeeded |
lukasolson
added a commit
to lukasolson/kibana
that referenced
this pull request
Sep 26, 2019
* Add docs for courier:batchSearches UI setting * Update ui_setting_defaults.js * Update ui_setting_defaults.js * Update advanced-options.asciidoc * Update advanced-options.asciidoc * Update ui_setting_defaults.js * Update advanced-options.asciidoc * Update ui_setting_defaults.js
lukasolson
added a commit
to lukasolson/kibana
that referenced
this pull request
Sep 26, 2019
* Add docs for courier:batchSearches UI setting * Update ui_setting_defaults.js * Update ui_setting_defaults.js * Update advanced-options.asciidoc * Update advanced-options.asciidoc * Update ui_setting_defaults.js * Update advanced-options.asciidoc * Update ui_setting_defaults.js
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Resolves #46030.
This PR just adds more clear documentation surrounding the
courier:batchSearchesUI setting.