Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[DOCS] Adds glossary to documentation #69721

Merged
merged 32 commits into from
Jun 30, 2020
Merged
Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
32 commits
Select commit Hold shift + click to select a range
16a967b
[DOCS] Adds glossary to documentation
gchaps Jun 23, 2020
4cfacc6
[DOCS] Fixes build errors
gchaps Jun 23, 2020
8e328aa
Update docs/glossary.asciidoc
gchaps Jun 24, 2020
e591a91
Update docs/glossary.asciidoc
gchaps Jun 24, 2020
1ee1f4f
Update docs/glossary.asciidoc
gchaps Jun 24, 2020
cadd787
Update docs/glossary.asciidoc
gchaps Jun 24, 2020
6df1f39
Update docs/glossary.asciidoc
gchaps Jun 24, 2020
bd4a9a4
Update docs/glossary.asciidoc
gchaps Jun 24, 2020
3d3ea7b
Update docs/glossary.asciidoc
gchaps Jun 24, 2020
489e998
Update docs/glossary.asciidoc
gchaps Jun 24, 2020
7a06c22
Update docs/glossary.asciidoc
gchaps Jun 24, 2020
6a8d3d9
Update docs/glossary.asciidoc
gchaps Jun 24, 2020
6f2e6fa
[DOCS] Adds more terms to glossary
gchaps Jun 25, 2020
843be4f
[DOCS] Adds more terms to glossary
gchaps Jun 25, 2020
3a25448
Update docs/glossary.asciidoc
gchaps Jun 26, 2020
7391a3f
Update docs/glossary.asciidoc
gchaps Jun 26, 2020
7b2d6a3
Update docs/glossary.asciidoc
gchaps Jun 26, 2020
b0ca38b
Update docs/glossary.asciidoc
gchaps Jun 26, 2020
a00a48a
Update docs/glossary.asciidoc
gchaps Jun 26, 2020
65212de
Update docs/glossary.asciidoc
gchaps Jun 26, 2020
6098db4
Update docs/glossary.asciidoc
gchaps Jun 26, 2020
73ea951
Update docs/glossary.asciidoc
gchaps Jun 26, 2020
654fbcd
[DOCS] Incorporates review comments
gchaps Jun 26, 2020
bf1cbc6
Update docs/glossary.asciidoc
gchaps Jun 26, 2020
545a35b
Update docs/glossary.asciidoc
gchaps Jun 26, 2020
0b4400d
Update docs/glossary.asciidoc
gchaps Jun 26, 2020
6deb3c9
Update docs/glossary.asciidoc
gchaps Jun 26, 2020
e4f4502
Update docs/glossary.asciidoc
gchaps Jun 26, 2020
52b77d4
Update docs/glossary.asciidoc
gchaps Jun 26, 2020
7a133a0
Update docs/glossary.asciidoc
gchaps Jun 26, 2020
6e5c9f4
[DOCS] Incorporates review comments
gchaps Jun 26, 2020
9b10cab
[DOCS] Incorporates review comments
gchaps Jun 30, 2020
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
329 changes: 329 additions & 0 deletions docs/glossary.asciidoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,329 @@
[glossary]
[[glossary]]
= Glossary of terms

