mirror of
https://github.com/elastic/kibana.git
synced 2025-04-23 17:28:26 -04:00
[DOCS] Fixes titles in Discover, Graph, & Install for consistency (#68685)
* [DOCS] Fixes titles in Discover, Graph, & Install for consistency * [DOCS] More docs tweaks for consistency
This commit is contained in:
gchaps
GitHub
parent
a462e2c7b0
commit
4b620616bc
18 changed files with 54 additions and 35 deletions
|
|
@ -1,5 +1,5 @@
|
|||
[[document-context]]
|
||||
== Viewing a document in context
|
||||
== View a document in context
|
||||
|
||||
Once you've narrowed your search to a specific event,
|
||||
you might want to inspect the documents that occurred
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
[[document-data]]
|
||||
== Viewing document data
|
||||
== View document data
|
||||
|
||||
When you submit a search query in *Discover*, the most recent documents that match the query
|
||||
are listed in the documents table.
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
[[field-filter]]
|
||||
== Filtering by field
|
||||
== Filter by field
|
||||
|
||||
*Discover* offers
|
||||
various types of filters, so you can restrict your documents to the exact data you want.
|
||||
|
|
|
|||
|
|
@ -5,7 +5,7 @@ In Kibana 6.3, we introduced a number of exciting experimental query language en
|
|||
features are now available by default in 7.0. Out of the box, Kibana's query language now includes scripted field support and a
|
||||
simplified, easier to use syntax. If you have a Basic license or above, autocomplete functionality will also be enabled.
|
||||
|
||||
==== Language Syntax
|
||||
==== Language syntax
|
||||
|
||||
If you're familiar with Kibana's old Lucene query syntax, you should feel right at home with the new syntax. The basics
|
||||
stay the same, we've simply refined things to make the query language easier to use.
|
||||
|
|
@ -72,7 +72,7 @@ set these terms will be matched against all fields. For example, a query for `re
|
|||
in the response field, but a query for just `200` will search for 200 across all fields in your index.
|
||||
============
|
||||
|
||||
==== Nested Field Support
|
||||
==== Nested field support
|
||||
|
||||
KQL supports querying on {ref}/nested.html[nested fields] through a special syntax. You can query nested fields in subtly different
|
||||
ways, depending on the results you want, so crafting nested queries requires extra thought.
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
[[search]]
|
||||
== Searching your data
|
||||
== Search data
|
||||
Many Kibana apps embed a query bar for real-time search, including
|
||||
*Discover*, *Visualize*, and *Dashboard*.
|
||||
|
||||
|
|
@ -83,14 +83,14 @@ query language you can also submit queries using the {ref}/query-dsl.html[Elasti
|
|||
|
||||
|
||||
[[save-open-search]]
|
||||
=== Saving searches
|
||||
=== Save a search
|
||||
A saved search persists your current view of Discover for later retrieval and reuse. You can reload a saved search into Discover, add it to a dashboard, and use it as the basis for a <<visualize, visualization>>.
|
||||
|
||||
A saved search includes the query text, filters, and optionally, the time filter. A saved search also includes the selected columns in the document table, the sort order, and the current index pattern.
|
||||
|
||||
[role="xpack"]
|
||||
[[discover-read-only-access]]
|
||||
==== Read only access
|
||||
==== Read-only access
|
||||
When you have insufficient privileges to save searches, the following indicator in Kibana will be
|
||||
displayed and the *Save* button won't be visible. For more information on granting access to
|
||||
Kibana see <<xpack-security-authorization>>.
|
||||
|
|
@ -117,7 +117,7 @@ selected, opening the saved search changes the selected index pattern. The query
|
|||
used for the saved search will also be automatically selected.
|
||||
|
||||
[[save-load-delete-query]]
|
||||
=== Saving queries
|
||||
=== Save a query
|
||||
A saved query is a portable collection of query text and filters that you can reuse in <<discover, Discover>>, <<visualize, Visualize>>, and <<dashboard, Dashboard>>. Save a query when you want to:
|
||||
|
||||
* Retrieve results from the same query at a later time without having to reenter the query text, add the filters or set the time filter
|
||||
|
|
@ -127,7 +127,7 @@ A saved query is a portable collection of query text and filters that you can re
|
|||
Saved queries don't include information specific to Discover, such as the currently selected columns in the document table, the sort order, and the index pattern. If you want to save your current view of Discover for later retrieval and reuse, create a <<save-open-search, saved search>> instead.
|
||||
|
||||
[role="xpack"]
|
||||
==== Read only access
|
||||
==== Read-only access
|
||||
If you have insufficient privileges to save queries, the *Save current query* button isn't visible in the saved query management popover. For more information, see <<xpack-security-authorization, Granting access to Kibana>>
|
||||
|
||||
==== Save a query
|
||||
|
|
|
|||
|
|
@ -1,39 +1,39 @@
|
|||
[[set-time-filter]]
|
||||
== Setting the time filter
|
||||
If your index contains time-based events, and a time-field is configured for the
|
||||
== Set the time filter
|
||||
If your index contains time-based events, and a time-field is configured for the
|
||||
selected <<index-patterns, index pattern>>, set a time filter that displays only the data within the
|
||||
specified time range.
|
||||
|
||||
You can use the time filter to change the time range, or select a specific time
|
||||
You can use the time filter to change the time range, or select a specific time
|
||||
range in the histogram.
|
||||
|
||||
[float]
|
||||
[[use-time-filter]]
|
||||
=== Use the time filter
|
||||
|
||||
Use the time filter to change the time range. By default, the time filter is set
|
||||
Use the time filter to change the time range. By default, the time filter is set
|
||||
to the last 15 minutes.
|
||||
|
||||
. Click image:images/time-filter-calendar.png[].
|
||||
. Click image:images/time-filter-calendar.png[].
|
||||
|
||||
. Choose one of the following:
|
||||
|
||||
* *Quick select* to use a recent time range, then use the back and forward
|
||||
* *Quick select* to use a recent time range, then use the back and forward
|
||||
arrows to move through the time ranges.
|
||||
|
||||
* *Commonly used* to use a time range from options such as *Last 15 minutes*,
|
||||
|
||||
* *Commonly used* to use a time range from options such as *Last 15 minutes*,
|
||||
*Today*, and *Week to date*.
|
||||
|
||||
* *Recently used date ranges* to use a previously selected data range that
|
||||
|
||||
* *Recently used date ranges* to use a previously selected data range that
|
||||
you recently used.
|
||||
|
||||
|
||||
* *Refresh every* to specify an automatic refresh rate.
|
||||
+
|
||||
[role="screenshot"]
|
||||
image::images/Timepicker-View.png[Time filter menu]
|
||||
|
||||
. To set the start and end times, click the bar next to the time filter.
|
||||
In the popup, select *Absolute*, *Relative* or *Now*, then specify the required
|
||||
. To set the start and end times, click the bar next to the time filter.
|
||||
In the popup, select *Absolute*, *Relative* or *Now*, then specify the required
|
||||
options.
|
||||
+
|
||||
[role="screenshot"]
|
||||
|
|
@ -54,4 +54,3 @@ when you hover over a valid start point.
|
|||
|
||||
[role="screenshot"]
|
||||
image::images/Histogram-Time.png[Time range selector in Histogram]
|
||||
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
[[viewing-field-stats]]
|
||||
== Viewing Field Data Statistics
|
||||
== View field data statistics
|
||||
|
||||
From the fields list, you can see how many of the documents in the documents
|
||||
table contain a particular field, what the top 5 values are, and what
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
[[index-patterns]]
|
||||
== Creating an index pattern
|
||||
== Create an index pattern
|
||||
|
||||
To explore and visualize data in {kib}, you must create an index pattern.
|
||||
An index pattern tells {kib} which {es} indices contain the data that
|
||||
|
|
|
|||
|
|
@ -1,5 +1,9 @@
|
|||
[[docker]]
|
||||
=== Install Kibana with Docker
|
||||
=== Install {kib} with Docker
|
||||
++++
|
||||
<titleabbrev>Install with Docker </titleabbrev>
|
||||
++++
|
||||
|
||||
Docker images for Kibana are available from the Elastic Docker registry. The
|
||||
base image is https://hub.docker.com/_/centos/[centos:7].
|
||||
|
||||
|
|
|
|||
|
|
@ -1,5 +1,8 @@
|
|||
[[brew]]
|
||||
=== Install {kib} on macOS with Homebrew
|
||||
++++
|
||||
<titleabbrev>Install on macOS with Homebrew</titleabbrev>
|
||||
++++
|
||||
|
||||
Elastic publishes Homebrew formulae so you can install {kib} with the https://brew.sh/[Homebrew] package manager.
|
||||
|
||||
|
|
@ -44,7 +47,7 @@ and data directory are stored in the following locations.
|
|||
| conf
|
||||
| Configuration files including `kibana.yml`
|
||||
| /usr/local/etc/kibana
|
||||
d|
|
||||
d|
|
||||
|
||||
| data
|
||||
| The location of the data files of each index / shard allocated
|
||||
|
|
|
|||
|
|
@ -1,5 +1,8 @@
|
|||
[[deb]]
|
||||
=== Install {kib} with Debian package
|
||||
++++
|
||||
<titleabbrev>Install with Debian package</titleabbrev>
|
||||
++++
|
||||
|
||||
The Debian package for Kibana can be <<install-deb,downloaded from our website>>
|
||||
or from our <<deb-repo,APT repository>>. It can be used to install
|
||||
|
|
|
|||
|
|
@ -1,5 +1,9 @@
|
|||
[[rpm]]
|
||||
=== Install {kib} with RPM
|
||||
++++
|
||||
<titleabbrev>Install with RPM</titleabbrev>
|
||||
++++
|
||||
|
||||
|
||||
The RPM for Kibana can be <<install-rpm,downloaded from our website>>
|
||||
or from our <<rpm-repo,RPM repository>>. It can be used to install
|
||||
|
|
|
|||
|
|
@ -1,5 +1,8 @@
|
|||
[[targz]]
|
||||
=== Install {kib} from archive on Linux or macOS
|
||||
++++
|
||||
<titleabbrev>Install from archive on Linux or macOS</titleabbrev>
|
||||
++++
|
||||
|
||||
Kibana is provided for Linux and Darwin as a `.tar.gz` package. These packages
|
||||
are the easiest formats to use when trying out Kibana.
|
||||
|
|
|
|||
|
|
@ -1,5 +1,8 @@
|
|||
[[windows]]
|
||||
=== Install {kib} on Windows
|
||||
++++
|
||||
<titleabbrev>Install on Windows</titleabbrev>
|
||||
++++
|
||||
|
||||
Kibana can be installed on Windows using the `.zip` package.
|
||||
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
[role="xpack"]
|
||||
[[graph-configuration]]
|
||||
== Configuring Graph
|
||||
== Configure Graph
|
||||
|
||||
When a user saves a graph workspace in Kibana, it is stored in the `.kibana`
|
||||
index along with other saved objects like visualizations and dashboards.
|
||||
|
|
@ -48,7 +48,7 @@ Only the configuration is saved unless the user
|
|||
explicitly selects the include data option.
|
||||
|
||||
[float]
|
||||
=== Using Security to grant access
|
||||
=== Use Security to grant access
|
||||
You can also use security to grant read only or all access to different roles.
|
||||
When security is used to grant read only access, the following indicator in Kibana
|
||||
is displayed. For more information on granting access to Kibana, see
|
||||
|
|
@ -59,7 +59,7 @@ image::user/graph/images/graph-read-only-badge.png[Example of Graph's read only
|
|||
|
||||
[discrete]
|
||||
[[disable-drill-down]]
|
||||
=== Disabling drilldown configuration
|
||||
=== Disable drilldown configuration
|
||||
|
||||
By default, users can configure _drilldown_ URLs to display additional
|
||||
information about a selected vertex in a new browser window. For example,
|
||||
|
|
|
|||
|
|
@ -1,13 +1,13 @@
|
|||
[role="xpack"]
|
||||
[[graph-getting-started]]
|
||||
== Using Graph
|
||||
== Create a graph
|
||||
|
||||
You must index data into {es} before you can create a graph.
|
||||
<<index-patterns, Learn how>> or get started with a <<add-sample-data, sample data set>>.
|
||||
|
||||
[float]
|
||||
[[exploring-connections]]
|
||||
=== Graph connections in your data
|
||||
=== Graph a data connection
|
||||
|
||||
. From the side navigation, open *Graph*.
|
||||
+
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
[role="xpack"]
|
||||
[[xpack-graph]]
|
||||
= Graph data connections
|
||||
= Graph
|
||||
|
||||
[partintro]
|
||||
--
|
||||
|
|
|
|||
|
|
@ -2,7 +2,7 @@
|
|||
[[graph-troubleshooting]]
|
||||
== Graph troubleshooting
|
||||
++++
|
||||
<titleabbrev>Troubleshooting</titleabbrev>
|
||||
<titleabbrev>Troubleshoot</titleabbrev>
|
||||
++++
|
||||
|
||||
[discrete]
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue