From 16a967bc02b94db6b3e1677855cb827779a06fd6 Mon Sep 17 00:00:00 2001 From: gchaps Date: Tue, 23 Jun 2020 10:40:23 -0700 Subject: [PATCH 01/32] [DOCS] Adds glossary to documentation --- docs/glossary.asciidoc | 207 +++++++++++++++++++++++++++++++++++++++++ docs/index.asciidoc | 2 + 2 files changed, 209 insertions(+) create mode 100644 docs/glossary.asciidoc diff --git a/docs/glossary.asciidoc b/docs/glossary.asciidoc new file mode 100644 index 0000000000000..612c33c79f2d5 --- /dev/null +++ b/docs/glossary.asciidoc @@ -0,0 +1,207 @@ +[glossary] +[[glossary]] += Glossary of terms + +<> | <> | <> | <> | <> | <> | <> | <> | <> | <> | <> | <> | <> | <> | <> | <> | <> | <> | <> | <> | <> | V | <> | X | Y | Z + +[float] +[[a_glos]] +== A + +[glossary] +[[glossary-alerts-and-actions]] Alerts and Actions :: ++ +-- +// tag::alerts-and-actions-def[] +A {kib} app that provides comprehensive views across alert types and tools. It +allows you to manage all your alerts and connector configurations in one +place and view the active alert instances. Alerts and Actions works along side <>. +Refer to {kibana-ref}/alerting-getting-started.html[Alerts and Actions]. +// end::alerts-and-actions-def[] +-- + +[[glossary-action]] action :: +// tag::action-def[] +The alert-specific response that occurs when an alert fires. The response is +customizable and can contain a number of alert context variables. An action +can be channelled to external services through a connector. An alert can have multiple actions. +Refer to +{kibana-ref}/action-types.html[Action and connector types]. +// end::action-def[] + +[[glossary-action-type]] action type :: +// tag::action-type-def[] +A programatically defined integration with another service, with an expected +set of configuration and parameters. +// end::action-type-def[] + +[[glossary-advanced-settings]] Advanced Settings :: +// tag::advanced-settings-def[] +A UI for editing the settings that control the appearance and behavior +(for example, date format, default index) of {kib}. The UI is part of Management. +For more information, see {kibana-ref}/advanced-options.html[Advanced Settings]. +// end::advanced-settings-def[] + +[[glossary-auto-follow-pattern]] auto-follow pattern :: ++ +-- +include::{es-repo-dir}/glossary.asciidoc[tag=auto-follow-pattern-def] +-- + +[float] +[[b_glos]] +== B + + +[float] +[[c_glos]] +== C + +[[glossary-cluster]] cluster :: ++ +-- +include::{es-repo-dir}/glossary.asciidoc[tag=cluster-def] +-- + +[[glossary-ccr]] {ccr} (CCR):: ++ +-- +include::{es-repo-dir}/glossary.asciidoc[tag=ccr-def] +-- + +[[glossary-ccs]] {ccs} (CCS):: ++ +-- +include::{es-repo-dir}/glossary.asciidoc[tag=ccs-def] +-- + + +[float] +[[d_glos]] +== D + +[float] +[[e_glos]] +== E + +[float] +[[f_glos]] +== F + +[float] +[[g_glos]] +== G + +[float] +[[h_glos]] +== H + +[float] +[[i_glos]] +== I + +[float] +[[j_glos]] +== J + +[float] +[[k_glos]] +== K + +[float] +[[l_glos]] +== L + +[float] +[[m_glos]] +== M + +[float] +[[n_glos]] +== N + +[float] +[[o_glos]] +== O + +[float] +[[p_glos]] +== P + +[float] +[[q_glos]] +== Q + +[float] +[[r_glos]] +== R + +[[glossary-reindex]] reindex :: ++ +-- +include::{es-repo-dir}/glossary.asciidoc[tag=reindex-def] +-- + +[float] +[[s_glos]] +== S + +[[glossary-space]] space :: +// tag::space-def[] +A place for organizing dashboards, visualizations, and other saved objects by category. +For example, you might create a space based on a team, use case, or individual. +// end::space-def[] + +[[glossary-feature-space]] Space :: +// tag::space-feature-def[] +A feature in {kib} that allows you to organize your dashboards, visualizations, and +other saved objects into meaningful categories. Refer to +{kibana-ref}/xpack-spaces.html[Spaces]. +// end::space-feature-def[] + +[[glossary-stack-monitoring]] Stack Monitoring :: +// tag::stack-monitoring-def[] +Features that enable you to monitor the Elastic Stack, including health and +performance data for {es}, Logstash, and Beats. You can also monitor {kib} +and route that data to the monitoring cluster. Refer to +{kibana-ref}/xpack-monitoring.html[Stack Monitoring]. +// end::stack-monitoring-def[] + + +[float] +[[t_glos]] +== T + +[float] +[[u_glos]] +== U + +[[glossary-upgrade-assistant]] Upgrade Assistant :: +// tag::upgrade-assistant-def[] +A feature that helps prepare you for an upgrade to the next major version of +{es}. The assistant identifies the deprecated settings in your cluster and +indices and guides you through resolving issues, including reindexing. For more information, refer to +{kibana-ref}/upgrade-assistant.html[Upgrade Assistant]. +// end::upgrade-assistant-def[] + + +[float] +[[v_glos]] +== V + +[[glossary-visualzation]] visualization :: +// tag::visualzation-def[] +A graphical representation of query results (e.g., a histogram, line graph, pie chart, or heat map). +// end::visualization-def[] + + +[float] +[[w_glos]] +== W + +[[glossary-watcher]] Watcher :: +// tag::watcher-def[] +The original suite of alerting features. +For more information, refer to +{kibana-ref}/watcher.html[Watcher]. +// end::watcher-def[] diff --git a/docs/index.asciidoc b/docs/index.asciidoc index 66ad2f7ec306a..d0d76dcbff92a 100644 --- a/docs/index.asciidoc +++ b/docs/index.asciidoc @@ -28,4 +28,6 @@ include::CHANGELOG.asciidoc[] include::developer/index.asciidoc[] +include::glossary.asciidoc[] + include::redirects.asciidoc[] From 4cfacc613c765e272bd8270701c366c1a8c908e7 Mon Sep 17 00:00:00 2001 From: gchaps Date: Tue, 23 Jun 2020 14:39:42 -0700 Subject: [PATCH 02/32] [DOCS] Fixes build errors --- docs/glossary.asciidoc | 186 ++++++++++++++++++++++++++++++++++------- 1 file changed, 154 insertions(+), 32 deletions(-) diff --git a/docs/glossary.asciidoc b/docs/glossary.asciidoc index 612c33c79f2d5..5ed61f4c5a817 100644 --- a/docs/glossary.asciidoc +++ b/docs/glossary.asciidoc @@ -42,48 +42,81 @@ A UI for editing the settings that control the appearance and behavior For more information, see {kibana-ref}/advanced-options.html[Advanced Settings]. // end::advanced-settings-def[] -[[glossary-auto-follow-pattern]] auto-follow pattern :: -+ --- -include::{es-repo-dir}/glossary.asciidoc[tag=auto-follow-pattern-def] --- - [float] [[b_glos]] == B +[[glossary-basemap]] basemap :: +// tag::basemap-def[] +The background detail necessary to orient the location of a map. +// end::basemap-def[] + +[[glossary-blocklist]] block list :: +// tag::blocklist-def[] +A filtering rule that excludes one or more members from a set. +// end::blocklist-def[] + [float] [[c_glos]] == C -[[glossary-cluster]] cluster :: -+ --- -include::{es-repo-dir}/glossary.asciidoc[tag=cluster-def] --- +[[glossary-certainty-map]] certainty :: +// tag::certainty-def[] +Specifies how many documents must contain a pair of terms before it is considered +to be a useful connection in a graph. +// end::certainty-def[] -[[glossary-ccr]] {ccr} (CCR):: -+ --- -include::{es-repo-dir}/glossary.asciidoc[tag=ccr-def] --- - -[[glossary-ccs]] {ccs} (CCS):: -+ --- -include::{es-repo-dir}/glossary.asciidoc[tag=ccs-def] --- +[[glossary-choropleth-map]] choropleth map :: +// tag::choropleth-map-def[] +A map that shade areas in proportion to metric values that represent an aggregate summary +of a geographic characteristic (e.g. a map showing age or political +affiliation across geopolitical boundaries). +// end::choropleth-map-def[] [float] [[d_glos]] == D +[glossary-data-source]] data source :: +// tag::data-source-def[] +The data source for a map, Canvas element, and visualizations. +// end::data-source-def[] + +[glossary-data-source]] diversity field :: +// tag::data-source-def[] +A field for which only a certain number of documents will be accepted in your +graph to avoid bias. For example, if you select "nationality" as a +diversity field, a limited number of documents will be accepted per nationality +in your sample. +// end::data-source-def[] + +[glossary-drilldown]] drilldown :: +// tag::drilldown-def[] +Custom navigation paths between apps. Refer to {kibana-ref}/drilldowns.html[Use drilldowns for dashboard actions]. +// end::drilldown-def[] + + + [float] [[e_glos]] == E +[[glossary-edge]] edge :: +// tag::edge-def[] +In network diagrams, the links (often lines) between nodes that denote a relationship. +The width of the edges represents the strength of the relationship. +// end::edge-def[] + + +[[glossary-ems]] Elastic Maps Service (EMS) :: +// tag::ems-def[] +A service that serves basemap tiles, shape files, and other key features +that are essential for visualizing geospatial data. +// end::ems-def[] + + [float] [[f_glos]] == F @@ -92,10 +125,22 @@ include::{es-repo-dir}/glossary.asciidoc[tag=ccs-def] [[g_glos]] == G +[[glossary-GeoJSON]] GeoJSON :: +// tag::GeoJSON-def[] +An open-standard file format for storing geospatial vector data. +// end::GeoJSON-def[] + + [float] [[h_glos]] == H +[[glossary-heat map]] heat map :: +// tag::GeoJSON-def[] +A geographic visualization in which point data is clustered to show locations with higher densities. +// end::GeoJSON-def[] + + [float] [[i_glos]] == I @@ -108,14 +153,48 @@ include::{es-repo-dir}/glossary.asciidoc[tag=ccs-def] [[k_glos]] == K +[[glossary-kql]] {kib} Query Language (KQL) :: +// tag::kql-def[] +The default language for querying in {kib}. The {kib} Query Language provides +support for scripted fields. +// end::kql-def[] + + [float] [[l_glos]] == L +[[glossary-lucene]] Lucene query syntax :: +// tag::lucene-def[] +The query syntax for {kib}’s legacy query language. The Lucene query +syntax is available under the options menu in the query bar and from the +<>. +// end::lucene-def[] + [float] [[m_glos]] == M +[[glossary-map]] map :: +// tag::map-def[] +A series of layers, drawn in a particular order. +Refer to {kibana-ref}/maps.html[Maps]. +// end::map-def[] + + +[[glossary-map-layer]] map layer :: +// tag::map-layer-def[] +A representation of geographic data using symbols and labels. Refer to <>. +// end::map-layer-def[] + +[[glossary-maps]] Maps :: +// tag::maps-def[] +An app for visual exploration and analysis of geospatial data. Supports multiple layers +and data sources, mapping of individual geo points and shapes, and dynamic client-side styling. +Refer to {kibana-ref}/maps.html[Maps]. +// end::maps-def[] + + [float] [[n_glos]] == N @@ -132,29 +211,48 @@ include::{es-repo-dir}/glossary.asciidoc[tag=ccs-def] [[q_glos]] == Q +[[glossary-query-bar]] space :: +// tag::query-bar-def[] +A text field that enables you to submit a query expression that specifies what +information you want to retrieve and interact with. +// end::query-bar-def[] + + [float] [[r_glos]] == R -[[glossary-reindex]] reindex :: -+ --- -include::{es-repo-dir}/glossary.asciidoc[tag=reindex-def] --- - [float] [[s_glos]] == S +[[glossary-saved-object]] saved object :: +// tag::saved-object-def[] +An object that stores data for later use. A saved object can be a +dashboard, visualization, map, index pattern, or Canvas workpad. +// end::saved-object-def[] + +[[glossary-saved-search]] saved search :: +// tag::saved-search-def[] +The query text, filters, and time filter that make up a search, +saved for later retrieval and reuse. +// end::saved-search-def[] + +[[glossary-scripted-field]] scripted field :: +// tag::scripted-field-def[] +A field that computes data on the fly from the data in your {es} indices. +Scripted field data is shown in Discover and you can use them in your visualizations. +// end::scripted-field-def[] + [[glossary-space]] space :: // tag::space-def[] A place for organizing dashboards, visualizations, and other saved objects by category. For example, you might create a space based on a team, use case, or individual. // end::space-def[] -[[glossary-feature-space]] Space :: +[[glossary-feature-space]] Spaces :: // tag::space-feature-def[] -A feature in {kib} that allows you to organize your dashboards, visualizations, and +A feature allows you to organize your dashboards, visualizations, and other saved objects into meaningful categories. Refer to {kibana-ref}/xpack-spaces.html[Spaces]. // end::space-feature-def[] @@ -172,6 +270,25 @@ and route that data to the monitoring cluster. Refer to [[t_glos]] == T +[[glossary-term-join]] term join :: +// tag::term-join-def[] +A shared key that combines vector features with the results of an +{es} terms aggregation. Term joins augment vector features with +properties for data-driven styling and rich tooltip content in maps. +// end::term-join-def[] + +[[glossary-time-filter]] time filter :: +// tag::time-filter-def[] +A control that constrains the search results to a particular time period. +// end::time-filter-def[] + +[[glossary-time-series-data]] time series data :: +// tag::time-series-data[] +A control that constrains the search results to a particular time period. +// end::time-series-data[] + + + [float] [[u_glos]] == U @@ -180,7 +297,7 @@ and route that data to the monitoring cluster. Refer to // tag::upgrade-assistant-def[] A feature that helps prepare you for an upgrade to the next major version of {es}. The assistant identifies the deprecated settings in your cluster and -indices and guides you through resolving issues, including reindexing. For more information, refer to +indices and guides you through resolving issues, including reindexing. Refer to {kibana-ref}/upgrade-assistant.html[Upgrade Assistant]. // end::upgrade-assistant-def[] @@ -189,6 +306,11 @@ indices and guides you through resolving issues, including reindexing. For more [[v_glos]] == V +[[glossary-vector]] vector :: +// tag::vector-def[] +Points, lines, and polygons used to represent a map. +// end::vector-def[] + [[glossary-visualzation]] visualization :: // tag::visualzation-def[] A graphical representation of query results (e.g., a histogram, line graph, pie chart, or heat map). @@ -202,6 +324,6 @@ A graphical representation of query results (e.g., a histogram, line graph, pie [[glossary-watcher]] Watcher :: // tag::watcher-def[] The original suite of alerting features. -For more information, refer to +Refer to {kibana-ref}/watcher.html[Watcher]. // end::watcher-def[] From 8e328aadeed980ffc095141c20e2f84007d141a3 Mon Sep 17 00:00:00 2001 From: gchaps <33642766+gchaps@users.noreply.github.com> Date: Wed, 24 Jun 2020 15:22:23 -0700 Subject: [PATCH 03/32] Update docs/glossary.asciidoc Co-authored-by: Lisa Cawley --- docs/glossary.asciidoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/glossary.asciidoc b/docs/glossary.asciidoc index 5ed61f4c5a817..99cfee55ed64f 100644 --- a/docs/glossary.asciidoc +++ b/docs/glossary.asciidoc @@ -61,7 +61,7 @@ A filtering rule that excludes one or more members from a set. [[c_glos]] == C -[[glossary-certainty-map]] certainty :: +[[glossary-certainty]] certainty :: // tag::certainty-def[] Specifies how many documents must contain a pair of terms before it is considered to be a useful connection in a graph. From e591a919809957258f7f08b4b4dd4100f960319c Mon Sep 17 00:00:00 2001 From: gchaps <33642766+gchaps@users.noreply.github.com> Date: Wed, 24 Jun 2020 15:22:36 -0700 Subject: [PATCH 04/32] Update docs/glossary.asciidoc Co-authored-by: Lisa Cawley --- docs/glossary.asciidoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/glossary.asciidoc b/docs/glossary.asciidoc index 99cfee55ed64f..09f6b727cb98f 100644 --- a/docs/glossary.asciidoc +++ b/docs/glossary.asciidoc @@ -84,7 +84,7 @@ affiliation across geopolitical boundaries). The data source for a map, Canvas element, and visualizations. // end::data-source-def[] -[glossary-data-source]] diversity field :: +[glossary-diversity-field]] diversity field :: // tag::data-source-def[] A field for which only a certain number of documents will be accepted in your graph to avoid bias. For example, if you select "nationality" as a From 1ee1f4f4b7448ab08829ee74b0d56a9b1669aaa7 Mon Sep 17 00:00:00 2001 From: gchaps <33642766+gchaps@users.noreply.github.com> Date: Wed, 24 Jun 2020 15:22:48 -0700 Subject: [PATCH 05/32] Update docs/glossary.asciidoc Co-authored-by: Lisa Cawley --- docs/glossary.asciidoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/glossary.asciidoc b/docs/glossary.asciidoc index 09f6b727cb98f..eb0270359ab38 100644 --- a/docs/glossary.asciidoc +++ b/docs/glossary.asciidoc @@ -90,7 +90,7 @@ A field for which only a certain number of documents will be accepted in your graph to avoid bias. For example, if you select "nationality" as a diversity field, a limited number of documents will be accepted per nationality in your sample. -// end::data-source-def[] +// end::diversity-field-def[] [glossary-drilldown]] drilldown :: // tag::drilldown-def[] From cadd7874748f213c6a61bb421172061ec4ddb4c0 Mon Sep 17 00:00:00 2001 From: gchaps <33642766+gchaps@users.noreply.github.com> Date: Wed, 24 Jun 2020 15:23:00 -0700 Subject: [PATCH 06/32] Update docs/glossary.asciidoc Co-authored-by: Lisa Cawley --- docs/glossary.asciidoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/glossary.asciidoc b/docs/glossary.asciidoc index eb0270359ab38..e2012b99db967 100644 --- a/docs/glossary.asciidoc +++ b/docs/glossary.asciidoc @@ -138,7 +138,7 @@ An open-standard file format for storing geospatial vector data. [[glossary-heat map]] heat map :: // tag::GeoJSON-def[] A geographic visualization in which point data is clustered to show locations with higher densities. -// end::GeoJSON-def[] +// end::heat-map-def[] [float] From 6df1f395645cd95fe916a22db6b5a83688d0320c Mon Sep 17 00:00:00 2001 From: gchaps <33642766+gchaps@users.noreply.github.com> Date: Wed, 24 Jun 2020 15:23:23 -0700 Subject: [PATCH 07/32] Update docs/glossary.asciidoc Co-authored-by: Lisa Cawley --- docs/glossary.asciidoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/glossary.asciidoc b/docs/glossary.asciidoc index e2012b99db967..302727c20a553 100644 --- a/docs/glossary.asciidoc +++ b/docs/glossary.asciidoc @@ -211,7 +211,7 @@ Refer to {kibana-ref}/maps.html[Maps]. [[q_glos]] == Q -[[glossary-query-bar]] space :: +[[glossary-query-bar]] query bar :: // tag::query-bar-def[] A text field that enables you to submit a query expression that specifies what information you want to retrieve and interact with. From bd4a9a432a23301c5ea257ef304e0d5bb0b6576a Mon Sep 17 00:00:00 2001 From: gchaps <33642766+gchaps@users.noreply.github.com> Date: Wed, 24 Jun 2020 15:23:33 -0700 Subject: [PATCH 08/32] Update docs/glossary.asciidoc Co-authored-by: Lisa Cawley --- docs/glossary.asciidoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/glossary.asciidoc b/docs/glossary.asciidoc index 302727c20a553..0da0352e5e23b 100644 --- a/docs/glossary.asciidoc +++ b/docs/glossary.asciidoc @@ -285,7 +285,7 @@ A control that constrains the search results to a particular time period. [[glossary-time-series-data]] time series data :: // tag::time-series-data[] A control that constrains the search results to a particular time period. -// end::time-series-data[] +// end::time-series-data-def[] From 3d3ea7ba67b0a981cdf314adb36b3752d0f68e2d Mon Sep 17 00:00:00 2001 From: gchaps <33642766+gchaps@users.noreply.github.com> Date: Wed, 24 Jun 2020 15:23:45 -0700 Subject: [PATCH 09/32] Update docs/glossary.asciidoc Co-authored-by: Lisa Cawley --- docs/glossary.asciidoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/glossary.asciidoc b/docs/glossary.asciidoc index 0da0352e5e23b..f414232f349cf 100644 --- a/docs/glossary.asciidoc +++ b/docs/glossary.asciidoc @@ -312,7 +312,7 @@ Points, lines, and polygons used to represent a map. // end::vector-def[] [[glossary-visualzation]] visualization :: -// tag::visualzation-def[] +// tag::visualization-def[] A graphical representation of query results (e.g., a histogram, line graph, pie chart, or heat map). // end::visualization-def[] From 489e998babbbf217c592823e8d5d897dfa8bba85 Mon Sep 17 00:00:00 2001 From: gchaps <33642766+gchaps@users.noreply.github.com> Date: Wed, 24 Jun 2020 15:25:29 -0700 Subject: [PATCH 10/32] Update docs/glossary.asciidoc Co-authored-by: Lisa Cawley --- docs/glossary.asciidoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/glossary.asciidoc b/docs/glossary.asciidoc index f414232f349cf..b2e2e86390556 100644 --- a/docs/glossary.asciidoc +++ b/docs/glossary.asciidoc @@ -85,7 +85,7 @@ The data source for a map, Canvas element, and visualizations. // end::data-source-def[] [glossary-diversity-field]] diversity field :: -// tag::data-source-def[] +// tag::diversity-field-def[] A field for which only a certain number of documents will be accepted in your graph to avoid bias. For example, if you select "nationality" as a diversity field, a limited number of documents will be accepted per nationality From 7a06c22ce8974978a3cac1ae1fc52d741f9158b2 Mon Sep 17 00:00:00 2001 From: gchaps <33642766+gchaps@users.noreply.github.com> Date: Wed, 24 Jun 2020 15:25:38 -0700 Subject: [PATCH 11/32] Update docs/glossary.asciidoc Co-authored-by: Lisa Cawley --- docs/glossary.asciidoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/glossary.asciidoc b/docs/glossary.asciidoc index b2e2e86390556..9d1f723b26aac 100644 --- a/docs/glossary.asciidoc +++ b/docs/glossary.asciidoc @@ -125,7 +125,7 @@ that are essential for visualizing geospatial data. [[g_glos]] == G -[[glossary-GeoJSON]] GeoJSON :: +[[glossary-geojson]] GeoJSON :: // tag::GeoJSON-def[] An open-standard file format for storing geospatial vector data. // end::GeoJSON-def[] From 6a8d3d940e2dd3bd0a32716348da27483580b365 Mon Sep 17 00:00:00 2001 From: gchaps <33642766+gchaps@users.noreply.github.com> Date: Wed, 24 Jun 2020 15:25:50 -0700 Subject: [PATCH 12/32] Update docs/glossary.asciidoc Co-authored-by: Lisa Cawley --- docs/glossary.asciidoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/glossary.asciidoc b/docs/glossary.asciidoc index 9d1f723b26aac..2f2817f3b3ef4 100644 --- a/docs/glossary.asciidoc +++ b/docs/glossary.asciidoc @@ -283,7 +283,7 @@ A control that constrains the search results to a particular time period. // end::time-filter-def[] [[glossary-time-series-data]] time series data :: -// tag::time-series-data[] +// tag::time-series-data-def[] A control that constrains the search results to a particular time period. // end::time-series-data-def[] From 6f2e6fada22a3a14abdad650eb98bf85e2edc4da Mon Sep 17 00:00:00 2001 From: gchaps Date: Wed, 24 Jun 2020 17:05:37 -0700 Subject: [PATCH 13/32] [DOCS] Adds more terms to glossary --- docs/glossary.asciidoc | 244 +++++++++++++++++++++++++++++++---------- 1 file changed, 185 insertions(+), 59 deletions(-) diff --git a/docs/glossary.asciidoc b/docs/glossary.asciidoc index 2f2817f3b3ef4..bdfcaf08d10e0 100644 --- a/docs/glossary.asciidoc +++ b/docs/glossary.asciidoc @@ -9,39 +9,55 @@ == A [glossary] -[[glossary-alerts-and-actions]] Alerts and Actions :: +[[glossary-action]] action :: + -- -// tag::alerts-and-actions-def[] -A {kib} app that provides comprehensive views across alert types and tools. It -allows you to manage all your alerts and connector configurations in one -place and view the active alert instances. Alerts and Actions works along side <>. -Refer to {kibana-ref}/alerting-getting-started.html[Alerts and Actions]. -// end::alerts-and-actions-def[] --- - -[[glossary-action]] action :: // tag::action-def[] The alert-specific response that occurs when an alert fires. The response is -customizable and can contain a number of alert context variables. An action -can be channelled to external services through a connector. An alert can have multiple actions. +customizable and can contain a number of alert context variables. +An alert can have multiple actions. Refer to {kibana-ref}/action-types.html[Action and connector types]. // end::action-def[] - -[[glossary-action-type]] action type :: -// tag::action-type-def[] -A programatically defined integration with another service, with an expected -set of configuration and parameters. -// end::action-type-def[] +-- [[glossary-advanced-settings]] Advanced Settings :: // tag::advanced-settings-def[] A UI for editing the settings that control the appearance and behavior (for example, date format, default index) of {kib}. The UI is part of Management. -For more information, see {kibana-ref}/advanced-options.html[Advanced Settings]. +Refer to {kibana-ref}/advanced-options.html[Advanced Settings]. // end::advanced-settings-def[] +[[glossary-alert]] alert :: +// tag::alert-def[] +A specified set of conditions, schedules, and actions that notifies the user in some way when the conditions are met. +see also <>. +// end::alert-def[] + +[[glossary-alerts-and-actions]] Alerts and Actions :: +// tag::alerts-and-actions-def[] +A UI that provides comprehensive views across alert types and tools. It +allows you to manage all your alerts and connector configurations in one +place and view the active alert instances. Alerts and Actions works along side <>. +Refer to {kibana-ref}/alerting-getting-started.html[Alerts and Actions]. +// end::alerts-and-actions-def[] + +[[glossary-annotation]] annotation :: +// tag::annotation-def[] +In TSVB, a way to augment the data display with a tooltip that shows the results of a custom query. ++ +In machine learning, a way to augment a job with descriptive domain knowledge. +Refer to this +https://www.elastic.co/blog/augmenting-results-with-user-annotations-for-elastic-machine-learning[doc about user annotations]. +// end::annotation-def[] + +[[glossary-app]] app :: +// tag::app-def[] +A experience within Kibana that has a user interface and appears in the side navigation. An app may contain UIs, +such as Inspect in Elastic Maps, or tabs, such as Metrics Explorer in Metrics. +// end::app-def[] + + [float] [[b_glos]] == B @@ -56,45 +72,83 @@ The background detail necessary to orient the location of a map. A filtering rule that excludes one or more members from a set. // end::blocklist-def[] +[[glossary-bucket]] bucket :: +// tag::bucket-def[] +In {es}, a set of documents based on a certain criterion. +// end::bucket-def[] + +[[glossary-bucket-aggregation]] bucket aggregation:: +// tag::bucket-aggregation-def[] +An aggregation that creates buckets of documents. Each bucket is associated with a +criterion (depending on the aggregation type), which determines whether or not a document +in the current context falls into the bucket. +// end::bucket-aggregation-def[] [float] [[c_glos]] == C +[[glossary-canvas]] Canvas :: +// tag::canvas-def[] +Creates presentations and infographics that pull live data directly from {es}. +Refer to {kibana-ref}/canvas.html[Canvas]. +// end::canvas-def[] + +[[glossary-canvas-language]] Canvas expression language:: +// tag::ccanvas-language-def[] +A pipeline-based expression language for manipulating and visualizing data. +Includes dozens of functions and other capabilities, such as table transforms, +type casting, and sub-expressions. Supports TinyMath functions for complex math calculations. +Refer to {kibana-ref}/canvas-function-reference.html[Canvas function reference]. +// end::canvas-language-def[] + + [[glossary-certainty]] certainty :: // tag::certainty-def[] Specifies how many documents must contain a pair of terms before it is considered to be a useful connection in a graph. // end::certainty-def[] -[[glossary-choropleth-map]] choropleth map :: -// tag::choropleth-map-def[] -A map that shade areas in proportion to metric values that represent an aggregate summary -of a geographic characteristic (e.g. a map showing age or political -affiliation across geopolitical boundaries). -// end::choropleth-map-def[] - +[[glossary-connector]] connector :: +// tag::connector-def[] +A configuration UI with a service API, credentials, and +other information that enables integration with an external system (the destination for an action). +Refer to {kibana-ref}/action-types.html[Action and connector types]. +// end::connector-def[] + +[[glossary-console]] Console :: +// tag::console-def[] +A tool for interacting with the REST API of Elasticsearch. +Console enables you to send requests to Elasticsearch, view responses, +view API documentation, and get your request history. +Refer to {kibana-ref}/console-kibana.html[Console]. +// end::console-def[] [float] [[d_glos]] == D -[glossary-data-source]] data source :: +[[glossary-dashboard]] dashboard :: +// tag::dashboard-def[] +A collection of panels that contain elements such as visualizations, saved searches, and maps. +Provides insights into your data from multiple perspectives. +// end::dashboard-def[] + +[[glossary-data-source]] data source :: // tag::data-source-def[] -The data source for a map, Canvas element, and visualizations. +A file, database, or service that provides the underlying data for a map, Canvas element, or visualization. // end::data-source-def[] -[glossary-diversity-field]] diversity field :: +[[glossary-diversity-field]] diversity field :: // tag::diversity-field-def[] -A field for which only a certain number of documents will be accepted in your -graph to avoid bias. For example, if you select "nationality" as a -diversity field, a limited number of documents will be accepted per nationality -in your sample. +A field for which only a certain number of documents are accepted in a +graph to avoid bias. For example, if "nationality" is the +diversity field, a limited number of documents are accepted per nationality. // end::diversity-field-def[] -[glossary-drilldown]] drilldown :: +[[glossary-drilldown]] drilldown :: // tag::drilldown-def[] -Custom navigation paths between apps. Refer to {kibana-ref}/drilldowns.html[Use drilldowns for dashboard actions]. +A custom navigation paths between apps. Refer to {kibana-ref}/drilldowns.html[Drilldowns]. // end::drilldown-def[] @@ -116,29 +170,34 @@ A service that serves basemap tiles, shape files, and other key features that are essential for visualizing geospatial data. // end::ems-def[] +[[glossary-element]] element :: +// tag::element-def[] +A <> workpad object that enables you to display images, text, and visualizations. +// end::element-def[] + [float] [[f_glos]] == F + [float] [[g_glos]] == G -[[glossary-geojson]] GeoJSON :: -// tag::GeoJSON-def[] -An open-standard file format for storing geospatial vector data. -// end::GeoJSON-def[] +[[glossary-grok-debugger]] Grok Debugger :: +// tag::grok-debugger-def[] +A tool for building and debugging grok patterns. Grok is good for parsing logs, +such as syslog, apache, and other webserver logs. Refer to +{kibana-ref}/xpack-grokdebugger.html[Debugging grok expressions]. +// end::grok-debugger-def[] + [float] [[h_glos]] == H -[[glossary-heat map]] heat map :: -// tag::GeoJSON-def[] -A geographic visualization in which point data is clustered to show locations with higher densities. -// end::heat-map-def[] [float] @@ -155,7 +214,7 @@ A geographic visualization in which point data is clustered to show locations wi [[glossary-kql]] {kib} Query Language (KQL) :: // tag::kql-def[] -The default language for querying in {kib}. The {kib} Query Language provides +The default language for querying in {kib}. The KQL provides support for scripted fields. // end::kql-def[] @@ -164,6 +223,15 @@ support for scripted fields. [[l_glos]] == L +[[glossary-lens]] Lens :: +// tag::lens-def[] +Enables you to quickly build visualizations by dragging and dropping data fields. +Lens makes makes smart visualization suggestions for your data, +allowing for quick switching between visualization types. Refer to the +{kibana}-ref/lens.html[Lens documentation]. +// end::lens-def[] + + [[glossary-lucene]] Lucene query syntax :: // tag::lucene-def[] The query syntax for {kib}’s legacy query language. The Lucene query @@ -171,22 +239,22 @@ syntax is available under the options menu in the query bar and from the <>. // end::lucene-def[] +[[glossary-license-management]] License Management :: +// tag::license-management-def[] +A user interface in <> that allows you to view the status of your license, +start a trial, or install a new license. +// end::license-management-def[] + [float] [[m_glos]] == M [[glossary-map]] map :: // tag::map-def[] -A series of layers, drawn in a particular order. +A representation of geographic data using symbols and labels. Refer to {kibana-ref}/maps.html[Maps]. // end::map-def[] - -[[glossary-map-layer]] map layer :: -// tag::map-layer-def[] -A representation of geographic data using symbols and labels. Refer to <>. -// end::map-layer-def[] - [[glossary-maps]] Maps :: // tag::maps-def[] An app for visual exploration and analysis of geospatial data. Supports multiple layers @@ -207,6 +275,13 @@ Refer to {kibana-ref}/maps.html[Maps]. [[p_glos]] == P +[[glossary-panel]] panel :: +// tag::panel-def[] +A module in a <> that can contain a visualization, +query element, search boxes, fields, charts, tables, and lists. +// end::panel-def[] + + [float] [[q_glos]] == Q @@ -222,6 +297,12 @@ information you want to retrieve and interact with. [[r_glos]] == R +[[glossary-rollup-job]] Rollup Jobs :: +// tag::rollup-job-def[] +A feature that enables you to define the data flow and schedule for +rolling up historical data into a new, compact index. +// end::rollup-job-def[] + [float] [[s_glos]] == S @@ -240,20 +321,25 @@ saved for later retrieval and reuse. [[glossary-scripted-field]] scripted field :: // tag::scripted-field-def[] -A field that computes data on the fly from the data in your {es} indices. -Scripted field data is shown in Discover and you can use them in your visualizations. +A field that computes data on the fly from the data in {es} indices. +Scripted field data is shown in Discover and are used in visualizations. // end::scripted-field-def[] +[[glossary-shareable]] shareable :: +// tag::shareable-def[] +A Canvas workpad that can be embedded outside of Kibana +(e.g. on an internal wiki or public website) using HTML and JavaScript. +// end::shareable-def[] + [[glossary-space]] space :: // tag::space-def[] A place for organizing dashboards, visualizations, and other saved objects by category. -For example, you might create a space based on a team, use case, or individual. +For example, a space might be based on a team, use case, or individual. // end::space-def[] [[glossary-feature-space]] Spaces :: // tag::space-feature-def[] -A feature allows you to organize your dashboards, visualizations, and -other saved objects into meaningful categories. Refer to +A feature that allows you to organize your saved objects into meaningful categories. Refer to {kibana-ref}/xpack-spaces.html[Spaces]. // end::space-feature-def[] @@ -265,6 +351,12 @@ and route that data to the monitoring cluster. Refer to {kibana-ref}/xpack-monitoring.html[Stack Monitoring]. // end::stack-monitoring-def[] +[[glossary-management]] Stack Management :: +// tag::management-def[] +The home for managing the Elastic Stack — indices, clusters, licenses, UI settings, +index patterns, spaces, and more. +// end::management-def[] + [float] [[t_glos]] @@ -282,12 +374,26 @@ properties for data-driven styling and rich tooltip content in maps. A control that constrains the search results to a particular time period. // end::time-filter-def[] +[[glossary-timelion]] Timelion :: +// tag::timelion-def[] +A tool for building a time series visualization that analyzes data in time order. +Refer to {kibana-ref/timelion.html}[Timelion]. +// end::timelion-def[] + + [[glossary-time-series-data]] time series data :: // tag::time-series-data-def[] -A control that constrains the search results to a particular time period. +A series of data indexed in time order. // end::time-series-data-def[] +[[glossary-TSVB-data]] TSVB :: +// tag::TSVB-def[] +A time series data visualizer that allows you to combine an +infinite number of aggregations to display complex data. +Refer to {kibana-ref}/TSVB.html[TSVB]. +// end::TSVB-def[] + [float] [[u_glos]] @@ -306,16 +412,29 @@ indices and guides you through resolving issues, including reindexing. Refer to [[v_glos]] == V +[[glossary-vega]] Vega :: +// tag::vega-def[] +A declarative language used to create interactive visualizations. +Refer to {kibana-ref}/vega-graph.html[Vega]. +// end::vega-def[] + [[glossary-vector]] vector :: // tag::vector-def[] Points, lines, and polygons used to represent a map. // end::vector-def[] -[[glossary-visualzation]] visualization :: +[[glossary-visualization]] visualization :: // tag::visualization-def[] A graphical representation of query results (e.g., a histogram, line graph, pie chart, or heat map). // end::visualization-def[] +[[glossary-visualize]] Visualize :: +// tag::visualization-def[] +The {kib} feature that enables you to create visualizations of the data in your +{es} indices, which you can then add to a dashboard for analysis. +// end::visualization-def[] + + [float] [[w_glos]] @@ -325,5 +444,12 @@ A graphical representation of query results (e.g., a histogram, line graph, pie // tag::watcher-def[] The original suite of alerting features. Refer to -{kibana-ref}/watcher.html[Watcher]. +{kibana-ref}/watcher-ui.html[Watcher]. // end::watcher-def[] + +[[glossary-workpad]] workpad :: +// tag::workpad-def[] +A workspace where you build presentations of your live data in <>. +Refer to +{kibana-ref}/create-canvas-workpad.html[Create a workpad]. +// end::workpad-def[] From 843be4ff6632160edf55a5e9d1ab39f5fb29810a Mon Sep 17 00:00:00 2001 From: gchaps Date: Thu, 25 Jun 2020 15:39:42 -0700 Subject: [PATCH 14/32] [DOCS] Adds more terms to glossary --- docs/glossary.asciidoc | 127 ++++++++++++++++++++++++----------------- 1 file changed, 74 insertions(+), 53 deletions(-) diff --git a/docs/glossary.asciidoc b/docs/glossary.asciidoc index bdfcaf08d10e0..69bc584a46d74 100644 --- a/docs/glossary.asciidoc +++ b/docs/glossary.asciidoc @@ -1,6 +1,6 @@ [glossary] [[glossary]] -= Glossary of terms += Glossary <> | <> | <> | <> | <> | <> | <> | <> | <> | <> | <> | <> | <> | <> | <> | <> | <> | <> | <> | <> | <> | V | <> | X | Y | Z @@ -30,13 +30,13 @@ Refer to {kibana-ref}/advanced-options.html[Advanced Settings]. [[glossary-alert]] alert :: // tag::alert-def[] -A specified set of conditions, schedules, and actions that notifies the user in some way when the conditions are met. -see also <>. +A specified set of <>, schedules, and <> that notifies the user when the conditions are met. +Refer to <>. // end::alert-def[] [[glossary-alerts-and-actions]] Alerts and Actions :: // tag::alerts-and-actions-def[] -A UI that provides comprehensive views across alert types and tools. It +A UI that provides comprehensive views across alert types and tools. The UI allows you to manage all your alerts and connector configurations in one place and view the active alert instances. Alerts and Actions works along side <>. Refer to {kibana-ref}/alerting-getting-started.html[Alerts and Actions]. @@ -44,17 +44,14 @@ Refer to {kibana-ref}/alerting-getting-started.html[Alerts and Actions]. [[glossary-annotation]] annotation :: // tag::annotation-def[] -In TSVB, a way to augment the data display with a tooltip that shows the results of a custom query. -+ -In machine learning, a way to augment a job with descriptive domain knowledge. -Refer to this -https://www.elastic.co/blog/augmenting-results-with-user-annotations-for-elastic-machine-learning[doc about user annotations]. -// end::annotation-def[] +A way to augment a data display with descriptive domain knowledge. +// end::alerts-annotation-def[] + [[glossary-app]] app :: // tag::app-def[] A experience within Kibana that has a user interface and appears in the side navigation. An app may contain UIs, -such as Inspect in Elastic Maps, or tabs, such as Metrics Explorer in Metrics. +such as Inspect in Maps, or tabs, such as Metrics Explorer in Metrics. // end::app-def[] @@ -90,7 +87,7 @@ in the current context falls into the bucket. [[glossary-canvas]] Canvas :: // tag::canvas-def[] -Creates presentations and infographics that pull live data directly from {es}. +An app that enables you to create presentations and infographics that pull live data directly from {es}. Refer to {kibana-ref}/canvas.html[Canvas]. // end::canvas-def[] @@ -109,6 +106,11 @@ Specifies how many documents must contain a pair of terms before it is considere to be a useful connection in a graph. // end::certainty-def[] +[[glossary-condition]] condition :: +// tag::condition-def[] +The logic and customizable variables for when an alert should fire. +// end::condition-def[] + [[glossary-connector]] connector :: // tag::connector-def[] A configuration UI with a service API, credentials, and @@ -119,7 +121,7 @@ Refer to {kibana-ref}/action-types.html[Action and connector types]. [[glossary-console]] Console :: // tag::console-def[] A tool for interacting with the REST API of Elasticsearch. -Console enables you to send requests to Elasticsearch, view responses, +You can send requests to Elasticsearch, view responses, view API documentation, and get your request history. Refer to {kibana-ref}/console-kibana.html[Console]. // end::console-def[] @@ -130,7 +132,9 @@ Refer to {kibana-ref}/console-kibana.html[Console]. [[glossary-dashboard]] dashboard :: // tag::dashboard-def[] -A collection of panels that contain elements such as visualizations, saved searches, and maps. +A collection of panels that contain elements such as +<>, <>, and +<>. Provides insights into your data from multiple perspectives. // end::dashboard-def[] @@ -139,16 +143,15 @@ Provides insights into your data from multiple perspectives. A file, database, or service that provides the underlying data for a map, Canvas element, or visualization. // end::data-source-def[] -[[glossary-diversity-field]] diversity field :: -// tag::diversity-field-def[] -A field for which only a certain number of documents are accepted in a -graph to avoid bias. For example, if "nationality" is the -diversity field, a limited number of documents are accepted per nationality. -// end::diversity-field-def[] +[[glossary-discover]] Discover :: +// tag::discover-def[] +An app for searching and filtering your data so that you can narrow it down to +the subset of data that you are interested in. +// end::discover-def[] [[glossary-drilldown]] drilldown :: // tag::drilldown-def[] -A custom navigation paths between apps. Refer to {kibana-ref}/drilldowns.html[Drilldowns]. +A custom navigation path between apps. Refer to {kibana-ref}/drilldowns.html[Drilldowns]. // end::drilldown-def[] @@ -159,8 +162,9 @@ A custom navigation paths between apps. Refer to {kibana-ref}/drilldowns.html[Dr [[glossary-edge]] edge :: // tag::edge-def[] -In network diagrams, the links (often lines) between nodes that denote a relationship. -The width of the edges represents the strength of the relationship. +In a graph, the links (often lines) between nodes that denote a relationship. +The width of the edges represents the strength of the relationship. Refer to +{kibana-ref}/xpack-graph.html[Graph]. // end::edge-def[] @@ -180,15 +184,30 @@ A <> workpad object that enables you to display images, [[f_glos]] == F +[[glossary-feature-controls]] Feature Controls :: +// tag::feature-controls-def[] +A UI that enables administrators to customize which features are +available in each <>. You can use Feature Controls +to customize the navigation bar per space and make certain +features available or not within each given space. Refer to +{kibana-ref}//xpack-spaces.html#spaces-control-feature-visibility[Control feature access]. +// end::feature-controls-def[] [float] [[g_glos]] == G +[[glossary-graph]] graph :: +// tag::graph-def[] +A data structure and visualization that shows interconnections between +a set of entities. Each entity is represented by a node. Connections between +nodes are represented by <>. +// end::graph-def[] + [[glossary-grok-debugger]] Grok Debugger :: // tag::grok-debugger-def[] A tool for building and debugging grok patterns. Grok is good for parsing logs, -such as syslog, apache, and other webserver logs. Refer to +such as syslog, Apache, and other webserver logs. Refer to {kibana-ref}/xpack-grokdebugger.html[Debugging grok expressions]. // end::grok-debugger-def[] @@ -215,7 +234,8 @@ such as syslog, apache, and other webserver logs. Refer to [[glossary-kql]] {kib} Query Language (KQL) :: // tag::kql-def[] The default language for querying in {kib}. The KQL provides -support for scripted fields. +support for scripted fields. Refer to +{kibana-ref}/kuery-query.html[Kibana Query Language]. // end::kql-def[] @@ -227,8 +247,8 @@ support for scripted fields. // tag::lens-def[] Enables you to quickly build visualizations by dragging and dropping data fields. Lens makes makes smart visualization suggestions for your data, -allowing for quick switching between visualization types. Refer to the -{kibana}-ref/lens.html[Lens documentation]. +allowing for quick switching between visualization types. Refer to +{kibana-ref}/lens.html[Lens]. // end::lens-def[] @@ -255,12 +275,10 @@ A representation of geographic data using symbols and labels. Refer to {kibana-ref}/maps.html[Maps]. // end::map-def[] -[[glossary-maps]] Maps :: -// tag::maps-def[] -An app for visual exploration and analysis of geospatial data. Supports multiple layers -and data sources, mapping of individual geo points and shapes, and dynamic client-side styling. -Refer to {kibana-ref}/maps.html[Maps]. -// end::maps-def[] +[[glossary-metric-aggregation]] metric aggregation :: +// tag::metric-aggregation-def[] +An aggregation that keeps track of and computes metrics over a set of documents. +// end::metric-aggregation-def[] [float] @@ -275,10 +293,17 @@ Refer to {kibana-ref}/maps.html[Maps]. [[p_glos]] == P +[[glossary-painless-lab]] Painless Lab :: +// tag::painless-lab-def[] +An interactive code editor that lets you test and debug Painless scripts in real-time. +Refer to {kibana-ref}/painlesslab.html[Painless Lab]. +// end::painless-lab-def[] + + [[glossary-panel]] panel :: // tag::panel-def[] -A module in a <> that can contain a visualization, -query element, search boxes, fields, charts, tables, and lists. +A module in a <> that can contain a +query element or visualization, such as a chart, table, or list. // end::panel-def[] @@ -292,17 +317,19 @@ A text field that enables you to submit a query expression that specifies what information you want to retrieve and interact with. // end::query-bar-def[] +[[glossary-query-profiler]] Query Profiler :: +// tag::query-profiler-def[] +A tool for inspecting and analyzing search queries, +so you can diagnose and debug poorly performing queries. +Refer to {kibana-ref}/xpack-profiler.html[Query Profiler]. +// end::query-profiler-def[] + + [float] [[r_glos]] == R -[[glossary-rollup-job]] Rollup Jobs :: -// tag::rollup-job-def[] -A feature that enables you to define the data flow and schedule for -rolling up historical data into a new, compact index. -// end::rollup-job-def[] - [float] [[s_glos]] == S @@ -322,7 +349,7 @@ saved for later retrieval and reuse. [[glossary-scripted-field]] scripted field :: // tag::scripted-field-def[] A field that computes data on the fly from the data in {es} indices. -Scripted field data is shown in Discover and are used in visualizations. +Scripted field data is shown in Discover and used in visualizations. // end::scripted-field-def[] [[glossary-shareable]] shareable :: @@ -333,7 +360,8 @@ A Canvas workpad that can be embedded outside of Kibana [[glossary-space]] space :: // tag::space-def[] -A place for organizing dashboards, visualizations, and other saved objects by category. +A place for organizing <>, +<>, and other <> by category. For example, a space might be based on a team, use case, or individual. // end::space-def[] @@ -354,7 +382,8 @@ and route that data to the monitoring cluster. Refer to [[glossary-management]] Stack Management :: // tag::management-def[] The home for managing the Elastic Stack — indices, clusters, licenses, UI settings, -index patterns, spaces, and more. +index patterns, spaces, and more. Refer to +{kibana-ref}/management.html[Stack Management]. // end::management-def[] @@ -377,7 +406,7 @@ A control that constrains the search results to a particular time period. [[glossary-timelion]] Timelion :: // tag::timelion-def[] A tool for building a time series visualization that analyzes data in time order. -Refer to {kibana-ref/timelion.html}[Timelion]. +Refer to {kibana-ref}/timelion.html[Timelion]. // end::timelion-def[] @@ -428,14 +457,6 @@ Points, lines, and polygons used to represent a map. A graphical representation of query results (e.g., a histogram, line graph, pie chart, or heat map). // end::visualization-def[] -[[glossary-visualize]] Visualize :: -// tag::visualization-def[] -The {kib} feature that enables you to create visualizations of the data in your -{es} indices, which you can then add to a dashboard for analysis. -// end::visualization-def[] - - - [float] [[w_glos]] == W From 3a2544833f5bac18f97281ed43738399beed2d04 Mon Sep 17 00:00:00 2001 From: gchaps <33642766+gchaps@users.noreply.github.com> Date: Fri, 26 Jun 2020 07:25:24 -0700 Subject: [PATCH 15/32] Update docs/glossary.asciidoc Co-authored-by: debadair --- docs/glossary.asciidoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/glossary.asciidoc b/docs/glossary.asciidoc index 69bc584a46d74..23de3e28a0032 100644 --- a/docs/glossary.asciidoc +++ b/docs/glossary.asciidoc @@ -176,7 +176,7 @@ that are essential for visualizing geospatial data. [[glossary-element]] element :: // tag::element-def[] -A <> workpad object that enables you to display images, text, and visualizations. +A <> workpad object that displays an image, text, or visualization. // end::element-def[] From 7391a3fde0aaef8920f06b0869f3b137fe71c6f1 Mon Sep 17 00:00:00 2001 From: gchaps <33642766+gchaps@users.noreply.github.com> Date: Fri, 26 Jun 2020 07:29:14 -0700 Subject: [PATCH 16/32] Update docs/glossary.asciidoc Co-authored-by: debadair --- docs/glossary.asciidoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/glossary.asciidoc b/docs/glossary.asciidoc index 23de3e28a0032..26dbe1b61b940 100644 --- a/docs/glossary.asciidoc +++ b/docs/glossary.asciidoc @@ -233,7 +233,7 @@ such as syslog, Apache, and other webserver logs. Refer to [[glossary-kql]] {kib} Query Language (KQL) :: // tag::kql-def[] -The default language for querying in {kib}. The KQL provides +The default language for querying in {kib}. KQL provides support for scripted fields. Refer to {kibana-ref}/kuery-query.html[Kibana Query Language]. // end::kql-def[] From 7b2d6a3f0b401ba9343ff9f43e8da7649757c78c Mon Sep 17 00:00:00 2001 From: gchaps <33642766+gchaps@users.noreply.github.com> Date: Fri, 26 Jun 2020 07:29:35 -0700 Subject: [PATCH 17/32] Update docs/glossary.asciidoc Co-authored-by: debadair --- docs/glossary.asciidoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/glossary.asciidoc b/docs/glossary.asciidoc index 26dbe1b61b940..3f401cd73f5e1 100644 --- a/docs/glossary.asciidoc +++ b/docs/glossary.asciidoc @@ -362,7 +362,7 @@ A Canvas workpad that can be embedded outside of Kibana // tag::space-def[] A place for organizing <>, <>, and other <> by category. -For example, a space might be based on a team, use case, or individual. +For example, you might have different spaces for each team, use case, or individual. // end::space-def[] [[glossary-feature-space]] Spaces :: From b0ca38bf3c0911967c3d3bad8d370b101ca0f440 Mon Sep 17 00:00:00 2001 From: gchaps <33642766+gchaps@users.noreply.github.com> Date: Fri, 26 Jun 2020 07:29:59 -0700 Subject: [PATCH 18/32] Update docs/glossary.asciidoc Co-authored-by: debadair --- docs/glossary.asciidoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/glossary.asciidoc b/docs/glossary.asciidoc index 3f401cd73f5e1..39b15efcaeac9 100644 --- a/docs/glossary.asciidoc +++ b/docs/glossary.asciidoc @@ -412,7 +412,7 @@ Refer to {kibana-ref}/timelion.html[Timelion]. [[glossary-time-series-data]] time series data :: // tag::time-series-data-def[] -A series of data indexed in time order. +Timestamped data such as logs, metrics, and events that is indexed on an ongoing basis. // end::time-series-data-def[] From a00a48a8fb018b6acc2342c79737bc5037b330e7 Mon Sep 17 00:00:00 2001 From: gchaps <33642766+gchaps@users.noreply.github.com> Date: Fri, 26 Jun 2020 07:30:43 -0700 Subject: [PATCH 19/32] Update docs/glossary.asciidoc Co-authored-by: debadair --- docs/glossary.asciidoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/glossary.asciidoc b/docs/glossary.asciidoc index 39b15efcaeac9..add4c814e2a87 100644 --- a/docs/glossary.asciidoc +++ b/docs/glossary.asciidoc @@ -247,7 +247,7 @@ support for scripted fields. Refer to // tag::lens-def[] Enables you to quickly build visualizations by dragging and dropping data fields. Lens makes makes smart visualization suggestions for your data, -allowing for quick switching between visualization types. Refer to +allowing you to quickly switch between visualization types. Refer to {kibana-ref}/lens.html[Lens]. // end::lens-def[] From 65212deb3dea66b5377e130ddaed54af2dcd7fb9 Mon Sep 17 00:00:00 2001 From: gchaps <33642766+gchaps@users.noreply.github.com> Date: Fri, 26 Jun 2020 07:31:20 -0700 Subject: [PATCH 20/32] Update docs/glossary.asciidoc Co-authored-by: debadair --- docs/glossary.asciidoc | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/glossary.asciidoc b/docs/glossary.asciidoc index add4c814e2a87..ebff6c3cfb21a 100644 --- a/docs/glossary.asciidoc +++ b/docs/glossary.asciidoc @@ -313,8 +313,8 @@ query element or visualization, such as a chart, table, or list. [[glossary-query-bar]] query bar :: // tag::query-bar-def[] -A text field that enables you to submit a query expression that specifies what -information you want to retrieve and interact with. +The text field where you enter a query expression to +retrieve the data you want to interact with. // end::query-bar-def[] [[glossary-query-profiler]] Query Profiler :: From 6098db4cffc757f6d47960bdd8115b9091457b04 Mon Sep 17 00:00:00 2001 From: gchaps <33642766+gchaps@users.noreply.github.com> Date: Fri, 26 Jun 2020 07:32:00 -0700 Subject: [PATCH 21/32] Update docs/glossary.asciidoc Co-authored-by: debadair --- docs/glossary.asciidoc | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/docs/glossary.asciidoc b/docs/glossary.asciidoc index ebff6c3cfb21a..a65cb1baf5bcb 100644 --- a/docs/glossary.asciidoc +++ b/docs/glossary.asciidoc @@ -319,8 +319,7 @@ retrieve the data you want to interact with. [[glossary-query-profiler]] Query Profiler :: // tag::query-profiler-def[] -A tool for inspecting and analyzing search queries, -so you can diagnose and debug poorly performing queries. +A tool that enables you to inspect and analyze search queries to diagnose and debug poorly performing queries. Refer to {kibana-ref}/xpack-profiler.html[Query Profiler]. // end::query-profiler-def[] From 73ea951fd7612512fbd2321e3bf329bd8b52a5e5 Mon Sep 17 00:00:00 2001 From: gchaps <33642766+gchaps@users.noreply.github.com> Date: Fri, 26 Jun 2020 07:32:55 -0700 Subject: [PATCH 22/32] Update docs/glossary.asciidoc Co-authored-by: debadair --- docs/glossary.asciidoc | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/glossary.asciidoc b/docs/glossary.asciidoc index a65cb1baf5bcb..5ad876020eb07 100644 --- a/docs/glossary.asciidoc +++ b/docs/glossary.asciidoc @@ -353,8 +353,8 @@ Scripted field data is shown in Discover and used in visualizations. [[glossary-shareable]] shareable :: // tag::shareable-def[] -A Canvas workpad that can be embedded outside of Kibana -(e.g. on an internal wiki or public website) using HTML and JavaScript. +A Canvas workpad that can be embedded on any webpage. +Shareables enable you to display Canvas visualizations on internal wiki pages or public websites. // end::shareable-def[] [[glossary-space]] space :: From 654fbcdc9871638fa2541a3c6d0116256f6cfb8b Mon Sep 17 00:00:00 2001 From: gchaps Date: Fri, 26 Jun 2020 08:18:37 -0700 Subject: [PATCH 23/32] [DOCS] Incorporates review comments --- docs/glossary.asciidoc | 150 ++++++++++++++++++++--------------------- 1 file changed, 74 insertions(+), 76 deletions(-) diff --git a/docs/glossary.asciidoc b/docs/glossary.asciidoc index 5ad876020eb07..8ad2a13ea1078 100644 --- a/docs/glossary.asciidoc +++ b/docs/glossary.asciidoc @@ -13,33 +13,33 @@ + -- // tag::action-def[] -The alert-specific response that occurs when an alert fires. The response is -customizable and can contain a number of alert context variables. +The alert-specific response that occurs when an alert fires. An alert can have multiple actions. -Refer to +See {kibana-ref}/action-types.html[Action and connector types]. // end::action-def[] -- [[glossary-advanced-settings]] Advanced Settings :: // tag::advanced-settings-def[] -A UI for editing the settings that control the appearance and behavior -(for example, date format, default index) of {kib}. The UI is part of Management. -Refer to {kibana-ref}/advanced-options.html[Advanced Settings]. +Enables you to control the appearance and behavior of {kib} +by setting the date format, default index, and other attributes. +Part of {kib} <>. +See {kibana-ref}/advanced-options.html[Advanced Settings]. // end::advanced-settings-def[] [[glossary-alert]] alert :: // tag::alert-def[] -A specified set of <>, schedules, and <> that notifies the user when the conditions are met. -Refer to <>. +A set of <>, schedules, and <> +that enable notifications. +See <>. // end::alert-def[] [[glossary-alerts-and-actions]] Alerts and Actions :: // tag::alerts-and-actions-def[] -A UI that provides comprehensive views across alert types and tools. The UI -allows you to manage all your alerts and connector configurations in one -place and view the active alert instances. Alerts and Actions works along side <>. -Refer to {kibana-ref}/alerting-getting-started.html[Alerts and Actions]. +A comprehensive view of all your alerts. Enables you to access and +manage alerts for all {kib} apps from one place. +See {kibana-ref}/alerting-getting-started.html[Alerts and Actions]. // end::alerts-and-actions-def[] [[glossary-annotation]] annotation :: @@ -50,8 +50,10 @@ A way to augment a data display with descriptive domain knowledge. [[glossary-app]] app :: // tag::app-def[] -A experience within Kibana that has a user interface and appears in the side navigation. An app may contain UIs, -such as Inspect in Maps, or tabs, such as Metrics Explorer in Metrics. +A top-level {kib} component that is accessed through the side navigation. +Apps include core {kib} components such as Discover and Dashboard, +solutions like Observability and Security, and special-purpose tools +like Maps and Stack Management. // end::app-def[] @@ -64,14 +66,10 @@ such as Inspect in Maps, or tabs, such as Metrics Explorer in Metrics. The background detail necessary to orient the location of a map. // end::basemap-def[] -[[glossary-blocklist]] block list :: -// tag::blocklist-def[] -A filtering rule that excludes one or more members from a set. -// end::blocklist-def[] - [[glossary-bucket]] bucket :: // tag::bucket-def[] -In {es}, a set of documents based on a certain criterion. +A set of documents that have certain characteristics in common. +For example, matching documents might be bucketed by color, distance, or date range. // end::bucket-def[] [[glossary-bucket-aggregation]] bucket aggregation:: @@ -87,8 +85,8 @@ in the current context falls into the bucket. [[glossary-canvas]] Canvas :: // tag::canvas-def[] -An app that enables you to create presentations and infographics that pull live data directly from {es}. -Refer to {kibana-ref}/canvas.html[Canvas]. +Enables you to create presentations and infographics that pull live data directly from {es}. +See {kibana-ref}/canvas.html[Canvas]. // end::canvas-def[] [[glossary-canvas-language]] Canvas expression language:: @@ -96,34 +94,33 @@ Refer to {kibana-ref}/canvas.html[Canvas]. A pipeline-based expression language for manipulating and visualizing data. Includes dozens of functions and other capabilities, such as table transforms, type casting, and sub-expressions. Supports TinyMath functions for complex math calculations. -Refer to {kibana-ref}/canvas-function-reference.html[Canvas function reference]. +See {kibana-ref}/canvas-function-reference.html[Canvas function reference]. // end::canvas-language-def[] [[glossary-certainty]] certainty :: // tag::certainty-def[] Specifies how many documents must contain a pair of terms before it is considered -to be a useful connection in a graph. +a useful connection in a graph. // end::certainty-def[] [[glossary-condition]] condition :: // tag::condition-def[] -The logic and customizable variables for when an alert should fire. +Specifies the circumstances that must be met to trigger an alert. // end::condition-def[] [[glossary-connector]] connector :: // tag::connector-def[] -A configuration UI with a service API, credentials, and -other information that enables integration with an external system (the destination for an action). -Refer to {kibana-ref}/action-types.html[Action and connector types]. +A configuration that enables integration with an external system (the destination for an action). +See {kibana-ref}/action-types.html[Action and connector types]. // end::connector-def[] [[glossary-console]] Console :: // tag::console-def[] -A tool for interacting with the REST API of Elasticsearch. +A tool for interacting with the {es} REST API. You can send requests to Elasticsearch, view responses, view API documentation, and get your request history. -Refer to {kibana-ref}/console-kibana.html[Console]. +See {kibana-ref}/console-kibana.html[Console]. // end::console-def[] [float] @@ -132,10 +129,10 @@ Refer to {kibana-ref}/console-kibana.html[Console]. [[glossary-dashboard]] dashboard :: // tag::dashboard-def[] -A collection of panels that contain elements such as +A collection of <>, <>, and -<>. -Provides insights into your data from multiple perspectives. +<> that +provide insights into your data from multiple perspectives. // end::dashboard-def[] [[glossary-data-source]] data source :: @@ -145,13 +142,16 @@ A file, database, or service that provides the underlying data for a map, Canvas [[glossary-discover]] Discover :: // tag::discover-def[] -An app for searching and filtering your data so that you can narrow it down to -the subset of data that you are interested in. +Enables you to search and filter your data to zoom in on the information +that you are interested in. // end::discover-def[] [[glossary-drilldown]] drilldown :: // tag::drilldown-def[] -A custom navigation path between apps. Refer to {kibana-ref}/drilldowns.html[Drilldowns]. +A navigation path that retains context (time range and filters) +from the source to the destination, so you can view the data from a new perspective. +For example, a dashboard that shows the overall status of multiple data center +might have a drilldown to a dashboard for a single data center. See {kibana-ref}/drilldowns.html[Drilldowns]. // end::drilldown-def[] @@ -162,15 +162,15 @@ A custom navigation path between apps. Refer to {kibana-ref}/drilldowns.html[Dri [[glossary-edge]] edge :: // tag::edge-def[] -In a graph, the links (often lines) between nodes that denote a relationship. -The width of the edges represents the strength of the relationship. Refer to +A connection between nodes in a graph that shows that they are related. +The line weight indicates the strength of the relationship. See {kibana-ref}/xpack-graph.html[Graph]. // end::edge-def[] [[glossary-ems]] Elastic Maps Service (EMS) :: // tag::ems-def[] -A service that serves basemap tiles, shape files, and other key features +A service that provides basemap tiles, shape files, and other key features that are essential for visualizing geospatial data. // end::ems-def[] @@ -186,11 +186,9 @@ A <> workpad object that displays an image, text, or vis [[glossary-feature-controls]] Feature Controls :: // tag::feature-controls-def[] -A UI that enables administrators to customize which features are -available in each <>. You can use Feature Controls -to customize the navigation bar per space and make certain -features available or not within each given space. Refer to -{kibana-ref}//xpack-spaces.html#spaces-control-feature-visibility[Control feature access]. +Enables administrators to customize which features are +available in each <>. See +{kibana-ref}//xpack-spaces.html#spaces-control-feature-visibility[Feature Controls]. // end::feature-controls-def[] [float] @@ -201,13 +199,13 @@ features available or not within each given space. Refer to // tag::graph-def[] A data structure and visualization that shows interconnections between a set of entities. Each entity is represented by a node. Connections between -nodes are represented by <>. +nodes are represented by <>. See {kibana-ref}/xpack-graph.html[Graph]. // end::graph-def[] [[glossary-grok-debugger]] Grok Debugger :: // tag::grok-debugger-def[] -A tool for building and debugging grok patterns. Grok is good for parsing logs, -such as syslog, Apache, and other webserver logs. Refer to +A tool for building and debugging grok patterns. Grok is good for parsing +syslog, Apache, and other webserver logs. See {kibana-ref}/xpack-grokdebugger.html[Debugging grok expressions]. // end::grok-debugger-def[] @@ -234,7 +232,7 @@ such as syslog, Apache, and other webserver logs. Refer to [[glossary-kql]] {kib} Query Language (KQL) :: // tag::kql-def[] The default language for querying in {kib}. KQL provides -support for scripted fields. Refer to +support for scripted fields. See {kibana-ref}/kuery-query.html[Kibana Query Language]. // end::kql-def[] @@ -247,22 +245,22 @@ support for scripted fields. Refer to // tag::lens-def[] Enables you to quickly build visualizations by dragging and dropping data fields. Lens makes makes smart visualization suggestions for your data, -allowing you to quickly switch between visualization types. Refer to -{kibana-ref}/lens.html[Lens]. +allowing you to quickly switch between visualization types. +See {kibana-ref}/lens.html[Lens]. // end::lens-def[] [[glossary-lucene]] Lucene query syntax :: // tag::lucene-def[] The query syntax for {kib}’s legacy query language. The Lucene query -syntax is available under the options menu in the query bar and from the -<>. +syntax is available under the options menu in the query bar and from +<>. // end::lucene-def[] [[glossary-license-management]] License Management :: // tag::license-management-def[] -A user interface in <> that allows you to view the status of your license, -start a trial, or install a new license. +Enables you to view the status of your license. Part of {kib} +<>. See {kibana-ref}/managing-licenses.html[License Management]. // end::license-management-def[] [float] @@ -272,12 +270,12 @@ start a trial, or install a new license. [[glossary-map]] map :: // tag::map-def[] A representation of geographic data using symbols and labels. -Refer to {kibana-ref}/maps.html[Maps]. +See {kibana-ref}/maps.html[Maps]. // end::map-def[] [[glossary-metric-aggregation]] metric aggregation :: // tag::metric-aggregation-def[] -An aggregation that keeps track of and computes metrics over a set of documents. +An aggregation that calculates and tracks metrics for a set of documents. // end::metric-aggregation-def[] @@ -296,13 +294,13 @@ An aggregation that keeps track of and computes metrics over a set of documents. [[glossary-painless-lab]] Painless Lab :: // tag::painless-lab-def[] An interactive code editor that lets you test and debug Painless scripts in real-time. -Refer to {kibana-ref}/painlesslab.html[Painless Lab]. +See {kibana-ref}/painlesslab.html[Painless Lab]. // end::painless-lab-def[] [[glossary-panel]] panel :: // tag::panel-def[] -A module in a <> that can contain a +A <> component that contains a query element or visualization, such as a chart, table, or list. // end::panel-def[] @@ -313,14 +311,14 @@ query element or visualization, such as a chart, table, or list. [[glossary-query-bar]] query bar :: // tag::query-bar-def[] -The text field where you enter a query expression to +The text field where you enter a query expression to retrieve the data you want to interact with. // end::query-bar-def[] [[glossary-query-profiler]] Query Profiler :: // tag::query-profiler-def[] -A tool that enables you to inspect and analyze search queries to diagnose and debug poorly performing queries. -Refer to {kibana-ref}/xpack-profiler.html[Query Profiler]. +A tool that enables you to inspect and analyze search queries to diagnose and debug poorly performing queries. +See {kibana-ref}/xpack-profiler.html[Query Profiler]. // end::query-profiler-def[] @@ -335,8 +333,8 @@ Refer to {kibana-ref}/xpack-profiler.html[Query Profiler]. [[glossary-saved-object]] saved object :: // tag::saved-object-def[] -An object that stores data for later use. A saved object can be a -dashboard, visualization, map, index pattern, or Canvas workpad. +A representation of a dashboard, visualization, map, index pattern, or Canvas workpad +that can be stored and reloaded. // end::saved-object-def[] [[glossary-saved-search]] saved search :: @@ -353,7 +351,7 @@ Scripted field data is shown in Discover and used in visualizations. [[glossary-shareable]] shareable :: // tag::shareable-def[] -A Canvas workpad that can be embedded on any webpage. +A Canvas workpad that can be embedded on any webpage. Shareables enable you to display Canvas visualizations on internal wiki pages or public websites. // end::shareable-def[] @@ -366,7 +364,7 @@ For example, you might have different spaces for each team, use case, or individ [[glossary-feature-space]] Spaces :: // tag::space-feature-def[] -A feature that allows you to organize your saved objects into meaningful categories. Refer to +A feature that allows you to organize your saved objects into meaningful categories. See {kibana-ref}/xpack-spaces.html[Spaces]. // end::space-feature-def[] @@ -374,14 +372,14 @@ A feature that allows you to organize your saved objects into meaningful categor // tag::stack-monitoring-def[] Features that enable you to monitor the Elastic Stack, including health and performance data for {es}, Logstash, and Beats. You can also monitor {kib} -and route that data to the monitoring cluster. Refer to +and route that data to the monitoring cluster. See {kibana-ref}/xpack-monitoring.html[Stack Monitoring]. // end::stack-monitoring-def[] [[glossary-management]] Stack Management :: // tag::management-def[] -The home for managing the Elastic Stack — indices, clusters, licenses, UI settings, -index patterns, spaces, and more. Refer to +The home for managing the Elastic Stack—indices, clusters, licenses, UI settings, +index patterns, spaces, and more. See {kibana-ref}/management.html[Stack Management]. // end::management-def[] @@ -405,7 +403,7 @@ A control that constrains the search results to a particular time period. [[glossary-timelion]] Timelion :: // tag::timelion-def[] A tool for building a time series visualization that analyzes data in time order. -Refer to {kibana-ref}/timelion.html[Timelion]. +See {kibana-ref}/timelion.html[Timelion]. // end::timelion-def[] @@ -419,7 +417,7 @@ Timestamped data such as logs, metrics, and events that is indexed on an ongoing // tag::TSVB-def[] A time series data visualizer that allows you to combine an infinite number of aggregations to display complex data. -Refer to {kibana-ref}/TSVB.html[TSVB]. +See {kibana-ref}/TSVB.html[TSVB]. // end::TSVB-def[] @@ -429,9 +427,9 @@ Refer to {kibana-ref}/TSVB.html[TSVB]. [[glossary-upgrade-assistant]] Upgrade Assistant :: // tag::upgrade-assistant-def[] -A feature that helps prepare you for an upgrade to the next major version of +A tool that helps you prepare for an upgrade to the next major version of {es}. The assistant identifies the deprecated settings in your cluster and -indices and guides you through resolving issues, including reindexing. Refer to +indices and guides you through resolving issues, including reindexing. See {kibana-ref}/upgrade-assistant.html[Upgrade Assistant]. // end::upgrade-assistant-def[] @@ -443,10 +441,10 @@ indices and guides you through resolving issues, including reindexing. Refer to [[glossary-vega]] Vega :: // tag::vega-def[] A declarative language used to create interactive visualizations. -Refer to {kibana-ref}/vega-graph.html[Vega]. +See {kibana-ref}/vega-graph.html[Vega]. // end::vega-def[] -[[glossary-vector]] vector :: +[[glossary-vector]] vector data:: // tag::vector-def[] Points, lines, and polygons used to represent a map. // end::vector-def[] @@ -463,13 +461,13 @@ A graphical representation of query results (e.g., a histogram, line graph, pie [[glossary-watcher]] Watcher :: // tag::watcher-def[] The original suite of alerting features. -Refer to +See {kibana-ref}/watcher-ui.html[Watcher]. // end::watcher-def[] [[glossary-workpad]] workpad :: // tag::workpad-def[] A workspace where you build presentations of your live data in <>. -Refer to +See {kibana-ref}/create-canvas-workpad.html[Create a workpad]. // end::workpad-def[] From bf1cbc64dc94deec990cd487c89d62822a5b0941 Mon Sep 17 00:00:00 2001 From: gchaps <33642766+gchaps@users.noreply.github.com> Date: Fri, 26 Jun 2020 10:48:22 -0700 Subject: [PATCH 24/32] Update docs/glossary.asciidoc Co-authored-by: Lisa Cawley --- docs/glossary.asciidoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/glossary.asciidoc b/docs/glossary.asciidoc index 8ad2a13ea1078..50ab3933dc983 100644 --- a/docs/glossary.asciidoc +++ b/docs/glossary.asciidoc @@ -68,7 +68,7 @@ The background detail necessary to orient the location of a map. [[glossary-bucket]] bucket :: // tag::bucket-def[] -A set of documents that have certain characteristics in common. +A set of documents in {kib} that have certain characteristics in common. For example, matching documents might be bucketed by color, distance, or date range. // end::bucket-def[] From 545a35b5ce3209c86f6ed9a616bc7cc7aeab1d6b Mon Sep 17 00:00:00 2001 From: gchaps <33642766+gchaps@users.noreply.github.com> Date: Fri, 26 Jun 2020 10:48:40 -0700 Subject: [PATCH 25/32] Update docs/glossary.asciidoc Co-authored-by: Lisa Cawley --- docs/glossary.asciidoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/glossary.asciidoc b/docs/glossary.asciidoc index 50ab3933dc983..7ae3509a66654 100644 --- a/docs/glossary.asciidoc +++ b/docs/glossary.asciidoc @@ -118,7 +118,7 @@ See {kibana-ref}/action-types.html[Action and connector types]. [[glossary-console]] Console :: // tag::console-def[] A tool for interacting with the {es} REST API. -You can send requests to Elasticsearch, view responses, +You can send requests to {es}, view responses, view API documentation, and get your request history. See {kibana-ref}/console-kibana.html[Console]. // end::console-def[] From 0b4400d57fc7c62221ee71108c2d2b7d17ab1642 Mon Sep 17 00:00:00 2001 From: gchaps <33642766+gchaps@users.noreply.github.com> Date: Fri, 26 Jun 2020 10:49:29 -0700 Subject: [PATCH 26/32] Update docs/glossary.asciidoc Co-authored-by: Lisa Cawley --- docs/glossary.asciidoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/glossary.asciidoc b/docs/glossary.asciidoc index 7ae3509a66654..0d30b0b4bf6c8 100644 --- a/docs/glossary.asciidoc +++ b/docs/glossary.asciidoc @@ -312,7 +312,7 @@ query element or visualization, such as a chart, table, or list. [[glossary-query-bar]] query bar :: // tag::query-bar-def[] The text field where you enter a query expression to -retrieve the data you want to interact with. +retrieve the data you want to interact with in {kib}. // end::query-bar-def[] [[glossary-query-profiler]] Query Profiler :: From 6deb3c9d7e1c77f630cf410f3d353f67cb5ec2dc Mon Sep 17 00:00:00 2001 From: gchaps <33642766+gchaps@users.noreply.github.com> Date: Fri, 26 Jun 2020 10:50:55 -0700 Subject: [PATCH 27/32] Update docs/glossary.asciidoc Co-authored-by: Lisa Cawley --- docs/glossary.asciidoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/glossary.asciidoc b/docs/glossary.asciidoc index 0d30b0b4bf6c8..bf15dc4168acb 100644 --- a/docs/glossary.asciidoc +++ b/docs/glossary.asciidoc @@ -397,7 +397,7 @@ properties for data-driven styling and rich tooltip content in maps. [[glossary-time-filter]] time filter :: // tag::time-filter-def[] -A control that constrains the search results to a particular time period. +A {kib} control that constrains the search results to a particular time period. // end::time-filter-def[] [[glossary-timelion]] Timelion :: From e4f4502a997b00f98b83b4c82cc66cf87578ccd4 Mon Sep 17 00:00:00 2001 From: gchaps <33642766+gchaps@users.noreply.github.com> Date: Fri, 26 Jun 2020 10:51:24 -0700 Subject: [PATCH 28/32] Update docs/glossary.asciidoc Co-authored-by: Lisa Cawley --- docs/glossary.asciidoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/glossary.asciidoc b/docs/glossary.asciidoc index bf15dc4168acb..d4a1c2668aa88 100644 --- a/docs/glossary.asciidoc +++ b/docs/glossary.asciidoc @@ -451,7 +451,7 @@ Points, lines, and polygons used to represent a map. [[glossary-visualization]] visualization :: // tag::visualization-def[] -A graphical representation of query results (e.g., a histogram, line graph, pie chart, or heat map). +A graphical representation of query results in {kib} (e.g., a histogram, line graph, pie chart, or heat map). // end::visualization-def[] [float] From 52b77d42cc13487d09671769f2030950903b3439 Mon Sep 17 00:00:00 2001 From: gchaps <33642766+gchaps@users.noreply.github.com> Date: Fri, 26 Jun 2020 10:53:41 -0700 Subject: [PATCH 29/32] Update docs/glossary.asciidoc Co-authored-by: Lisa Cawley --- docs/glossary.asciidoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/glossary.asciidoc b/docs/glossary.asciidoc index d4a1c2668aa88..d72a4853906af 100644 --- a/docs/glossary.asciidoc +++ b/docs/glossary.asciidoc @@ -370,7 +370,7 @@ A feature that allows you to organize your saved objects into meaningful categor [[glossary-stack-monitoring]] Stack Monitoring :: // tag::stack-monitoring-def[] -Features that enable you to monitor the Elastic Stack, including health and +A {kib} app that enables you to monitor the {stack}, including health and performance data for {es}, Logstash, and Beats. You can also monitor {kib} and route that data to the monitoring cluster. See {kibana-ref}/xpack-monitoring.html[Stack Monitoring]. From 7a133a0accfa7403d9b6f1d065fd12dbffa8c98f Mon Sep 17 00:00:00 2001 From: gchaps <33642766+gchaps@users.noreply.github.com> Date: Fri, 26 Jun 2020 10:56:11 -0700 Subject: [PATCH 30/32] Update docs/glossary.asciidoc Co-authored-by: Lisa Cawley --- docs/glossary.asciidoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/glossary.asciidoc b/docs/glossary.asciidoc index d72a4853906af..0245fbb14e029 100644 --- a/docs/glossary.asciidoc +++ b/docs/glossary.asciidoc @@ -378,7 +378,7 @@ and route that data to the monitoring cluster. See [[glossary-management]] Stack Management :: // tag::management-def[] -The home for managing the Elastic Stack—indices, clusters, licenses, UI settings, +A {kib} app for managing the {stack} —indices, clusters, licenses, UI settings, index patterns, spaces, and more. See {kibana-ref}/management.html[Stack Management]. // end::management-def[] From 6e5c9f498a1ddc2ce2e5e8c61f1bb25f3b8e05ad Mon Sep 17 00:00:00 2001 From: gchaps Date: Fri, 26 Jun 2020 11:46:41 -0700 Subject: [PATCH 31/32] [DOCS] Incorporates review comments --- docs/glossary.asciidoc | 31 +++---------------------------- 1 file changed, 3 insertions(+), 28 deletions(-) diff --git a/docs/glossary.asciidoc b/docs/glossary.asciidoc index 0245fbb14e029..4faef39e50216 100644 --- a/docs/glossary.asciidoc +++ b/docs/glossary.asciidoc @@ -24,7 +24,7 @@ See // tag::advanced-settings-def[] Enables you to control the appearance and behavior of {kib} by setting the date format, default index, and other attributes. -Part of {kib} <>. +Part of {kib} Stack Management. See {kibana-ref}/advanced-options.html[Advanced Settings]. // end::advanced-settings-def[] @@ -257,12 +257,6 @@ syntax is available under the options menu in the query bar and from <>. // end::lucene-def[] -[[glossary-license-management]] License Management :: -// tag::license-management-def[] -Enables you to view the status of your license. Part of {kib} -<>. See {kibana-ref}/managing-licenses.html[License Management]. -// end::license-management-def[] - [float] [[m_glos]] == M @@ -360,28 +354,9 @@ Shareables enable you to display Canvas visualizations on internal wiki pages or A place for organizing <>, <>, and other <> by category. For example, you might have different spaces for each team, use case, or individual. -// end::space-def[] - -[[glossary-feature-space]] Spaces :: -// tag::space-feature-def[] -A feature that allows you to organize your saved objects into meaningful categories. See +See {kibana-ref}/xpack-spaces.html[Spaces]. -// end::space-feature-def[] - -[[glossary-stack-monitoring]] Stack Monitoring :: -// tag::stack-monitoring-def[] -A {kib} app that enables you to monitor the {stack}, including health and -performance data for {es}, Logstash, and Beats. You can also monitor {kib} -and route that data to the monitoring cluster. See -{kibana-ref}/xpack-monitoring.html[Stack Monitoring]. -// end::stack-monitoring-def[] - -[[glossary-management]] Stack Management :: -// tag::management-def[] -A {kib} app for managing the {stack} —indices, clusters, licenses, UI settings, -index patterns, spaces, and more. See -{kibana-ref}/management.html[Stack Management]. -// end::management-def[] +// end::space-def[] [float] From 9b10cabd62a80998de3e50d209e9488e185085d1 Mon Sep 17 00:00:00 2001 From: gchaps Date: Mon, 29 Jun 2020 17:41:23 -0700 Subject: [PATCH 32/32] [DOCS] Incorporates review comments --- docs/glossary.asciidoc | 43 ++++-------------------------------------- docs/index.asciidoc | 2 -- 2 files changed, 4 insertions(+), 41 deletions(-) diff --git a/docs/glossary.asciidoc b/docs/glossary.asciidoc index 4faef39e50216..d7a82068abbcb 100644 --- a/docs/glossary.asciidoc +++ b/docs/glossary.asciidoc @@ -2,7 +2,7 @@ [[glossary]] = Glossary -<> | <> | <> | <> | <> | <> | <> | <> | <> | <> | <> | <> | <> | <> | <> | <> | <> | <> | <> | <> | <> | V | <> | X | Y | Z +<> | <> | <> | <> | <> | <> | <> | H | I | J | <> | <> | <> | N | O | <> | <> | R | <> | <> | <> | V | <> | X | Y | Z [float] [[a_glos]] @@ -150,7 +150,7 @@ that you are interested in. // tag::drilldown-def[] A navigation path that retains context (time range and filters) from the source to the destination, so you can view the data from a new perspective. -For example, a dashboard that shows the overall status of multiple data center +A dashboard that shows the overall status of multiple data centers might have a drilldown to a dashboard for a single data center. See {kibana-ref}/drilldowns.html[Drilldowns]. // end::drilldown-def[] @@ -210,21 +210,6 @@ syslog, Apache, and other webserver logs. See // end::grok-debugger-def[] - -[float] -[[h_glos]] -== H - - - -[float] -[[i_glos]] -== I - -[float] -[[j_glos]] -== J - [float] [[k_glos]] == K @@ -243,9 +228,9 @@ support for scripted fields. See [[glossary-lens]] Lens :: // tag::lens-def[] -Enables you to quickly build visualizations by dragging and dropping data fields. +Enables you to build visualizations by dragging and dropping data fields. Lens makes makes smart visualization suggestions for your data, -allowing you to quickly switch between visualization types. +allowing you to switch between visualization types. See {kibana-ref}/lens.html[Lens]. // end::lens-def[] @@ -273,14 +258,6 @@ An aggregation that calculates and tracks metrics for a set of documents. // end::metric-aggregation-def[] -[float] -[[n_glos]] -== N - -[float] -[[o_glos]] -== O - [float] [[p_glos]] == P @@ -303,24 +280,12 @@ query element or visualization, such as a chart, table, or list. [[q_glos]] == Q -[[glossary-query-bar]] query bar :: -// tag::query-bar-def[] -The text field where you enter a query expression to -retrieve the data you want to interact with in {kib}. -// end::query-bar-def[] - [[glossary-query-profiler]] Query Profiler :: // tag::query-profiler-def[] A tool that enables you to inspect and analyze search queries to diagnose and debug poorly performing queries. See {kibana-ref}/xpack-profiler.html[Query Profiler]. // end::query-profiler-def[] - - -[float] -[[r_glos]] -== R - [float] [[s_glos]] == S diff --git a/docs/index.asciidoc b/docs/index.asciidoc index d0d76dcbff92a..66ad2f7ec306a 100644 --- a/docs/index.asciidoc +++ b/docs/index.asciidoc @@ -28,6 +28,4 @@ include::CHANGELOG.asciidoc[] include::developer/index.asciidoc[] -include::glossary.asciidoc[] - include::redirects.asciidoc[]