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.

Sign up for GitHub

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

Jump to bottom

[DOCS] Updates images and content in Dashboard docs #42500

Merged
merged 3 commits into from
Aug 2, 2019
Merged

[DOCS] Updates images and content in Dashboard docs #42500

merged 3 commits into from
Aug 2, 2019

Conversation

gchaps
Copy link
Contributor

@gchaps gchaps commented Aug 2, 2019

Summary

This PR makes the following changes to the Dashboard docs:

  • Adds the value prop and what Dashboard provides
  • Updates the content and images
  • Collapses some of the smaller pages into a single page

A formatted version of the doc is here.

[skip ci]

@gchaps gchaps added Team:Docs Feature:Dashboard Dashboard related features v8.0.0 release_note:skip Skip the PR/issue when compiling release notes v7.3.0 v7.4.0 labels Aug 2, 2019
@gchaps gchaps requested a review from KOTungseth August 2, 2019 00:32
@elasticmachine
Copy link
Contributor

Pinging @elastic/kibana-docs

@gchaps gchaps requested a review from a team August 2, 2019 00:35
timroes
timroes reviewed Aug 2, 2019
View reviewed changes
docs/dashboard.asciidoc Outdated

Once you open a dashboard, you can filter the data
by entering a search query, changing the time filter, or clicking
in the visualization, search, or map. If a dashboard element has a stored query,
Copy link
Contributor

Choose a reason for hiding this comment

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

wouldn't that be "clicking in a visualization, search, or map" or "clicking in the visualizations, searches, or maps"?

timroes
timroes approved these changes Aug 2, 2019
View reviewed changes
Copy link
Contributor

@timroes timroes left a comment

Choose a reason for hiding this comment

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

Besides two minor questions/suggestions this looks good to me.

docs/dashboard.asciidoc Outdated

TIP: When sharing a link to a dashboard snapshot, use the *Short URL*. Snapshot
URLs are long and can be problematic for Internet Explorer and other
tools. To create a short URL, you must have write access to {kib}.
Copy link
Contributor

Choose a reason for hiding this comment

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

