Skip to content

Commit

Permalink
Stripped trailing whitespace throughout
Browse files Browse the repository at this point in the history
  • Loading branch information
Paul Echeverri committed Jul 6, 2016
1 parent 10d478f commit 17afa9f
Show file tree
Hide file tree
Showing 22 changed files with 443 additions and 253 deletions.
8 changes: 4 additions & 4 deletions docs/access.asciidoc
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
[[access]]
== Accessing Kibana

Kibana is a web application that you access through port 5601. All you need to do is point your web browser at the
machine where Kibana is running and specify the port number. For example, `localhost:5601` or
Kibana is a web application that you access through port 5601. All you need to do is point your web browser at the
machine where Kibana is running and specify the port number. For example, `localhost:5601` or
`http://YOURDOMAIN.com:5601`.

When you access Kibana, the <<discover,Discover>> page loads by default with the default index pattern selected. The
When you access Kibana, the <<discover,Discover>> page loads by default with the default index pattern selected. The
time filter is set to the last 15 minutes and the search query is set to match-all (\*).

If you don't see any documents, try setting the time filter to a wider time range.
Expand All @@ -14,7 +14,7 @@ If you still don't see any results, it's possible that you don't *have* any docu
[[status]]
=== Checking Kibana Status

You can reach the Kibana server's status page by navigating to `localhost:5601/status`. The status page displays
You can reach the Kibana server's status page by navigating to `localhost:5601/status`. The status page displays
information about the server's resource usage and lists the installed plugins.

image::images/kibana-status-page.png[]
2 changes: 1 addition & 1 deletion docs/advanced-settings.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@ mentioned use "_default_".
`timepicker:refreshIntervalDefaults`:: The time filter's default refresh interval.
`dashboard:defaultDarkTheme`:: Set this property to `true` to make new dashboards use the dark theme by default.
`filters:pinnedByDefault`:: Set this property to `true` to make filters have a global state by default.
`notifications:banner`:: You can specify a custom banner to display temporary notices to all users. This field supports
`notifications:banner`:: You can specify a custom banner to display temporary notices to all users. This field supports
Markdown.
`notifications:lifetime:banner`:: Specifies the duration in milliseconds for banner notification displays. The default value is 3000000. Set this field to `Infinity` to disable banner notifications.
`notifications:lifetime:error`:: Specifies the duration in milliseconds for error notification displays. The default value is 300000. Set this field to `Infinity` to disable error notifications.
Expand Down
2 changes: 1 addition & 1 deletion docs/apps.asciidoc
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
[[kibana-apps]]
== Kibana Apps

The Kibana UI serves as a framework that can contain several different applications. You can switch between these
The Kibana UI serves as a framework that can contain several different applications. You can switch between these
applications by clicking the image:images/app-button.png[App Picker] *App picker* button to display the app bar:

image::images/app-picker.png[]
Expand Down
6 changes: 3 additions & 3 deletions docs/autorefresh.asciidoc
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
=== Automatically Refreshing the Page
You can configure a refresh interval to automatically refresh the page with the latest index data. This periodically
You can configure a refresh interval to automatically refresh the page with the latest index data. This periodically
resubmits the search query.

When a refresh interval is set, it is displayed to the left of the Time Filter in the menu bar.
Expand All @@ -10,10 +10,10 @@ To set the refresh interval:
. Click the *Refresh Interval* tab.
. Choose a refresh interval from the list.

To automatically refresh the data, click the image:images/autorefresh.png[] *Auto-refresh* button when the time picker
To automatically refresh the data, click the image:images/autorefresh.png[] *Auto-refresh* button when the time picker
is open and select an autorefresh interval:

image::images/autorefresh-intervals.png[]

When auto-refresh is enabled, Kibana's top bar displays a pause button and the auto-refresh interval:
When auto-refresh is enabled, Kibana's top bar displays a pause button and the auto-refresh interval:
image:images/autorefresh-pause.png[]. Click the *Pause* button to pause auto-refresh.
11 changes: 5 additions & 6 deletions docs/color-formatter.asciidoc
Original file line number Diff line number Diff line change
@@ -1,11 +1,10 @@
The `Color` field formatter enables you to specify colors with specific ranges of values for a numeric field.

