[DOCS] Consolidates drilldown pages by KOTungseth · Pull Request #82081 · elastic/kibana

KOTungseth · 2020-10-29T21:21:46Z

Summary

Consolidates the drilldowns pages.
Adds a table for the supported panels

Checklist

Delete any items that are not applicable to this PR.

Documentation was added for features that require explanation or tutorials

elasticmachine · 2020-10-29T21:21:48Z

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

Dosant

Drilldowns editor UI points to different section of docs
https://github.com/elastic/kibana/blob/master/src/core/public/doc_links/doc_links_service.ts#L41

Drilldowns in general
Explanation of triggers
Help for URL templating language
URL variables reference

We also need to update the links to point to right place in a new structure.

docs/user/dashboard/drilldowns.asciidoc

hendry-lim

nit: there is spacing inconsistency on line 46:

{{ date event.from “YYYY MM DD”}} +

should be
{{date event.from “YYYY MM DD”}} +

hendry-lim · 2020-11-01T00:56:40Z

docs/user/dashboard/url-drilldown.asciidoc

 Because there is no user interaction with a panel in preview, there is no interaction context to use in a preview.
-To work around this, {kib} provides a sample interaction that relies on a picked <<trigger-picker, trigger>>.
+To work around this, {kib} provides a sample interaction that relies on a trigger.
 So in a preview, you might notice that `{{event.value}}` is replaced with `{{event.value}}` instead of with a sample from your data.


{{event.value}} is replaced with {{event.value}}

These two look the same. Are they supposed to reference different variable?

This section explains that we don't have a sample data from a chart to make a proper replacement of {{event.*}} in preview. So in preview {{event.value}} variable is literally propagated as is: {{event.value}} -> {{event.value}}.
We will revise this limitation in future releases. Not sure how to explain this clearer in docs now..

docs/user/dashboard/drilldowns.asciidoc

src/core/public/doc_links/doc_links_service.ts

pgayvallet

