From e6195ebe6fa3ab7db51051151aa613165ddbe4ac Mon Sep 17 00:00:00 2001 From: KOTungseth Date: Mon, 5 Oct 2020 16:37:53 -0500 Subject: [PATCH 1/4] [DOCS] Reallocates limitations to point-of-use --- docs/discover/kuery.asciidoc | 3 +++ docs/limitations.asciidoc | 20 -------------------- docs/management/watcher-ui/index.asciidoc | 2 ++ docs/user/ml/index.asciidoc | 2 ++ docs/user/reporting/index.asciidoc | 2 ++ docs/user/security/index.asciidoc | 2 ++ 6 files changed, 11 insertions(+), 20 deletions(-) diff --git a/docs/discover/kuery.asciidoc b/docs/discover/kuery.asciidoc index f306f2b8f763f..1c8543058378f 100644 --- a/docs/discover/kuery.asciidoc +++ b/docs/discover/kuery.asciidoc @@ -278,3 +278,6 @@ To match on a single nested document: ------------------- level1.level2:{ prop1:foo and prop2:bar } ------------------- + +IMPORTANT: {kib} is unable to perform aggregations across fields that contain nested objects, and is unable to search on nested objects when Lucene Query Syntax is used in +the query bar. Using `include_in_parent` or `copy_to` as a workaround is unsupported and can stop functioning in future releases. diff --git a/docs/limitations.asciidoc b/docs/limitations.asciidoc index 30a716641cc5d..97d3bd9d4f73c 100644 --- a/docs/limitations.asciidoc +++ b/docs/limitations.asciidoc @@ -4,12 +4,6 @@ Following are the known limitations in {kib}. -[float] -=== Exporting data - -Exporting a data table or saved search from a dashboard or visualization report -has known limitations. The PDF report only includes the data visible on the screen. - [float] === Nested objects @@ -22,17 +16,3 @@ the query bar. Using `include_in_parent` or `copy_to` as a workaround is not supported and may stop functioning in future releases. ============================================== -[float] -=== Graph - -Graph has limited support for multiple indices. -Go to <> for details. - -[float] -=== Other limitations - -These {stack} features have limitations that affect {kib}: - -* {ref}/watcher-limitations.html[Alerting] -* {ml-docs}/ml-limitations.html[Machine learning] -* {ref}/security-limitations.html[Security] diff --git a/docs/management/watcher-ui/index.asciidoc b/docs/management/watcher-ui/index.asciidoc index 23a0acbff5718..dae7010cdc0db 100644 --- a/docs/management/watcher-ui/index.asciidoc +++ b/docs/management/watcher-ui/index.asciidoc @@ -27,6 +27,8 @@ threshold watch, take a look at the different watcher actions. If you are creating an advanced watch, you should be familiar with the parts of a watch—input, schedule, condition, and actions. +NOTE: There are limitations in watcher that affect {kib}. For information, refer to {ref}/watcher-limitations.html[Alerting]. + [float] [[watcher-security]] === Watcher security diff --git a/docs/user/ml/index.asciidoc b/docs/user/ml/index.asciidoc index 8255585aae411..fa15e0652e2ab 100644 --- a/docs/user/ml/index.asciidoc +++ b/docs/user/ml/index.asciidoc @@ -26,6 +26,8 @@ If {stack-security-features} are enabled, users must have the necessary privileges to use {ml-features}. Refer to {ml-docs}/setup.html#setup-privileges[Set up {ml-features}]. +NOTE: There are limitations in {ml-features} that affect {kib}. For more information, refer to {ml-docs}/ml-limitations.html[Machine learning]. + -- [[xpack-ml-anomalies]] diff --git a/docs/user/reporting/index.asciidoc b/docs/user/reporting/index.asciidoc index 50ae92382fb24..c3f08fba26bf8 100644 --- a/docs/user/reporting/index.asciidoc +++ b/docs/user/reporting/index.asciidoc @@ -13,6 +13,8 @@ a PDF, PNG, or CSV document, which you can keep for yourself, or share with othe Reporting is available from the *Share* menu in *Discover*, *Dashboard*, and *Canvas*. +NOTE: When you export a data table or saved search from a dashboard report, the PDF includes only the visible data. + [role="screenshot"] image::user/reporting/images/share-button.png["Share"] diff --git a/docs/user/security/index.asciidoc b/docs/user/security/index.asciidoc index e1a46a415fe68..e6a7cc695ba23 100644 --- a/docs/user/security/index.asciidoc +++ b/docs/user/security/index.asciidoc @@ -10,6 +10,8 @@ auditing. For more information, see {ref}/secure-cluster.html[Secure a cluster] and <>. +NOTE: There are security limitations that affect {kib}. For more information, refer to {ref}/security-limitations.html[Security]. + [float] === Users From 18d9c8ffb4f7b9b159242e37ac82c405a10381c3 Mon Sep 17 00:00:00 2001 From: KOTungseth Date: Tue, 17 Nov 2020 11:24:04 -0600 Subject: [PATCH 2/4] KQL changes --- docs/discover/kuery.asciidoc | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/discover/kuery.asciidoc b/docs/discover/kuery.asciidoc index 1c8543058378f..78e7ea27f89a5 100644 --- a/docs/discover/kuery.asciidoc +++ b/docs/discover/kuery.asciidoc @@ -279,5 +279,5 @@ To match on a single nested document: level1.level2:{ prop1:foo and prop2:bar } ------------------- -IMPORTANT: {kib} is unable to perform aggregations across fields that contain nested objects, and is unable to search on nested objects when Lucene Query Syntax is used in -the query bar. Using `include_in_parent` or `copy_to` as a workaround is unsupported and can stop functioning in future releases. +IMPORTANT: When you use the Lucene Query Syntax in the *KQL* search bar, {kib} is unable to search on nested objects, and perform aggregations across fields that contain nested objects. +Using `include_in_parent` or `copy_to` can cause {kib} to fail. From d87e607e2c1588e68afb3d2053e7f1edd8fd0508 Mon Sep 17 00:00:00 2001 From: KOTungseth Date: Tue, 17 Nov 2020 11:28:31 -0600 Subject: [PATCH 3/4] Removed limitations file --- docs/index.asciidoc | 2 -- 1 file changed, 2 deletions(-) diff --git a/docs/index.asciidoc b/docs/index.asciidoc index 66ad2f7ec306a..eb6f794434f8a 100644 --- a/docs/index.asciidoc +++ b/docs/index.asciidoc @@ -20,8 +20,6 @@ include::user/index.asciidoc[] include::accessibility.asciidoc[] -include::limitations.asciidoc[] - include::migration.asciidoc[] include::CHANGELOG.asciidoc[] From d82b7ee4a3b2ce1eb811ae33c67062e6b7cda645 Mon Sep 17 00:00:00 2001 From: KOTungseth Date: Thu, 19 Nov 2020 10:09:57 -0600 Subject: [PATCH 4/4] Review comments --- docs/discover/kuery.asciidoc | 3 --- docs/discover/search.asciidoc | 3 +++ docs/management/watcher-ui/index.asciidoc | 2 +- docs/user/reporting/index.asciidoc | 4 ++-- 4 files changed, 6 insertions(+), 6 deletions(-) diff --git a/docs/discover/kuery.asciidoc b/docs/discover/kuery.asciidoc index 78e7ea27f89a5..f306f2b8f763f 100644 --- a/docs/discover/kuery.asciidoc +++ b/docs/discover/kuery.asciidoc @@ -278,6 +278,3 @@ To match on a single nested document: ------------------- level1.level2:{ prop1:foo and prop2:bar } ------------------- - -IMPORTANT: When you use the Lucene Query Syntax in the *KQL* search bar, {kib} is unable to search on nested objects, and perform aggregations across fields that contain nested objects. -Using `include_in_parent` or `copy_to` can cause {kib} to fail. diff --git a/docs/discover/search.asciidoc b/docs/discover/search.asciidoc index ee1e1526f9d6f..02f8a5245792a 100644 --- a/docs/discover/search.asciidoc +++ b/docs/discover/search.asciidoc @@ -74,6 +74,9 @@ status codes, you could enter `status:[400 TO 499]`. codes and have an extension of `php` or `html`, you could enter `status:[400 TO 499] AND (extension:php OR extension:html)`. +IMPORTANT: When you use the Lucene Query Syntax in the *KQL* search bar, {kib} is unable to search on nested objects and perform aggregations across fields that contain nested objects. +Using `include_in_parent` or `copy_to` as a workaround can cause {kib} to fail. + For more detailed information about the Lucene query syntax, see the {ref}/query-dsl-query-string-query.html#query-string-syntax[Query String Query] docs. diff --git a/docs/management/watcher-ui/index.asciidoc b/docs/management/watcher-ui/index.asciidoc index dae7010cdc0db..d99fd127438e0 100644 --- a/docs/management/watcher-ui/index.asciidoc +++ b/docs/management/watcher-ui/index.asciidoc @@ -27,7 +27,7 @@ threshold watch, take a look at the different watcher actions. If you are creating an advanced watch, you should be familiar with the parts of a watch—input, schedule, condition, and actions. -NOTE: There are limitations in watcher that affect {kib}. For information, refer to {ref}/watcher-limitations.html[Alerting]. +NOTE: There are limitations in *Watcher* that affect {kib}. For information, refer to {ref}/watcher-limitations.html[Alerting]. [float] [[watcher-security]] diff --git a/docs/user/reporting/index.asciidoc b/docs/user/reporting/index.asciidoc index c3f08fba26bf8..5bc1f9925adeb 100644 --- a/docs/user/reporting/index.asciidoc +++ b/docs/user/reporting/index.asciidoc @@ -13,8 +13,6 @@ a PDF, PNG, or CSV document, which you can keep for yourself, or share with othe Reporting is available from the *Share* menu in *Discover*, *Dashboard*, and *Canvas*. -NOTE: When you export a data table or saved search from a dashboard report, the PDF includes only the visible data. - [role="screenshot"] image::user/reporting/images/share-button.png["Share"] @@ -57,6 +55,8 @@ click the share icon image:user/reporting/images/canvas-share-button.png["Canvas + A notification appears when the report is complete. +NOTE: When you export a data table or saved search from a dashboard report, the PDF includes only the visible data. + [float] [[reporting-layout-sizing]] == Layout and sizing