<<a_glos>> | <<b_glos>> | <<c_glos>> | <<d_glos>> | <<e_glos>> | <<f_glos>> | <<g_glos>> | <<h_glos>> | <<i_glos>> | <<j_glos>> | <<k_glos>> | <<l_glos>> | <<m_glos>> | <<n_glos>> | <<o_glos>> | <<p_glos>> | <<q_glos>> | <<r_glos>> | <<s_glos>> | <<t_glos>> | <<u_glos>> | V | <<w_glos>> | 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 <<glossary-watcher,Watcher>>.
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
gchaps marked this conversation as resolved.
Show resolved Hide resolved
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
gchaps marked this conversation as resolved.
Show resolved Hide resolved
(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[]

[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 ::
gchaps marked this conversation as resolved.
Show resolved Hide resolved
// tag::blocklist-def[]
A filtering rule that excludes one or more members from a set.
// end::blocklist-def[]


[float]
[[c_glos]]
== C

[[glossary-certainty-map]] certainty ::
gchaps marked this conversation as resolved.
Show resolved Hide resolved
// 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[]


[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 ::
gchaps marked this conversation as resolved.
Show resolved Hide resolved
// tag::data-source-def[]
gchaps marked this conversation as resolved.
Show resolved Hide resolved
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[]
gchaps marked this conversation as resolved.
Show resolved Hide resolved

[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

[float]
[[g_glos]]
== G

[[glossary-GeoJSON]] GeoJSON ::
gchaps marked this conversation as resolved.
Show resolved Hide resolved
// tag::GeoJSON-def[]
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
// tag::GeoJSON-def[]
// tag::geojson-def[]

An open-standard file format for storing geospatial vector data.
// end::GeoJSON-def[]
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I haven't tested whether this is a hard requirement, but I think it's a good idea to avoid introducing mixed cases in these link and tagged section labels

Suggested change
// end::GeoJSON-def[]
// end::geojson-def[]



[float]
[[h_glos]]
== H

[[glossary-heat map]] heat map ::
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
[[glossary-heat map]] heat map ::
[[glossary-heat-map]] heat map ::

// tag::GeoJSON-def[]
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
// tag::GeoJSON-def[]
// tag::heat-map-def[]

A geographic visualization in which point data is clustered to show locations with higher densities.
// end::GeoJSON-def[]
gchaps marked this conversation as resolved.
Show resolved Hide resolved


[float]
[[i_glos]]
== I

[float]
[[j_glos]]
== J

[float]
[[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
<<glossary-advanced-settings,Advanced Settings UI>>.
// 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 <<glossary-map,map>>.
// 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

[float]
[[o_glos]]
== O

[float]
[[p_glos]]
== P

[float]
[[q_glos]]
== Q

[[glossary-query-bar]] space ::
gchaps marked this conversation as resolved.
Show resolved Hide resolved
// 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.
gchaps marked this conversation as resolved.
Show resolved Hide resolved
// end::query-bar-def[]


[float]
[[r_glos]]
== R

[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
gchaps marked this conversation as resolved.
Show resolved Hide resolved
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.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think this is another object that can only be used within the UI?

Suggested change
saved for later retrieval and reuse.
saved for later retrieval and reuse in {kib}.

// 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]] Spaces ::
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Spaces

In general I don't think we've defined all the "features" in the glossary. Given that you've defined "space", I question whether this entry is useful. If necessary, you can add the xpack-spaces.html link in the "space" definition.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The feature definitions are kind of awkward--it would be nice if it's possible to make this approach work.

// tag::space-feature-def[]
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[]

[[glossary-stack-monitoring]] Stack Monitoring ::
// tag::stack-monitoring-def[]
Features that enable you to monitor the Elastic Stack, including health and
gchaps marked this conversation as resolved.
Show resolved Hide resolved
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

[[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.
gchaps marked this conversation as resolved.
Show resolved Hide resolved
// end::time-filter-def[]

[[glossary-time-series-data]] time series data ::
// tag::time-series-data[]
gchaps marked this conversation as resolved.
Show resolved Hide resolved
A control that constrains the search results to a particular time period.
// end::time-series-data[]
gchaps marked this conversation as resolved.
Show resolved Hide resolved



[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
gchaps marked this conversation as resolved.
Show resolved Hide resolved
{es}. The assistant identifies the deprecated settings in your cluster and
indices and guides you through resolving issues, including reindexing. Refer to
{kibana-ref}/upgrade-assistant.html[Upgrade Assistant].
// end::upgrade-assistant-def[]


[float]
[[v_glos]]
== V

[[glossary-vector]] vector ::
gchaps marked this conversation as resolved.
Show resolved Hide resolved
// tag::vector-def[]
Points, lines, and polygons used to represent a map.
// end::vector-def[]

[[glossary-visualzation]] visualization ::
// tag::visualzation-def[]
gchaps marked this conversation as resolved.
Show resolved Hide resolved
A graphical representation of query results (e.g., a histogram, line graph, pie chart, or heat map).
gchaps marked this conversation as resolved.
Show resolved Hide resolved
// end::visualization-def[]


[float]
[[w_glos]]
== W

[[glossary-watcher]] Watcher ::
// tag::watcher-def[]
The original suite of alerting features.
Refer to
{kibana-ref}/watcher.html[Watcher].
// end::watcher-def[]
2 changes: 2 additions & 0 deletions docs/index.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -28,4 +28,6 @@ include::CHANGELOG.asciidoc[]

include::developer/index.asciidoc[]

include::glossary.asciidoc[]

include::redirects.asciidoc[]