[DOCS|Dashboard] Updated images and text to match UI #19149

gchaps · 2018-05-16T20:57:41Z

The PR updates the Dashboard document. Images and text were revised to reflect what's in 6.x.

The updated docs are staged here for review:

https://my-kibana-docs.firebaseapp.com/html_docs/dashboard.html

@elastic/kibana-sharing

elasticmachine · 2018-05-16T22:00:22Z

💚 Build Succeeded

continuous-integration/kibana-ci/pull-request

nreese

Looks really nice. Much cleaner.

nreese · 2018-05-17T14:28:32Z

docs/dashboard.asciidoc

@@ -3,163 +3,109 @@

 [partintro]
 --
-A Kibana _dashboard_ displays a collection of saved visualizations.
+A Kibana _dashboard_ displays a collection of visualizations.


I think we need to mention saved searches. "A kibana dashboard displays a collection of visualizations and searches".

nreese · 2018-05-17T14:31:35Z

docs/dashboard.asciidoc

-[float]
-[[moving-containers]]
-==== Moving Visualizations
+The visualizations in your dashboard are stored in containers that you can move,


Do we want to use a more generic term since dashboards can hold more than just visualizations. Maybe panels? Same commit for all uses of visualization in this file.

nreese · 2018-05-17T14:37:12Z

docs/dashboard.asciidoc

-(CSV) file, click the *Raw* or *Formatted* link at the bottom of the data 
-Table. *Raw* exports the data as it is stored in Elasticsearch. *Formatted*
-exports the results of any applicable Kibana <<managing-fields,field
+To export the data as a comma separated values


I think this is very misleading - you are not exporting the raw documents as stored in elasticsearch, you are only exporting the raw aggregation results as returned from the API call. Maybe something like
"To export the response data as a comma separated values (CSV) file, click Raw or Formatted at the bottom of the data table. Raw exports the response data as provided. Formatted exports the response data using applicable Kibana field formatters."

Hm. I thought it was pretty clear that by "raw data", she meant the data that was fed into the aggregation, not the original docs themselves, e.g. the aggregation data. Maybe, instead of "raw data", it should say something like:

"To export the visualization data" or "To export the aggregated data displayed in a visualization..." Dunnoes. Writing is hard.

elasticmachine · 2018-05-18T00:25:19Z

💚 Build Succeeded

continuous-integration/kibana-ci/pull-request

chrisdavies

LGTM. This is great!

chrisdavies · 2018-05-18T15:02:22Z

docs/dashboard.asciidoc

-(CSV) file, click the *Raw* or *Formatted* link at the bottom of the data 
-Table. *Raw* exports the data as it is stored in Elasticsearch. *Formatted*
-exports the results of any applicable Kibana <<managing-fields,field
+To export the data as a comma separated values


Hm. I thought it was pretty clear that by "raw data", she meant the data that was fed into the aggregation, not the original docs themselves, e.g. the aggregation data. Maybe, instead of "raw data", it should say something like:

"To export the visualization data" or "To export the aggregated data displayed in a visualization..." Dunnoes. Writing is hard.

stacey-gammon

Looks good! Left some feedback that you can take or leave. There will be some things changing in 6.4 that will leave some of these screenshots out of date (add panel is one), but it's hard to keep up with all the changes, so this is a very good improvement!

stacey-gammon · 2018-05-21T13:20:31Z

docs/dashboard.asciidoc

-The request statistics show the query duration, request duration, total number
-of matching records, and the index (or index pattern) that was searched.
+. Open the dashboard.
+. Hover over the visualization and click the *Expand* button in the lower


This is going to be changing for 6.4 so that this functionality is exposed in the gear menu. Fine to leave it like this for now, but I want to point out that not all visualizations support it. Right now, in 6.3, no time series visual builder visualizations show it. Maybe not vega/timelion... I'd have to check. Not a huge deal, but might want to add a caveat like "If supported ...."

A lot of stuff will be going that route. When we have "Create Machine Learning Job" it'll only be for certain embeddables. I don't have a good generic term for embeddables. Right now it's only saved searches and visualizations, but it could eventually be more. In addition, even for one embeddable type (like our visualizations), panel options can change based on the visualization sub type.

I'm not opposed to just calling them visualizations because I think that is a nice generic term in itself, but it's overloaded because right now when we say visualizations we mean a specific embeddable type. 🤷‍♀️

stacey-gammon · 2018-05-21T13:38:13Z

