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.

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

[DOCS] Dashboard-first docs refresh #76194

Merged
merged 24 commits into from Sep 3, 2020

Conversation

@KOTungseth KOTungseth added Team:Docs release_note:skip Skip the PR/issue when compiling release notes v7.10.0 v7.11.0 labels Aug 27, 2020
@KOTungseth KOTungseth self-assigned this Aug 27, 2020
@elasticmachine
Copy link
Contributor

Pinging @elastic/kibana-docs (Team:Docs)

Copy link
Contributor

@ThomThomson ThomThomson left a comment

Choose a reason for hiding this comment

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

It's great that we're being proactive about updating the documentation with the dashboard first changes. There will be more coming down the pipe in the future, but this does a great job bringing it up to the present.

I left some minor comments on wording, but it's looking great overall!

docs/getting-started/tutorial-sample-data.asciidoc Outdated Show resolved Hide resolved
docs/user/dashboard/dashboard.asciidoc Outdated Show resolved Hide resolved
docs/user/dashboard/dashboard.asciidoc Outdated Show resolved Hide resolved
docs/user/dashboard/dashboard.asciidoc Outdated Show resolved Hide resolved
docs/user/dashboard/edit-dashboards.asciidoc Outdated Show resolved Hide resolved
== Share dashboards

[[embedding-dashboards]]
Share your dashboard outside of {kib}.
Copy link
Contributor

Choose a reason for hiding this comment

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

Maybe include a screenshot?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

What should I include in the screenshot?

docs/user/reporting/index.asciidoc Show resolved Hide resolved
docs/user/security/reporting.asciidoc Show resolved Hide resolved
Copy link
Contributor

@ThomThomson ThomThomson left a comment

Choose a reason for hiding this comment

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

Wording, and instructions LGTM! Thanks for clarifying that panel title changes are not propagated to other dashboards.

docs/getting-started/tutorial-discovering.asciidoc Outdated Show resolved Hide resolved
+
The `OriginCityName` and the `DestCityName` fields filter the data on the dasbhoard to match
the data you specified.
You'll see a histogram that shows the distribution of
Copy link
Contributor

Choose a reason for hiding this comment

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

Do users understand what histograms are? We use this word in many places in Kibana, so it's probably okay, but worth pointing out.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I believe histogram is considered an industry term, and we use it in the Discover docs, but I think you're right -- we could probably use something a bit more user friendly. Like bar graph, graph, visualization, or something.

docs/getting-started/tutorial-sample-data.asciidoc Outdated Show resolved Hide resolved
[float]
[[tutorial-sample-discover]]
=== Discover the data
. To change the data on the panel, use an {es} {ref}/search-aggregations.html[bucket aggregation],
Copy link
Contributor

Choose a reason for hiding this comment

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

Instead of providing the .html name of the other page, can you use the << style of linking?

Copy link
Contributor Author

@KOTungseth KOTungseth Sep 3, 2020

Choose a reason for hiding this comment

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

We use the << style for content in the Kibana repo. The bucket aggregation link is for the ES repo, so we use the .html linking.

docs/getting-started/tutorial-sample-data.asciidoc Outdated Show resolved Hide resolved
docs/user/dashboard/dashboard.asciidoc Outdated Show resolved Hide resolved

[float]
[[timelion]]
=== Create panels with Timelion
Copy link
Contributor

Choose a reason for hiding this comment

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

I thought we already made the decision to deprecate Timelion. It surprises me that it's listed here

Copy link
Contributor Author

Choose a reason for hiding this comment

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

We deprecated the Timelion app, but not the Timelion editor.

docs/user/dashboard/edit-dashboards.asciidoc Outdated Show resolved Hide resolved
* Generate a PNG report

TIP: To create a link to a dashboard by title, use: +
`${domain}/${basepath?}/app/dashboards#/list?title=${yourdashboardtitle}`
Copy link
Contributor

Choose a reason for hiding this comment

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

I'm not sure this tip is helpful without also explaining what each of these properties is, or giving examples

[[vega-graph]]
== Vega
[[tutorials]]
== Tutorials
Copy link
Contributor

Choose a reason for hiding this comment

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

Why are there three timelion tutorials here?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

They were in the original docs that Alex wrote, so I just transferred them all over.

KOTungseth and others added 10 commits September 3, 2020 15:26
Co-authored-by: Wylie Conlon <wylieconlon@gmail.com>
Co-authored-by: Wylie Conlon <wylieconlon@gmail.com>
Co-authored-by: Wylie Conlon <wylieconlon@gmail.com>
Co-authored-by: Wylie Conlon <wylieconlon@gmail.com>
Co-authored-by: Wylie Conlon <wylieconlon@gmail.com>
Co-authored-by: Wylie Conlon <wylieconlon@gmail.com>
Co-authored-by: Wylie Conlon <wylieconlon@gmail.com>
Co-authored-by: Wylie Conlon <wylieconlon@gmail.com>
@KOTungseth KOTungseth merged commit c84532a into elastic:master Sep 3, 2020
@KOTungseth KOTungseth deleted the docs/dashboard-refresh branch September 3, 2020 21:34
KOTungseth added a commit to KOTungseth/kibana that referenced this pull request Sep 3, 2020
* [DOCS] Dashboard-first refresh

* Fixes broken links and partinto error

* Fixes images in panel table

* Fixes broken links

* Fixes broken drilldowns link

* Fixes images and table

* Removed un needed files and added edit content

* Update docs/getting-started/tutorial-visualizing.asciidoc