When you select the `Color` field formatter, Kibana displays the *Range*, *Font Color*, *Background Color*, and *Example* fields.
When you select the `Color` field formatter, Kibana displays the *Range*, *Font Color*, *Background Color*, and
*Example* fields.

Click the *Add Color* button to add a range of values to associate with a particular color. You can click in the *Font Color* and
*Background Color* fields to display a color picker. You can also enter a specific hex code value in the field. The effect of your current
color choices are displayed in the *Example* field.
Click the *Add Color* button to add a range of values to associate with a particular color. You can click in the *Font
Color* and *Background Color* fields to display a color picker. You can also enter a specific hex code value in the
field. The effect of your current color choices are displayed in the *Example* field.

image::images/colorformatter.png[]

//update image
2 changes: 1 addition & 1 deletion docs/color-picker.asciidoc
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
You can customize the colors of your visualization by clicking the color dot next to each label to display the
You can customize the colors of your visualization by clicking the color dot next to each label to display the
_color picker_.

image::images/color-picker.png[An array of color dots that users can select]
46 changes: 23 additions & 23 deletions docs/dashboard.asciidoc
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
[[dashboard]]
== Dashboard

A Kibana _dashboard_ displays a set of saved visualizations in groups that you can arrange freely. You can save a
A Kibana _dashboard_ displays a set of saved visualizations in groups that you can arrange freely. You can save a
dashboard to share or reload at a later time.

.Sample dashboard
Expand All @@ -21,7 +21,7 @@ The first time you click the *Dashboard* tab, Kibana displays an empty dashboard

image:images/NewDashboard.png[New Dashboard screen]

Build your dashboard by adding visualizations. By default, Kibana dashboards use a light color theme. To use a dark color
Build your dashboard by adding visualizations. By default, Kibana dashboards use a light color theme. To use a dark color
theme instead, click the *Options* button and check the *Use dark theme* box.

NOTE: You can change the default theme in the *Advanced* section of the *Settings* tab.
Expand All @@ -34,45 +34,45 @@ include::autorefresh.asciidoc[]
[[adding-visualizations-to-a-dashboard]]
==== Adding Visualizations to a Dashboard

To add a visualization to the dashboard, click the *Add* button in the toolbar panel. Select a saved visualization
from the list. You can filter the list of visualizations by typing a filter string into the *Visualization Filter*
To add a visualization to the dashboard, click the *Add* button in the toolbar panel. Select a saved visualization
from the list. You can filter the list of visualizations by typing a filter string into the *Visualization Filter*
field.

The visualization you select appears in a _container_ on your dashboard.

NOTE: If you see a message about the container's height or width being too small, <<resizing-containers,resize the
NOTE: If you see a message about the container's height or width being too small, <<resizing-containers,resize the
container>>.

[float]
[[saving-dashboards]]
==== Saving Dashboards

To save the dashboard, click the *Save Dashboard* button in the toolbar panel, enter a name for the dashboard in the
*Save As* field, and click the *Save* button. By default, dashboards store the time period specified in the time filter
when you save a dashboard. To disable this behavior, clear the *Store time with dashboard* box before clicking the
To save the dashboard, click the *Save Dashboard* button in the toolbar panel, enter a name for the dashboard in the
*Save As* field, and click the *Save* button. By default, dashboards store the time period specified in the time filter
when you save a dashboard. To disable this behavior, clear the *Store time with dashboard* box before clicking the
*Save* button.

[float]
[[loading-a-saved-dashboard]]
==== Loading a Saved Dashboard

Click the *Load Saved Dashboard* button to display a list of existing dashboards. The saved dashboard selector includes
a text field to filter by dashboard name and a link to the Object Editor for managing your saved dashboards. You can
Click the *Load Saved Dashboard* button to display a list of existing dashboards. The saved dashboard selector includes
a text field to filter by dashboard name and a link to the Object Editor for managing your saved dashboards. You can
also access the Object Editor by clicking *Settings > Objects*.

