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] URL Drilldown #76529

Merged
merged 21 commits into from
Sep 10, 2020
Merged

[Docs] URL Drilldown #76529

merged 21 commits into from
Sep 10, 2020

Conversation

Dosant
Copy link
Contributor

@Dosant Dosant commented Sep 2, 2020

Summary

Closes #69414


Also changes existing Drilldowns because of updates to the structure:

Before:

Existing drilldown docs: https://www.elastic.co/guide/en/kibana/current/drilldowns.html assumed that "Go to dashboard" is the only drilldown type available, but it isn't true with new "URL drilldown".

After:

  • Dashboard
    • Drilldowns
      • Dashboard drilldown
      • URL drilldown

@Dosant Dosant added the release_note:skip Skip the PR/issue when compiling release notes label Sep 2, 2020
@Dosant Dosant changed the title Docs/url drilldown [Docs] URL Drilldown Sep 2, 2020
@Dosant Dosant marked this pull request as ready for review September 2, 2020 17:11
@elasticmachine
Copy link
Contributor

Pinging @elastic/kibana-app-arch (Team:AppArch)

@elasticmachine
Copy link
Contributor

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

@Dosant Dosant requested review from a team, gchaps, streamich and elastic-jb September 2, 2020 17:12
…ldown

# Conflicts:
#	docs/user/dashboard/dashboard-drilldown.asciidoc
#	docs/user/dashboard/drilldowns.asciidoc
#	docs/user/dashboard/images/drilldown_pick_an_action.png
#	docs/user/dashboard/images/url_drilldown_github.png
#	docs/user/dashboard/images/url_drilldown_go_to_github.gif
#	docs/user/dashboard/images/url_drilldown_pick_an_action.png
#	docs/user/dashboard/images/url_drilldown_popup.png
#	docs/user/dashboard/images/url_drilldown_trigger_picker.png
#	docs/user/dashboard/images/url_drilldown_url_template.png
#	docs/user/dashboard/url-drilldown.asciidoc
docs/user/dashboard/dashboard-drilldown.asciidoc Outdated Show resolved Hide resolved
docs/user/dashboard/url-drilldown.asciidoc Show resolved Hide resolved
docs/user/dashboard/url-drilldown.asciidoc Outdated Show resolved Hide resolved
docs/user/dashboard/url-drilldown.asciidoc Outdated Show resolved Hide resolved
docs/user/dashboard/url-drilldown.asciidoc Outdated Show resolved Hide resolved
docs/user/dashboard/url-drilldown.asciidoc Outdated Show resolved Hide resolved
docs/user/dashboard/url-drilldown.asciidoc Outdated Show resolved Hide resolved
docs/user/dashboard/url-drilldown.asciidoc Show resolved Hide resolved
docs/user/dashboard/url-drilldown.asciidoc Outdated Show resolved Hide resolved
==== Variables reference


|===
Copy link
Contributor

Choose a reason for hiding this comment

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

The rendered table on the site does not look good, @gchaps are there any tricks we can do to improve the layout of the table? Otherwise I'm thinking maybe we should switch to a list to present this data. We could create three create three subs-sections under the "URL Template Variables" section:

  • "Global variables"
  • "Context variables"
  • "Event variables"

Then, for example, these paragraphs:

image

could be moved under the "Event variables" sub-section.

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 disagree that it looks not good. But I'd agree that it looks not great :D

[[drilldowns]]
=== Use drilldowns for dashboard actions
Copy link
Contributor

Choose a reason for hiding this comment

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

This page duplicates content from other pages. I'd change it to focus on the actions. How to create the drilldown appears in the individual sections. Here is the structure that I recommend:

Use drilldowns for dashboard actions

Drilldowns, also known as custom actions, allow you to configure a workflow for analyzing and troubleshooting your data. For example, using a drilldown, you can navigate from one dashboard to another, taking the current time range, filters, and other parameters with you, so the context remains the same. You can continue your analysis from a new perspective.

Drilldowns are specific to the dashboard panel for which you create them—they are not shared across panels. A panel can have multiple drilldowns.

Drilldown actions

