Adds updated doc material for the 4.1 release of Kibana

[palecur]

Closes #3733

Updates K4 docs for 4.1 features. Notable changes include bubble charts from line charts, new aggregations (Percentile Rank and dedicated range aggs for dates and IPv4 addresses), UI changes (Options tab for visualizations).

[tbragin]

Based on a cursory review, looks like great progress!

A couple of brief comments so far:

• field formatters - could we include key examples for each format type?
• import/export options in Settings >> Advanced don’t seem to be documented
• line chart- "current time marker" view option not documented
• discover -screenshots outdates, since we moved the index selector (no more wheel)
• tile map - where do we describe the new geo bounding box option? I may have missed it

[rashidkpc]

I don't see anything about filter pinning either. It would be nice to have examples of where its useful, eg, creating a filter on the dashboard, and heading back to discover with it.

[rashidkpc]

Can you give examples of where each of these might be useful? A bit of material: http://www.forbes.com/sites/naomirobbins/2012/01/19/when-should-i-use-logarithmic-scales-in-my-charts-and-graphs/

[palecur]

Added this section to the discussion of different axis scales: "You can use a log
scale to display data that varies exponentially, such as a compounding interest chart, or a square root scale to regularize the display of data sets with variabilities that are themselves highly variable. This kind of data, where the variability is itself variable over the domain being examined, is known as heteroscedastic data. For example, if a data set of height versus weight has a relatively narrow range of variability at the short end of height, but a wider range at the taller end, the data set is heteroscedastic."

[rashidkpc]

A couple first impression notes on the tutorial

1. The user is asked to load the Shakespeare data set, but nothing is done with it after that
2. The accounts data appears to be really random, so there's nothing to really find in it. Might want to find a better set here. It also has some geo-ish data, but its all address based so the user can't do anything with maps.

[rashidkpc]

Index patterns can not use regular expressions. Its a wildcard pattern at best.

[rashidkpc]

The flow is a bit off here. The previous section of the docs talks about setting up index patterns, but of course you can't do that without data, which you get in the tutorial section. It seems the tutorial should be the first thing you hit after a "What is kibana and why do I care?" section

[w33ble]

Some general feedback:

• images/NYCTA-Dashboard.jpg should be better cropped (left and bottom edges removed)
• The Visualize section is huge - would it maybe make sense to break each of the vis types out into their own page or something?

[tbragin]

My comments after the latest round of changes.

Add distribution package formats & service definitions #3212
=> No content. Should add information on the new available packaging and installation options to "Getting Kibana Up and Running". Right now we only describe the manual installation.

Collapsible sidebar #3185
=> No content. Should mention that in the Discover section and update the out-of-date screenshot.

Discover interval #3290
=> No content. Should describe how to change the default

Add columns from doc table #3526
=> No content. Should describe the process for doing that

Move index pattern selector into index pattern header in discover #3060
=> No content. Should describe the process for doing that

Add IPv4 Range Aggregation #3171
=> IPv4 Range URL is a broken link: http://www.elastic.co/guide/en/elasticsearch/reference/currentsearch-aggregations-bucket-iprange-aggregation.html
=> Date Range and IPv4 Range options are not present in Tilemap, but we document them as if they are.

vis editor refactor #3616
=> Visualize screenshot needs to be updated to show vis editor restyle (we should especially point to where options moved into, since they are much less discoverable now)

Add ability to select y-axis min and max values #3464
=> "Set Y-Axis Extents" not described

Adding feature to remove circles when option to remove circles selected #3197
=> My understanding is that circles are shown by default. So we should document this as "uncheck the box to remove the circles…"

Tilemap PRs
=> "Navigating the Map" Formatting is off… bullet points do not show up as expected
=> We should consider including screenshots of the buttons inline with instructions in more places, because it’s not clear what the "Fit Data Bounds" button is, unless you mouse over

Add custom date histogram interval option #3237
=> No content. Should describe the "Custom" option in the "Date Histogram" blurb

Add a pause button to the header when auto-refresh is enabled
#3800
=> No content on the pause button
=> Also, currently time picker is only described in Discover, however this functionality, including auto-refresh is available in Discover, Visualize, and Dashboard. Auto-refresh is very important in the Dashboard page.

