Add docs for courier:batchSearches UI setting (elastic#46053)

* 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 · Sep 26, 2019 · d85b30a · d85b30a
1 parent 2e2e1ea
commit d85b30a
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 2 deletions.
diff --git a/docs/management/advanced-options.asciidoc b/docs/management/advanced-options.asciidoc
@@ -185,6 +185,9 @@ Refresh the page to apply the changes.
 === Search settings
 
 [horizontal]
+`courier:batchSearches`:: When disabled, dashboard panels will load individually, and search requests will terminate when
+users navigate away or update the query. When enabled, dashboard panels will load together when all of the data is loaded,
+and searches will not terminate.
 `courier:customRequestPreference`:: {ref}/search-request-body.html#request-body-search-preference[Request preference] 
 to use when `courier:setRequestPreference` is set to "custom".
 `courier:ignoreFilterIfFieldNotInIndex`:: Skips filters that apply to fields that don't exist in the index for a visualization. 

diff --git a/src/legacy/core_plugins/kibana/ui_setting_defaults.js b/src/legacy/core_plugins/kibana/ui_setting_defaults.js
@@ -426,8 +426,9 @@ export function getUiSettingDefaults() {
       type: 'boolean',
       description: i18n.translate('kbn.advancedSettings.courier.batchSearchesText', {
         defaultMessage:
-          'Batch multiple concurrent searches in a single request. This may improve overall load' +
-          '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 terminate when users navigate
+           away or update the query. When enabled, dashboard panels will load together when all of the data is loaded, and
+           searches will not terminate.`,
       }),
       category: ['search'],
     },