Drilldowns are user-configurable Kibana actions that are stored with the dashboard metadata.
Kibana provides the following types of actions:

Dashboard drilldown Navigate to a dashboard.
URL drilldown Navigate to external or internal URL.

Note: Some action types are paid commercial features, while others are free. For a comparison of the Elastic subscription levels, see the subscription page.

Code drilldowns

Third-party developers can create drilldowns. Refer to this example plugin to learn how to code drilldowns.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Updated as suggested. The only thing that gets left out in this case is general "ho to manage drilldown", but I guess this is fine.

docs/user/dashboard/dashboard-drilldown.asciidoc Outdated Show resolved Hide resolved
docs/user/dashboard/dashboard-drilldown.asciidoc Outdated Show resolved Hide resolved
docs/user/dashboard/url-drilldown.asciidoc Outdated Show resolved Hide resolved
docs/user/dashboard/url-drilldown.asciidoc Outdated Show resolved Hide resolved
docs/user/dashboard/url-drilldown.asciidoc Outdated Show resolved Hide resolved
docs/user/dashboard/url-drilldown.asciidoc Outdated Show resolved Hide resolved
docs/user/dashboard/url-drilldown.asciidoc Outdated Show resolved Hide resolved
docs/user/dashboard/url-drilldown.asciidoc Show resolved Hide resolved
docs/user/dashboard/url-drilldown.asciidoc Outdated Show resolved Hide resolved
@Dosant
Copy link
Contributor Author

Dosant commented Sep 9, 2020

@streamich, @gchaps, thanks for reviews. I worked through your suggestions

Copy link
Contributor

@gchaps gchaps left a comment

Choose a reason for hiding this comment

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

LGTM with two minor edits. We use sentence case for headings.

docs/user/dashboard/dashboard-drilldown.asciidoc Outdated Show resolved Hide resolved
docs/user/dashboard/url-drilldown.asciidoc Outdated Show resolved Hide resolved
@Dosant Dosant merged commit b913f21 into elastic:master Sep 10, 2020
Dosant added a commit to Dosant/kibana that referenced this pull request Sep 10, 2020
jloleysens added a commit to jloleysens/kibana that referenced this pull request Sep 10, 2020
…rok/new-patterns-component-use-array

* 'master' of github.com:elastic/kibana: (39 commits)
  [APM] Always load esarchives from common (elastic#77139)
  [Ingest Manager] Handle Legacy ES client errors (elastic#76865)
  [Docs] URL Drilldown (elastic#76529)
  [bugfix] Replace panel flyout opens 2 flyouts (elastic#76931)
  clean up test (elastic#76887)
  [Enterprise Search] Update shared API request handler (elastic#77112)
  [Maps] convert ESAggSource to TS (elastic#76999)
  Add plugin status API - take 2 (elastic#76732)
  Adds lens as a readable saved object for read-only dashboard users (elastic#77067)
  Skip checking for the reserved realm (elastic#76687)
  Reporting/diagnostics (elastic#74314)
  Reporting/Test: unskip non-screenshot tests (elastic#77088)
  Move metrics to setup and add cgroup metrics (elastic#76730)
  [Enterprise Search] Add Overview landing page/plugin (elastic#76734)
  First pass. Change TS type. Update OpenAPI (elastic#76434)
  [CI] Balance xpack ci groups a bit (elastic#77068)
  [Security_solution][Detections] Refactor signal ancestry to allow multiple parents (elastic#76531)
  [Maps] convert MetricsEditor to TS (elastic#76727)
  IndexMigrator: fix non blocking migration wrapper promise rejection (elastic#77018)
  [Enterprise Search] Update config data endpoint to v2 (elastic#76970)
  ...

# Conflicts:
#	src/plugins/es_ui_shared/static/forms/hook_form_lib/components/use_array.ts
Dosant added a commit that referenced this pull request Sep 10, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Feature:Drilldowns Embeddable panel Drilldowns release_note:skip Skip the PR/issue when compiling release notes Team:Docs v7.10.0 v8.0.0
Projects
None yet
Development

Successfully merging this pull request may close these issues.

URL drilldown docs
4 participants