Double Space: "tools. To" (though I think asciidoc will ignore those?

KOTungseth
KOTungseth approved these changes Aug 2, 2019
View reviewed changes
Copy link
Contributor

@KOTungseth KOTungseth left a comment

Choose a reason for hiding this comment

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

I have a few tiny comments, but otherwise, this PR looks great.

docs/dashboard.asciidoc Outdated

--
To start working with dashboards, click *Dashboard* in the side navigation.
You can:
Copy link
Contributor

Choose a reason for hiding this comment

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

How about:

With dashboards, you can:

docs/dashboard.asciidoc
If you haven't yet indexed data into {es} or created an index pattern,
you'll be prompted to do so as you follow the steps for creating a dashboard.
Or, you can use one of the prebuilt sample data sets, available from the
Kibana home page.

[float]
[[dashboard-read-only-access]]
=== [xpack]#Read only access#
Copy link
Contributor

Choose a reason for hiding this comment

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

Totally outside the parameters of this PR, but could we make this an attribute? I've been sticking this text in my PRs too, so I'm wondering if we could keep and maintain it in one place?

docs/dashboard.asciidoc

When you open *Dashhboard*, you're presented an overview of your dashboards.
If you don't have any dashboards, you can add
<<add-sample-data, sample data sets>>,
Copy link
Contributor

Choose a reason for hiding this comment

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

How about:
...you can add sample data sets and check out the pre-built dashboards.

or:

you can add sample data sets, or checkout the pre-built dashboards.

@gchaps gchaps merged commit 7a89b7a into elastic:master Aug 2, 2019
gchaps added a commit that referenced this pull request Aug 2, 2019
@gchaps
[DOCS] Updates images and content in Dashboard docs (#42500)
92d318a 
* [DOCS] Updates images and content in Dashboard docs

* [DOCS] Incorporated feedback
gchaps added a commit that referenced this pull request Aug 2, 2019
@gchaps
[DOCS] Updates images and content in Dashboard docs (#42500)
9dc621a 
* [DOCS] Updates images and content in Dashboard docs

* [DOCS] Incorporated feedback
jloleysens added a commit to jloleysens/kibana that referenced this pull request Aug 5, 2019
@jloleysens
Merge branch 'master' of github.com:elastic/kibana into feature/clone…
ad759ef 
…-or-edit-existing-rollup-job

* 'master' of github.com:elastic/kibana: (67 commits)
  [TSVB] Shim new platform (elastic#39169)
  [Metric Vis] Shim new platform (elastic#42240)
  [Tag Cloud] Shim new platform (elastic#42348)
  Disable flaky request lib tests. Add es_ui_shared plugin to CODEOWNERS.
  Add disk space percentage to node listing (elastic#42145)
  [SIEM] Add chart interactions - update date picker after brush selection on charts (elastic#42440)
  Document HTTP service (elastic#42331)
  [Reporting] Sanitize 409 error log message (elastic#42495)
  [docs][skip ci] Maps read only access (elastic#35561)
  [x-pack/ftr] refactor types to be more accurate/consistent wit… (elastic#42407)
  [DOCS] Updates images and content in Dashboard docs (elastic#42500)
  Allow sorting on multiple columns in Discover (elastic#41918)
  [Infra UI][Logs UI] Fix autocomplete to use proper derived index pattern (elastic#42287)
  [ftr/cheerio] improve cheerio types to include test subject me… (elastic#42534)
  Upgraded EUI 13.0.0 -> 13.1.1 (elastic#42298)
  Increase max-old-space-size for builds (elastic#42218)
  [Infra UI] Add cloud metrics and cloud/host info to metadata endpoint (elastic#41836)
  [Logs UI][a11y] Announce name of column on remove column button (elastic#41695)
  Inspector 👉 New Platform (elastic#42164)
  Make alerting properly space aware (elastic#42081)
  ...
jloleysens added a commit to jloleysens/kibana that referenced this pull request Aug 5, 2019
@jloleysens
Merge branch 'master' of github.com:elastic/kibana into fix/doc_value…
b366497 
…s_autocomplete

* 'master' of github.com:elastic/kibana: (189 commits)
  [TSVB] Shim new platform (elastic#39169)
  [Metric Vis] Shim new platform (elastic#42240)
  [Tag Cloud] Shim new platform (elastic#42348)
  Disable flaky request lib tests. Add es_ui_shared plugin to CODEOWNERS.
  Add disk space percentage to node listing (elastic#42145)
  [SIEM] Add chart interactions - update date picker after brush selection on charts (elastic#42440)
  Document HTTP service (elastic#42331)
  [Reporting] Sanitize 409 error log message (elastic#42495)
  [docs][skip ci] Maps read only access (elastic#35561)
  [x-pack/ftr] refactor types to be more accurate/consistent wit… (elastic#42407)
  [DOCS] Updates images and content in Dashboard docs (elastic#42500)
  Allow sorting on multiple columns in Discover (elastic#41918)
  [Infra UI][Logs UI] Fix autocomplete to use proper derived index pattern (elastic#42287)
  [ftr/cheerio] improve cheerio types to include test subject me… (elastic#42534)
  Upgraded EUI 13.0.0 -> 13.1.1 (elastic#42298)
  Increase max-old-space-size for builds (elastic#42218)
  [Infra UI] Add cloud metrics and cloud/host info to metadata endpoint (elastic#41836)
  [Logs UI][a11y] Announce name of column on remove column button (elastic#41695)
  Inspector 👉 New Platform (elastic#42164)
  Make alerting properly space aware (elastic#42081)
  ...
gchaps added a commit that referenced this pull request Aug 5, 2019
@gchaps
[DOCS] Updates images and content in Dashboard docs (#42500)
753e93f 
* [DOCS] Updates images and content in Dashboard docs

* [DOCS] Incorporated feedback
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@KOTungseth KOTungseth KOTungseth approved these changes

@timroes timroes timroes approved these changes

Assignees
No one assigned
Labels
Feature:Dashboard Dashboard related features release_note:skip Skip the PR/issue when compiling release notes Team:Docs v7.3.0 v7.4.0 v8.0.0
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@gchaps @elasticmachine @timroes @KOTungseth