[float]
[[sharing-dashboards]]
==== Sharing Dashboards

You can share dashboards with other users. You can share a direct link to the Kibana dashboard or embed the dashboard
You can share dashboards with other users. You can share a direct link to the Kibana dashboard or embed the dashboard
in your Web page.

NOTE: A user must have Kibana access in order to view embedded dashboards.

To share a dashboard, click the *Share* button image:images/share-dashboard.png[] to display the _Sharing_ panel.

Click the *Copy to Clipboard* button image:images/share-link.png[] to copy the native URL or embed HTML to the clipboard.
Click the *Generate short URL* button image:images/share-short-link.png[] to create a shortened URL for sharing or
Click the *Generate short URL* button image:images/share-short-link.png[] to create a shortened URL for sharing or
embedding.

[float]
Expand All @@ -85,40 +85,40 @@ To embed a dashboard, copy the embed code from the _Share_ display into your ext
[[customizing-your-dashboard]]
=== Customizing Dashboard Elements

The visualizations in your dashboard are stored in resizable _containers_ that you can arrange on the dashboard. This
The visualizations in your dashboard are stored in resizable _containers_ that you can arrange on the dashboard. This
section discusses customizing these containers.

[float]
[[moving-containers]]
==== Moving Containers

Click and hold a container's header to move the container around the dashboard. Other containers will shift as needed
Click and hold a container's header to move the container around the dashboard. Other containers will shift as needed
to make room for the moving container. Release the mouse button to confirm the container's new location.

[float]
[[resizing-containers]]
==== Resizing Containers

Move the cursor to the bottom right corner of the container until the cursor changes to point at the corner. After the
cursor changes, click and drag the corner of the container to change the container's size. Release the mouse button to
Move the cursor to the bottom right corner of the container until the cursor changes to point at the corner. After the
cursor changes, click and drag the corner of the container to change the container's size. Release the mouse button to
confirm the new container size.

[float]
[[removing-containers]]
==== Removing Containers

Click the *x* icon at the top right corner of a container to remove that container from the dashboard. Removing a
Click the *x* icon at the top right corner of a container to remove that container from the dashboard. Removing a
container from a dashboard does not delete the saved visualization in that container.

[float]
[[viewing-detailed-information]]
==== Viewing Detailed Information

To display the raw data behind the visualization, click the bar at the bottom of the container. Tabs with detailed
To display the raw data behind the visualization, click the bar at the bottom of the container. Tabs with detailed
information about the raw data replace the visualization, as in this example:

.Table
A representation of the underlying data, presented as a paginated data grid. You can sort the items
A representation of the underlying data, presented as a paginated data grid. You can sort the items
in the table by clicking on the table headers at the top of each column.
image:images/NYCTA-Table.jpg[]

Expand All @@ -131,20 +131,20 @@ The raw response from the server, presented in JSON format.
image:images/NYCTA-Response.jpg[]

.Statistics
A summary of the statistics related to the request and the response, presented as a data grid. The data
grid includes the query duration, the request duration, the total number of records found on the server, and the
A summary of the statistics related to the request and the response, presented as a data grid. The data
grid includes the query duration, the request duration, the total number of records found on the server, and the
index pattern used to make the query.
image:images/NYCTA-Statistics.jpg[]

To export the raw data behind the visualization as a comma-separated-values (CSV) file, click on either the
*Raw* or *Formatted* links at the bottom of any of the detailed information tabs. A raw export contains the data as it
*Raw* or *Formatted* links at the bottom of any of the detailed information tabs. A raw export contains the data as it
is stored in Elasticsearch. A formatted export contains the results of any applicable Kibana [field formatters].

[float]
[[changing-the-visualization]]
=== Changing the Visualization

Click the _Edit_ button image:images/EditVis.png[Pencil button] at the top right of a container to open the
Click the _Edit_ button image:images/EditVis.png[Pencil button] at the top right of a container to open the
visualization in the <<visualize,Visualize>> page.

[float]
Expand Down
Loading

0 comments on commit 17afa9f

Please sign in to comment.