Add option to save time with dashboard #3164
=> "Store time with dashboard" checkbox not described.

Settings refactor
- We discussed a refactor to make "Managing Saved Searches, Visualizations, and Dashboards" easier to find: break up the page into "Indices", "Advanced", and "Objects" and link to them at the top, like we do in visualize.

Import/export #3573
=> Formatting of the paragraph off - bullet points do not show up

Closes #2471 - Add logging to a file #3201
=> Do we describe startup options anywhere? We should… are there others?

[tbragin]

On the tutorial: Link to the logstash dataset does not seem to be present in the latest version

[palecur]

The logstash data set isn't hosted yet; I've talked to Drew about it and he'll take care of it. I'll update it as soon as I know the URL.

[palecur]

Pull #3212: Added this section to setup.asciidoc

On Unix, you can instead run the package manager suited for your distribution:

• Red Hat, Centos: yum install kibana
• Debian: apt-get install kibana

After installing, run Kibana from the install directory: bin/kibana (Linux/MacOSX) or bin\kibana.bat (Windows).

I'll need information from @jordansissel about where those packages' default install directories are so I can add that to the section, but it's not much more involved than that.

Pull #3185: done.

Pull #3290: Screenshot updated, text added: The histogram lists the time range you're currently exploring, as well as the intervals that range is currently using.
To change the intervals, click the link and select an interval from the drop-down. The default behavior automatically sets an interval based on the time range.

Pull #3464: Added to area chart, already present in line chart

Pull #3526: Added ". To toggle a particular field's column in the Documents table, click the
image:images/add-column-button.png[Add Column] Toggle column in table button." and a representative screenshot.

Pull #3060: Current doc says to click the name of the index pattern to change it; this behavior still works, since the directional indicator is in the same bar as the pattern name, and clicking anywhere on the bar unfolds the list of index patterns. Screenshot updated to reflect new visual style.

Pull #3171: Fixed bad link. IPv4 and date range aggs are definitely selectable and present as sub-aggregations.

Pull #3616: Updated screenshot and text referring to Apply changes button.

More to come later tonight with PR update and rebuild of sample doc for further inspection

[palecur]

Pull #3197: Typically we've just been documenting what the box does when it's checked, not altering our phrasing by whether or not it's default-checked.

Tilemap: Format fixed, images for buttons added. +/- zoom buttons added and documented.

#3237: The following language added to all discussions of the Date Histogram agg (x-axis-aggs, tilemap, pie, and datatable .asciidoc):
"You can also specify a custom interval frame by selecting Custom as the interval and
specifying a number and a time unit in the text field. Custom interval time units are s for seconds, m for minutes, h for hours, d for days, w for weeks, and y for years. Different units support different levels of precision, down to one second."

#3800: Autorefresh added to discussion of the time picker, and is now present in Dashboard and Visualize as well.

#3164: Added the following text:
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.

Settings chunking: Done

#3201: Yes, these are all in Settings. I've added a line for log_file right after pid_file.

PR updated, new build up for inspection as usual.

[tbragin]

Perhaps an item for a later date, but for the Kibana server properties table, do we also want to document the command-line options that go along with each option?

-h, --help                 output usage information
-V, --version              output the version number
-e, --elasticsearch <uri>  Elasticsearch instance
-c, --config <path>        Path to the config file
-p, --port <port>          The port to bind to
-q, --quiet                Turns off logging
-H, --host <host>          The host to bind to
-l, --log-file <path>    The file to log to
--plugins <path>           Path to scan for plugins

[tbragin]

On pull #3212, agreed that need info from @jordansissel and/or @rashidkpc on whether the kibana RPM and DEB packages are going to be uploaded to the respective repos, so the following installation commands would work at the time when we release these docs, as right now they don't seem to:

• Red Hat, Centos: yum install kibana
• Debian: apt-get install kibana

[tbragin]

"What's new in Kibana 4.1" content looks good to me. I would probably not use bold for the pull numbers, but it's only a preference.

We should modify the note in the intro that refers to which product version this documentation is for, for instance:

This guide describes how to use Kibana 4**.1**. For information about what’s new in Kibana 4**.1**, see What’s New in Kibana 4.1. For earlier versions of Kibana 4 go here [include link]. For information about Kibana 3, see the Kibana 3 User Guide.