docs/dashboard.asciidoc

-share the live dashboard or a static snapshot of the current point in time. 
+. In the menu bar, click *Share*.
+. Copy the link you want to share or the iframe you want to embed. You can
+share the live dashboard or a static snapshot of the current point in time.
 +
 TIP: When sharing a link to a dashboard snapshot, use the *Short URL*. Snapshot


A common thing that trips people up is that users must have write access to .kibana to create short urls. May be worth calling out.

Another thing that might be worth calling out that isn't exposed in the UI at all but many people find handy is that you can create a link to a dashboard by title, by doing this:

${domain}/${basepath?}/app/kibana#/dashboards?title=${yourdashboardtitle}

It's not exposed in the UI because we can't figure out how to communicate it properly (maybe you will have some ideas!). Because it's just linked by title and not id, changing titles on dashboards can change the link. So you can't really say "link to this dashboard" because that might not be true later down the road. Here is the PR it was implemented : #14760

elasticmachine · 2018-05-21T21:31:07Z

💚 Build Succeeded

continuous-integration/kibana-ci/pull-request

nreese

lgtm

* [DOCS|Dashboard] Updated images and text to match UI * [DOCS | Dashboard] Incorporated review comments * [DOCS | DASHBOARD] Incorporated more review comments.

[DOCS|Dashboard] Updated images and text to match UI

a0cbddf

gchaps requested a review from nreese May 16, 2018 20:58

gchaps added the Team:Docs label May 16, 2018

nreese requested review from stacey-gammon and chrisdavies May 17, 2018 14:25

nreese reviewed May 17, 2018

View reviewed changes

[DOCS | Dashboard] Incorporated review comments

eb35c9d

chrisdavies approved these changes May 18, 2018

View reviewed changes

stacey-gammon approved these changes May 21, 2018

View reviewed changes

[DOCS | DASHBOARD] Incorporated more review comments.

3372bb8

nreese approved these changes May 21, 2018

View reviewed changes

gchaps merged commit cae8681 into elastic:master May 21, 2018

gchaps deleted the update/dashboard/doc_images branch May 21, 2018 23:48

This was referenced May 22, 2018

[6.x] [DOCS|Dashboard] Updated images and text to match UI (#19149) #19301

Merged

[6.3] [DOCS|Dashboard] Updated images and text to match UI (#19149) #19302

Merged

This was referenced May 22, 2018

[6.2] [DOCS|Dashboard] Updated images and text to match UI (#19149) #19303

Merged

[6.1] [DOCS|Dashboard] Updated images and text to match UI (#19149) #19304

Merged

nreese added v6.1.0 v7.0.0 v6.2.0 labels May 22, 2018

nreese added v6.3.0 v6.4.0 labels May 22, 2018

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[DOCS|Dashboard] Updated images and text to match UI #19149

[DOCS|Dashboard] Updated images and text to match UI #19149

gchaps commented May 16, 2018

elasticmachine commented May 16, 2018

nreese left a comment

nreese May 17, 2018

nreese May 17, 2018

nreese May 17, 2018

chrisdavies May 18, 2018

elasticmachine commented May 18, 2018

chrisdavies left a comment

chrisdavies May 18, 2018

stacey-gammon left a comment

stacey-gammon May 21, 2018

stacey-gammon May 21, 2018

elasticmachine commented May 21, 2018

nreese left a comment

[DOCS|Dashboard] Updated images and text to match UI #19149

[DOCS|Dashboard] Updated images and text to match UI #19149

Conversation

gchaps commented May 16, 2018

elasticmachine commented May 16, 2018

💚 Build Succeeded

nreese left a comment

Choose a reason for hiding this comment

nreese May 17, 2018

Choose a reason for hiding this comment

nreese May 17, 2018

Choose a reason for hiding this comment

nreese May 17, 2018

Choose a reason for hiding this comment

chrisdavies May 18, 2018

Choose a reason for hiding this comment

elasticmachine commented May 18, 2018

💚 Build Succeeded

chrisdavies left a comment

Choose a reason for hiding this comment

chrisdavies May 18, 2018

Choose a reason for hiding this comment

stacey-gammon left a comment

Choose a reason for hiding this comment

stacey-gammon May 21, 2018

Choose a reason for hiding this comment

stacey-gammon May 21, 2018

Choose a reason for hiding this comment

elasticmachine commented May 21, 2018

💚 Build Succeeded

nreese left a comment

Choose a reason for hiding this comment