Co-authored-by: gchaps <33642766+gchaps@users.noreply.github.com>

* Review comments

* Review comments

* Removed blocks

* Typo fix

* Update docs/getting-started/tutorial-sample-data.asciidoc

Co-authored-by: Wylie Conlon <wylieconlon@gmail.com>

* Update docs/getting-started/tutorial-discovering.asciidoc

Co-authored-by: Wylie Conlon <wylieconlon@gmail.com>

* Update docs/getting-started/tutorial-sample-data.asciidoc

Co-authored-by: Wylie Conlon <wylieconlon@gmail.com>

* Update docs/getting-started/tutorial-visualizing.asciidoc

Co-authored-by: Wylie Conlon <wylieconlon@gmail.com>

* Update docs/user/dashboard/edit-dashboards.asciidoc

Co-authored-by: Wylie Conlon <wylieconlon@gmail.com>

* Update docs/user/dashboard/dashboard.asciidoc

Co-authored-by: Wylie Conlon <wylieconlon@gmail.com>

* Update docs/user/dashboard/dashboard.asciidoc

Co-authored-by: Wylie Conlon <wylieconlon@gmail.com>

* Update docs/user/dashboard/aggregation-reference.asciidoc

Co-authored-by: Wylie Conlon <wylieconlon@gmail.com>

* Review comments

Co-authored-by: gchaps <33642766+gchaps@users.noreply.github.com>
Co-authored-by: Wylie Conlon <wylieconlon@gmail.com>
# Conflicts:
#	docs/user/visualize.asciidoc
#	docs/visualize/heatmap.asciidoc
jloleysens added a commit to jloleysens/kibana that referenced this pull request Sep 4, 2020
…rok/new-patterns-component-use-array

* 'master' of github.com:elastic/kibana: (75 commits)
  Remove legacy ui-apps-mixin (elastic#76604)
  remove unused test_utils (elastic#76528)
  [ML] Functional tests - add UI permission tests (elastic#76368)
  [APM] @ts-error -> @ts-expect-error (elastic#76492)
  [APM] Avoid negative offset for error marker on timeline (elastic#76638)
  [Reporting] rename interfaces to align with task manager integration (elastic#76716)
  Revert back ESO migration for alerting, added try/catch logic to avoid failing Kibana on start (elastic#76220)
  Test reverting "Add plugin status API (elastic#75819)" (elastic#76707)
  [Security Solution][Detections] Removes ML Job Settings SIEM copy and fixes link to ML app for creating custom jobs (elastic#76595)
  [Maps] remove region/coordinate-maps visualizations from sample data (elastic#76399)
  [DOCS] Dashboard-first docs refresh (elastic#76194)
  Updated ServiceNow description in docs and actions management UI to contains correct info (elastic#76344)
  [DOCS] Identifies cloud settings in reporting (elastic#76691)
  [Security Solution] Refactor timeline details to use search strategy (elastic#75591)
  es-archiver: Drop invalid index settings, support --query flag  (elastic#76522)
  [DOCS] Identifies graph settings available on cloud (elastic#76661)
  Add more info about a11y tests (elastic#76045)
  [data.search.SearchSource] Remove legacy ES client APIs. (elastic#75943)
  [release notes] automatically retry on Github API 5xx errors (elastic#76447)
  [es_ui_shared] Fix eslint exhaustive deps rule (elastic#76392)
  ...
KOTungseth added a commit that referenced this pull request Sep 4, 2020
* [DOCS] Dashboard-first refresh

* Fixes broken links and partinto error

* Fixes images in panel table

* Fixes broken links

* Fixes broken drilldowns link

* Fixes images and table

* Removed un needed files and added edit content

* Update docs/getting-started/tutorial-visualizing.asciidoc

Co-authored-by: gchaps <33642766+gchaps@users.noreply.github.com>

* Review comments

* Review comments

* Removed blocks

* Typo fix

* Update docs/getting-started/tutorial-sample-data.asciidoc

Co-authored-by: Wylie Conlon <wylieconlon@gmail.com>

* Update docs/getting-started/tutorial-discovering.asciidoc

Co-authored-by: Wylie Conlon <wylieconlon@gmail.com>

* Update docs/getting-started/tutorial-sample-data.asciidoc

Co-authored-by: Wylie Conlon <wylieconlon@gmail.com>

* Update docs/getting-started/tutorial-visualizing.asciidoc

Co-authored-by: Wylie Conlon <wylieconlon@gmail.com>

* Update docs/user/dashboard/edit-dashboards.asciidoc

Co-authored-by: Wylie Conlon <wylieconlon@gmail.com>

* Update docs/user/dashboard/dashboard.asciidoc

Co-authored-by: Wylie Conlon <wylieconlon@gmail.com>

* Update docs/user/dashboard/dashboard.asciidoc

Co-authored-by: Wylie Conlon <wylieconlon@gmail.com>

* Update docs/user/dashboard/aggregation-reference.asciidoc

Co-authored-by: Wylie Conlon <wylieconlon@gmail.com>

* Review comments

Co-authored-by: gchaps <33642766+gchaps@users.noreply.github.com>
Co-authored-by: Wylie Conlon <wylieconlon@gmail.com>
# Conflicts:
#	docs/user/visualize.asciidoc
#	docs/visualize/heatmap.asciidoc
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
release_note:skip Skip the PR/issue when compiling release notes Team:Docs v7.10.0 v7.11.0
Projects
None yet
5 participants