From 0d45daf6d487bc9699098f98a6b3afa415a08739 Mon Sep 17 00:00:00 2001 From: Lisa Cawley Date: Thu, 31 Oct 2019 12:18:07 -0700 Subject: [PATCH] [DOCS] Removes Extend your use case section (#49812) --- docs/redirects.asciidoc | 4 ++++ docs/user/extend.asciidoc | 15 --------------- docs/user/graph/configuring-graph.asciidoc | 6 +++--- docs/user/graph/getting-started.asciidoc | 2 +- docs/user/graph/index.asciidoc | 9 ++++++--- docs/user/graph/limitations.asciidoc | 6 +++--- docs/user/graph/troubleshooting.asciidoc | 10 +++++----- docs/user/index.asciidoc | 4 +++- docs/user/ml/index.asciidoc | 13 +++++++------ 9 files changed, 32 insertions(+), 37 deletions(-) delete mode 100644 docs/user/extend.asciidoc diff --git a/docs/redirects.asciidoc b/docs/redirects.asciidoc index a8d8a66fd182c..af67ff70c81b5 100644 --- a/docs/redirects.asciidoc +++ b/docs/redirects.asciidoc @@ -35,3 +35,7 @@ This page has moved. Please see <>. This page has moved. Please see <>. +[role="exclude",id="extend"] +== Extend your use case + +This page was deleted. See <> and <>. \ No newline at end of file diff --git a/docs/user/extend.asciidoc b/docs/user/extend.asciidoc deleted file mode 100644 index c658731ce3c3d..0000000000000 --- a/docs/user/extend.asciidoc +++ /dev/null @@ -1,15 +0,0 @@ -[[extend]] -= Extend your use case - -[partintro] --- -//TBD - -* <> -* <> - --- - -include::graph/index.asciidoc[] - -include::ml/index.asciidoc[] diff --git a/docs/user/graph/configuring-graph.asciidoc b/docs/user/graph/configuring-graph.asciidoc index 9503e606406b3..d521f9d8d2846 100644 --- a/docs/user/graph/configuring-graph.asciidoc +++ b/docs/user/graph/configuring-graph.asciidoc @@ -1,6 +1,6 @@ [role="xpack"] [[graph-configuration]] -=== Configuring Graph +== Configuring Graph When a user saves a graph workspace in Kibana, it is stored in the `.kibana` index along with other saved objects like visualizations and dashboards. @@ -57,9 +57,9 @@ is displayed. For more information on granting access to Kibana, see [role="screenshot"] image::user/graph/images/graph-read-only-badge.png[Example of Graph's read only access indicator in Kibana's header] -[float] +[discrete] [[disable-drill-down]] -==== Disabling drill down configuration +=== Disabling drill down configuration By default, users can configure _drill down_ URLs to display additional information about a selected vertex in a new browser window. For example, diff --git a/docs/user/graph/getting-started.asciidoc b/docs/user/graph/getting-started.asciidoc index dd5e8527c8976..19f3df341338e 100644 --- a/docs/user/graph/getting-started.asciidoc +++ b/docs/user/graph/getting-started.asciidoc @@ -1,6 +1,6 @@ [role="xpack"] [[graph-getting-started]] -=== Using Graph +== Using Graph Graph is automatically enabled in {es} and {kib}. diff --git a/docs/user/graph/index.asciidoc b/docs/user/graph/index.asciidoc index 9ca7b0e4b1a4a..f9094f5b594b1 100644 --- a/docs/user/graph/index.asciidoc +++ b/docs/user/graph/index.asciidoc @@ -1,7 +1,9 @@ [role="xpack"] [[xpack-graph]] -== Graph data connections += Graph data connections +[partintro] +-- The {graph-features} enable you to discover how items in an Elasticsearch index are related. You can explore the connections between indexed terms and see which connections are the most meaningful. This can be @@ -17,9 +19,9 @@ and an interactive graph visualization tool for Kibana. Both work out of the box with existing Elasticsearch indices--you don't need to store any additional data to use these features. +[discrete] [[how-graph-works]] -[float] -=== How Graph works +== How Graph works The graph API provides an alternative way to extract and summarize information about the documents and terms in your Elasticsearch index. A _graph_ is really just a network of related items. In our case, this means a network of related @@ -62,6 +64,7 @@ multi-node clusters and scales with your Elasticsearch deployment. Advanced options let you control how your data is sampled and summarized. You can also set timeouts to prevent graph queries from adversely affecting the cluster. +-- include::getting-started.asciidoc[] diff --git a/docs/user/graph/limitations.asciidoc b/docs/user/graph/limitations.asciidoc index b40f15000483a..e96910bd27b4c 100644 --- a/docs/user/graph/limitations.asciidoc +++ b/docs/user/graph/limitations.asciidoc @@ -1,12 +1,12 @@ [role="xpack"] [[graph-limitations]] -=== Graph limitations +== Graph limitations ++++ Limitations ++++ -[float] -==== Limited support for multiple indices +[discrete] +=== Limited support for multiple indices The graph API can explore multiple indices, types, or aliases in a single API request, but the assumption is that each "hop" it performs is querying the same set of indices. Currently, it is not possible to diff --git a/docs/user/graph/troubleshooting.asciidoc b/docs/user/graph/troubleshooting.asciidoc index 7a87aba7b7f81..ff3568ed41afa 100644 --- a/docs/user/graph/troubleshooting.asciidoc +++ b/docs/user/graph/troubleshooting.asciidoc @@ -1,12 +1,12 @@ [role="xpack"] [[graph-troubleshooting]] -=== Graph Troubleshooting +== Graph Troubleshooting ++++ Troubleshooting ++++ -[float] -==== Why are results missing? +[discrete] +=== Why are results missing? The default settings in Graph API requests are configured to tune out noisy results by using the following strategies: @@ -29,8 +29,8 @@ of any statistical correlation with the sample. * Set the `min_doc_count` for your vertices to 1 to ensure only one document is required to assert a relationship. -[float] -==== What can I do to to improve performance? +[discrete] +=== What can I do to to improve performance? With the default setting of `use_significance` set to `true`, the Graph API performs a background frequency check of the terms it discovers as part of diff --git a/docs/user/index.asciidoc b/docs/user/index.asciidoc index 4b29255c50a1d..ebe6c10c49872 100644 --- a/docs/user/index.asciidoc +++ b/docs/user/index.asciidoc @@ -16,7 +16,9 @@ include::dashboard.asciidoc[] include::canvas.asciidoc[] -include::extend.asciidoc[] +include::graph/index.asciidoc[] + +include::ml/index.asciidoc[] include::{kib-repo-dir}/maps/index.asciidoc[] diff --git a/docs/user/ml/index.asciidoc b/docs/user/ml/index.asciidoc index a5f14ed2cf944..b7bf459c39d98 100644 --- a/docs/user/ml/index.asciidoc +++ b/docs/user/ml/index.asciidoc @@ -1,7 +1,9 @@ [role="xpack"] [[xpack-ml]] -== {ml-cap} += {ml-cap} +[partintro] +-- As datasets increase in size and complexity, the human effort required to inspect dashboards or maintain rules for spotting infrastructure problems, cyber attacks, or business issues becomes impractical. Elastic {ml-features} @@ -28,10 +30,10 @@ You need the following permissions to use the Data Visualizer with file upload: For more information, see {ref}/security-privileges.html[Security privileges] and {ref}/built-in-roles.html[Built-in roles]. +-- -[float] [[xpack-ml-anomalies]] -=== {anomaly-detect-cap} +== {anomaly-detect-cap} The Elastic {ml} {anomaly-detect} feature automatically models the normal behavior of your time series data — learning trends, periodicity, and more — in @@ -82,9 +84,8 @@ For more information about the {anomaly-detect} feature, see https://www.elastic.co/what-is/elastic-stack-machine-learning[{ml-cap} in the {stack}] and {stack-ov}/xpack-ml.html[{ml-cap} {anomaly-detect}]. -[float] [[xpack-ml-dfanalytics]] -=== {dfanalytics-cap} +== {dfanalytics-cap} The Elastic {ml} {dfanalytics} feature enables you to analyze your data using {oldetection} and {regression} algorithms and generate new indices that contain @@ -98,4 +99,4 @@ in {kib}. For example: image::user/ml/images/outliers.jpg[{oldetection-cap} results in {kib}] For more information about the {dfanalytics} feature, see -{stack-ov}/ml-dfanalytics.html[{ml-cap} {dfanalytics}]. +{stack-ov}/ml-dfanalytics.html[{ml-cap} {dfanalytics}]. \ No newline at end of file