LGTM for platform changes. Did not check the links validity (see https://github.com/elastic/kibana/pull/82081/files#r518631838)

Co-authored-by: Anton Dosov <dosantappdev@gmail.com>

Dosant

LGTM, couple more thoughts below

src/core/public/doc_links/doc_links_service.ts

Dosant · 2020-11-07T07:14:05Z

docs/user/dashboard/url-drilldown.asciidoc

-[[url-drilldown]]
-=== URL drilldown
+[[url_templating-language]]
+=== URL templating language


Should we call this just URL templating instead of URL templating language as this page has information not only about language/syntax, but on variables and various helpers also?

This page now also includes a section about disabling url drilldown feature which doesn't fall into URL templating :(
https://kibana_82081.docs-preview.app.elstc.co/guide/en/kibana/master/url_templating-language.html#disable

Nice catch! I moved around some content, and now it fits nicely on the first page. Let me know what you think!

Co-authored-by: Anton Dosov <dosantappdev@gmail.com>

KOTungseth · 2020-11-09T18:02:08Z

@elasticmachine merge upstream

Dosant

LGTM 🎉

One nit, I don't think it's crucial because that content is a paragraph below:

Dosant · 2020-11-09T18:46:38Z

src/core/public/doc_links/doc_links_service.ts

-          drilldownsTriggerPicker: `${ELASTIC_WEBSITE_URL}guide/en/kibana/${DOC_LINK_VERSION}/url-drilldown.html#trigger-picker`,
-          urlDrilldownTemplateSyntax: `${ELASTIC_WEBSITE_URL}guide/en/kibana/${DOC_LINK_VERSION}/url-drilldown.html#templating`,
-          urlDrilldownVariables: `${ELASTIC_WEBSITE_URL}guide/en/kibana/${DOC_LINK_VERSION}/url-drilldown.html#variables`,
+          drilldownsTriggerPicker: `${ELASTIC_WEBSITE_URL}guide/en/kibana/${DOC_LINK_VERSION}/drilldowns.html#supported-drilldowns`,


I think with last restructure, it would make more sense to link to https://kibana_82081.docs-preview.app.elstc.co/guide/en/kibana/master/drilldowns.html#url-drilldown (this is where we explain triggers)

…into docs/drilldows

kibanamachine · 2020-11-10T00:08:35Z

💚 Build Succeeded

continuous-integration/kibana-ci/pull-request
Commit: 05c8ac3

Metrics [docs]

Page load bundle

Size of the bundles that are downloaded on every page load. Target size is below 100kb

id	before	after	diff
`core`	547.1KB	547.1KB	+5.0B

History

💚 Build #86874 succeeded 2a6cd3d
💚 Build #86829 succeeded 731949d
💚 Build #86515 succeeded c11bc4e
💚 Build #86419 succeeded f83ec1c
💚 Build #86200 succeeded 292d6f0

To update your PR or re-run it, just comment with:
@elasticmachine merge upstream

* [DOCS] Consolidated drilldowns * Review comments pt 1 * Update docs/user/dashboard/drilldowns.asciidoc Co-authored-by: Anton Dosov <dosantappdev@gmail.com> * Fixes supported drilldowns link * Update src/core/public/doc_links/doc_links_service.ts Co-authored-by: Anton Dosov <dosantappdev@gmail.com> * Fixes rogue disable section and fixes intro formatting * Fixes URL drilldown link Co-authored-by: Anton Dosov <dosantappdev@gmail.com> Co-authored-by: Kibana Machine <42973632+kibanamachine@users.noreply.github.com> # Conflicts: # docs/user/dashboard/url-drilldown.asciidoc

…kibana into bootstrap-node-details-overlay * 'bootstrap-node-details-overlay' of github.com:phillipb/kibana: (49 commits) [Security Solution] Fix DNS Network table query (elastic#82778) [Workplace Search] Consolidate groups routes (elastic#83015) Adds cloud links to user menu (elastic#82803) [Security Solution][Detections] - follow up cleanup on auto refresh rules (elastic#83023) [App Search] Added the log retention panel to the Settings page (elastic#82982) [Maps] show icon when layer is filtered by time and allow layers to ignore global time range (elastic#83006) [DOCS] Consolidates drilldown pages (elastic#82081) [Maps] add on-prem EMS config (elastic#82525) migrate i18n mixin to KP (elastic#81799) [bundle optimization] fix imports of react-use lib (elastic#82847) [Discover] Add metric on adding filter (elastic#82961) [Lens] Performance refactoring for indexpattern fast lookup and Operation support matrix computation (elastic#82829) skip flaky suite (elastic#82804) Fix SO query for searching across spaces (elastic#83025) renaming built-in alerts to Stack Alerts (elastic#82873) [TSVB] Disable using top_hits in pipeline aggregations (elastic#82278) [Visualizations] Remove kui usage (elastic#82810) [Visualizations] Make the icon buttons labels more descriptive (elastic#82585) [Lens] Do not reset formatting when switching between custom ranges and auto histogram (elastic#82694) Fix ilm navigation (elastic#81664) ...

…na into alerts/stack-alerts-public * 'alerts/stack-alerts-public' of github.com:gmmorris/kibana: [Security Solution] Fix DNS Network table query (elastic#82778) [Workplace Search] Consolidate groups routes (elastic#83015) Adds cloud links to user menu (elastic#82803) [Security Solution][Detections] - follow up cleanup on auto refresh rules (elastic#83023) [App Search] Added the log retention panel to the Settings page (elastic#82982) [Maps] show icon when layer is filtered by time and allow layers to ignore global time range (elastic#83006) [DOCS] Consolidates drilldown pages (elastic#82081) [Maps] add on-prem EMS config (elastic#82525) migrate i18n mixin to KP (elastic#81799) [bundle optimization] fix imports of react-use lib (elastic#82847) [Discover] Add metric on adding filter (elastic#82961) [Lens] Performance refactoring for indexpattern fast lookup and Operation support matrix computation (elastic#82829) skip flaky suite (elastic#82804) Fix SO query for searching across spaces (elastic#83025) renaming built-in alerts to Stack Alerts (elastic#82873) [TSVB] Disable using top_hits in pipeline aggregations (elastic#82278) [Visualizations] Remove kui usage (elastic#82810) [Visualizations] Make the icon buttons labels more descriptive (elastic#82585) [Lens] Do not reset formatting when switching between custom ranges and auto histogram (elastic#82694) :

* [DOCS] Consolidated drilldowns * Review comments pt 1 * Update docs/user/dashboard/drilldowns.asciidoc Co-authored-by: Anton Dosov <dosantappdev@gmail.com> * Fixes supported drilldowns link * Update src/core/public/doc_links/doc_links_service.ts Co-authored-by: Anton Dosov <dosantappdev@gmail.com> * Fixes rogue disable section and fixes intro formatting * Fixes URL drilldown link Co-authored-by: Anton Dosov <dosantappdev@gmail.com> Co-authored-by: Kibana Machine <42973632+kibanamachine@users.noreply.github.com> # Conflicts: # docs/user/dashboard/url-drilldown.asciidoc

* [DOCS] Consolidates drilldown pages (#82081) * [DOCS] Consolidated drilldowns * Review comments pt 1 * Update docs/user/dashboard/drilldowns.asciidoc Co-authored-by: Anton Dosov <dosantappdev@gmail.com> * Fixes supported drilldowns link * Update src/core/public/doc_links/doc_links_service.ts Co-authored-by: Anton Dosov <dosantappdev@gmail.com> * Fixes rogue disable section and fixes intro formatting * Fixes URL drilldown link Co-authored-by: Anton Dosov <dosantappdev@gmail.com> Co-authored-by: Kibana Machine <42973632+kibanamachine@users.noreply.github.com> # Conflicts: # docs/user/dashboard/url-drilldown.asciidoc * Fixes drilldown links Co-authored-by: Kibana Machine <42973632+kibanamachine@users.noreply.github.com>

[DOCS] Consolidated drilldowns

26206a4

KOTungseth added Team:Docs release_note:skip Skip the PR/issue when compiling release notes v7.10.0 labels Oct 29, 2020

KOTungseth requested a review from Dosant October 29, 2020 21:21

KOTungseth self-assigned this Oct 29, 2020

Dosant reviewed Oct 30, 2020

View reviewed changes

docs/user/dashboard/drilldowns.asciidoc Outdated Show resolved Hide resolved

docs/user/dashboard/drilldowns.asciidoc Outdated Show resolved Hide resolved

hendry-lim suggested changes Nov 1, 2020

View reviewed changes

KOTungseth changed the title ~~[DOCS] Consolidated drilldown pages~~ [DOCS] Consolidates drilldown pages Nov 5, 2020

Review comments pt 1

01fd8e3

KOTungseth requested a review from a team as a code owner November 5, 2020 18:02

Merge branch 'master' into docs/drilldows

292d6f0

Dosant reviewed Nov 6, 2020

View reviewed changes

docs/user/dashboard/drilldowns.asciidoc Outdated Show resolved Hide resolved

src/core/public/doc_links/doc_links_service.ts Outdated Show resolved Hide resolved

pgayvallet approved these changes Nov 6, 2020

View reviewed changes

KOTungseth and others added 2 commits November 6, 2020 08:55

Update docs/user/dashboard/drilldowns.asciidoc

f83ec1c

Co-authored-by: Anton Dosov <dosantappdev@gmail.com>

Fixes supported drilldowns link

c11bc4e

Dosant reviewed Nov 7, 2020

View reviewed changes

KOTungseth and others added 3 commits November 9, 2020 10:43

Update src/core/public/doc_links/doc_links_service.ts

731949d

Co-authored-by: Anton Dosov <dosantappdev@gmail.com>

Fixes rogue disable section and fixes intro formatting

af2f4a8

Fixes rogue disable section and fixes intro formatting

244f401

Merge branch 'master' into docs/drilldows

2a6cd3d

Dosant approved these changes Nov 9, 2020

View reviewed changes

KOTungseth added 2 commits November 9, 2020 16:20

Fixes URL drilldown link

ca7a52f

Merge branch 'docs/drilldows' of https://github.com/KOTungseth/kibana …

05c8ac3

…into docs/drilldows

KOTungseth merged commit 1b86d79 into elastic:master Nov 10, 2020

KOTungseth deleted the docs/drilldows branch November 10, 2020 15:11

KOTungseth mentioned this pull request Nov 10, 2020

[7.x] [DOCS] Consolidates drilldown pages (#82081) #83069

Merged

KOTungseth mentioned this pull request Nov 10, 2020

[7.10] [DOCS] Consolidates drilldown pages (#82081) #83070

Merged

This was referenced Nov 12, 2020

[Docs] URL drilldown docs link to 404 #83268

Closed

Redirects for drilldown links #83325

Closed

Conversation

KOTungseth commented Oct 29, 2020

Summary

Checklist

Uh oh!

elasticmachine commented Oct 29, 2020

Uh oh!

Dosant left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

hendry-lim left a comment

Choose a reason for hiding this comment

Uh oh!

hendry-lim Nov 1, 2020

Choose a reason for hiding this comment

Uh oh!

KOTungseth Nov 5, 2020

Choose a reason for hiding this comment

Uh oh!

Dosant Nov 6, 2020

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

pgayvallet left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Dosant left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Dosant Nov 7, 2020

Choose a reason for hiding this comment

Uh oh!

Dosant Nov 7, 2020

Choose a reason for hiding this comment

Uh oh!

KOTungseth Nov 9, 2020

Choose a reason for hiding this comment

Uh oh!

KOTungseth commented Nov 9, 2020

Uh oh!

Dosant left a comment

Choose a reason for hiding this comment

Uh oh!

Dosant Nov 9, 2020

Choose a reason for hiding this comment

Uh oh!

kibanamachine commented Nov 10, 2020

💚 Build Succeeded

Metrics [docs]

Page load bundle

History

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

pgayvallet left a comment •

edited

Loading

Dosant left a comment •

edited

Loading