[TSVB] Documents the new index pattern mode #102880

stratoula · 2021-06-22T10:05:38Z

Summary

In our effort to push more users to use the index pattern mode I:

Added a section for it on TSVB docs. You can see the preview here:
https://kibana_102880.docs-preview.app.elstc.co/guide/en/kibana/master/tsvb.html#tsvb-index-pattern-mode
Added a callout to TSVB

Update: After discussing it with the design team, the callout appears only for old visualizations that use the string mode. We also give the users the ability to dismiss the notification.

How to test it

For the new visualizations (and the sample data as we have updated them to use the index pattern mode) the callout should be hidden
Import this https://gist.github.com/stratoula/c936605bed52b02b0278ba872096598f (7.12.1 visualization). Callout should be visible and not appear again after it is dismissed.

Checklist

Any text added follows EUI's writing guidelines, uses sentence case text and includes i18n support
Documentation was added for features that require explanation or tutorials

stratoula · 2021-06-22T14:12:33Z

@elastic/kibana-design wdyt about the Callout?

Some info about this:

Unfortunately, for the already created TSVB viz (before 7.13), if they want to use the new mode (which unlocks many cool features such as runtime fields), they have to do it manually. (We cant use the migration system here). So this PR tries to introduce the new feature with a callout and the updated documentation.

I also tried to use the EuiTour component but it doesn't work very well with the popovers. I think that the callout is a good solution as we are planning (in future minors) to add a warning to inform the users that we are going to deprecate the old mechanism.

@gchaps @KOTungseth can you also check the text, both on the UI and the docs section

Thank you all ❤️

MichaelMarcialis · 2021-06-24T20:33:35Z

@elastic/kibana-design wdyt about the Callout?

As I understand it, the new index pattern mode is turned on by default. Is that correct? If so, am I also correct in understanding that any TSVB visualization created before the introduction of this new index pattern mode has the feature turned off, so as not to break past work?

Assuming all the above is correct, I'd suggest conditionally showing this callout only when it has been detected that the user is opening a previously saved TSVB visualization from before the feature was available and thus has it turned off. TSVB visualizations with the feature turned on and newly created TSVB visualizations where the user has intentionally turned off the feature should be omitted from seeing the callout.

Finally, I'd also suggest including a way to dismiss the callout to keep from annoying users who no longer wish to see it.

stratoula · 2021-06-28T06:18:15Z

@elasticmachine merge upstream

stratoula · 2021-06-28T06:20:04Z

@MichaelMarcialis correct, it is in on by default except from the old visualizations.
I agree with your recommendations, will update my PR 🙂

elasticmachine · 2021-06-28T10:54:28Z

Pinging @elastic/kibana-app (Team:KibanaApp)

gchaps · 2021-06-28T23:23:44Z

How about something like this for the message

Title: TSVB introduces a new index pattern mode

Great news! A new index pattern mode with support for runtime fields and improved performance is now available in TSVB. Give it a try.

Dismiss

stratoula · 2021-06-29T07:51:10Z

@KOTungseth @gchaps Can you also check the documentation added here? ❤️

stratoula · 2021-06-29T08:03:04Z

Thanx @gchaps. Changes here:

KOTungseth · 2021-06-29T14:53:16Z

Instead of calling this index pattern mode, can we call out the specific new functionality that is now provided to our users? This is why I used You can now visualize the data from Elasticsearch indices or Kibana index patterns. Check it out {indexPatternModeLink}. in my comment above.

I don't think users will relate to index pattern mode as much as they will relate to visualize the data from Elasticsearch indices.

ghudgins · 2021-06-29T15:42:05Z

I agree with @KOTungseth that Index pattern mode isn't quite right. the below seems to blend both @gchaps and @KOTungseth's suggestions. I only tweaked the title - TSVB now supports index patterns

Great news! You can now visualize the data from Elasticsearch indices or Kibana index patterns. Check it out {indexPatternModeLink}.

stratoula · 2021-06-30T05:43:23Z

@elasticmachine merge upstream

stratoula · 2021-06-30T11:02:58Z

And here it is!

src/plugins/vis_type_timeseries/public/application/components/vis_editor.tsx

docs/user/dashboard/tsvb.asciidoc

Co-authored-by: Kaarina Tungseth <[email protected]>

stratoula · 2021-06-30T19:41:40Z

@elasticmachine merge upstream

stratoula · 2021-07-01T05:50:58Z

@elasticmachine merge upstream

kibanamachine · 2021-07-01T07:55:11Z

💚 Build Succeeded

Metrics [docs]

Module Count

Fewer modules leads to a faster build time

id	before	after	diff
`visTypeTimeseries`	535	539	+4

Async chunks

Total size of all lazy-loaded chunks that will be downloaded as the user navigates the app

id	before	after	diff
`visTypeTimeseries`	1002.2KB	1007.3KB	+5.0KB

Page load bundle

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

id	before	after	diff
`core`	419.9KB	420.0KB	+69.0B

History

💛 Build #135778 was flaky 5b745bc
💚 Build #135767 succeeded 6e93830
💚 Build #135758 succeeded 6e93830
💚 Build #135746 succeeded ed223fd
💚 Build #135743 succeeded 15e37a5

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

kertal

LGTM, tested locally in Chrome, Firefox, Safari, works as expected 👍

* [TSVB] Document the new index pattern mode * Add a callout to TSVB to advertise the new index pattern mode * Conditionally render the callout, give capability to dismiss it * Fix i18n * Update the notification texts * Update notification text * Change callout storage key * add UseIndexPatternModeCallout component * Update docs/user/dashboard/tsvb.asciidoc Co-authored-by: Kaarina Tungseth <[email protected]> * Update docs/user/dashboard/tsvb.asciidoc Co-authored-by: Kaarina Tungseth <[email protected]> * Update docs/user/dashboard/tsvb.asciidoc Co-authored-by: Kaarina Tungseth <[email protected]> * Update docs/user/dashboard/tsvb.asciidoc Co-authored-by: Kaarina Tungseth <[email protected]> * Update docs/user/dashboard/tsvb.asciidoc Co-authored-by: Kaarina Tungseth <[email protected]> * Update docs/user/dashboard/tsvb.asciidoc Co-authored-by: Kaarina Tungseth <[email protected]> * Update docs/user/dashboard/tsvb.asciidoc Co-authored-by: Kaarina Tungseth <[email protected]> * Update docs/user/dashboard/tsvb.asciidoc Co-authored-by: Kaarina Tungseth <[email protected]> * Final docs changes * Remove TSVB from title Co-authored-by: Kibana Machine <[email protected]> Co-authored-by: Alexey Antonov <[email protected]> Co-authored-by: Kaarina Tungseth <[email protected]>

* [TSVB] Document the new index pattern mode * Add a callout to TSVB to advertise the new index pattern mode * Conditionally render the callout, give capability to dismiss it * Fix i18n * Update the notification texts * Update notification text * Change callout storage key * add UseIndexPatternModeCallout component * Update docs/user/dashboard/tsvb.asciidoc Co-authored-by: Kaarina Tungseth <[email protected]> * Update docs/user/dashboard/tsvb.asciidoc Co-authored-by: Kaarina Tungseth <[email protected]> * Update docs/user/dashboard/tsvb.asciidoc Co-authored-by: Kaarina Tungseth <[email protected]> * Update docs/user/dashboard/tsvb.asciidoc Co-authored-by: Kaarina Tungseth <[email protected]> * Update docs/user/dashboard/tsvb.asciidoc Co-authored-by: Kaarina Tungseth <[email protected]> * Update docs/user/dashboard/tsvb.asciidoc Co-authored-by: Kaarina Tungseth <[email protected]> * Update docs/user/dashboard/tsvb.asciidoc Co-authored-by: Kaarina Tungseth <[email protected]> * Update docs/user/dashboard/tsvb.asciidoc Co-authored-by: Kaarina Tungseth <[email protected]> * Final docs changes * Remove TSVB from title Co-authored-by: Kibana Machine <[email protected]> Co-authored-by: Alexey Antonov <[email protected]> Co-authored-by: Kaarina Tungseth <[email protected]> Co-authored-by: Kibana Machine <[email protected]> Co-authored-by: Alexey Antonov <[email protected]> Co-authored-by: Kaarina Tungseth <[email protected]>

stratoula added 2 commits June 22, 2021 13:03

[TSVB] Document the new index pattern mode

69bec7e

Add a callout to TSVB to advertise the new index pattern mode

c62574c

stratoula changed the title ~~[TSVB] Document the new index pattern mode~~ [TSVB] Documents the new index pattern mode Jun 22, 2021

Merge branch 'master' into tsvb-new-mode-docs

64022b6

Conditionally render the callout, give capability to dismiss it

35e3003

stratoula added Feature:TSVB TSVB (Time Series Visual Builder) release_note:skip Skip the PR/issue when compiling release notes v7.14.0 v8.0.0 labels Jun 28, 2021

Fix i18n

9294730

stratoula marked this pull request as ready for review June 28, 2021 10:54

stratoula requested a review from a team June 28, 2021 10:54

stratoula requested a review from a team as a code owner June 28, 2021 10:54

stratoula added the Team:Visualizations Visualization editors, elastic-charts and infrastructure label Jun 28, 2021

lukeelmers approved these changes Jun 28, 2021

View reviewed changes

Update the notification texts

0c9006c

kibanamachine and others added 2 commits June 30, 2021 01:43

Merge branch 'master' into tsvb-new-mode-docs

12597d6

Update notification text

d319695

KOTungseth reviewed Jun 30, 2021

View reviewed changes

src/plugins/vis_type_timeseries/public/application/components/vis_editor.tsx Outdated Show resolved Hide resolved

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

spalger added v7.15.0 and removed v7.14.0 labels Jun 30, 2021

KOTungseth reviewed Jun 30, 2021

View reviewed changes

stratoula and others added 10 commits June 30, 2021 21:37

Update docs/user/dashboard/tsvb.asciidoc

2567226

Co-authored-by: Kaarina Tungseth <[email protected]>

Update docs/user/dashboard/tsvb.asciidoc

61e48a8

Co-authored-by: Kaarina Tungseth <[email protected]>

Update docs/user/dashboard/tsvb.asciidoc

85c6fb9

Co-authored-by: Kaarina Tungseth <[email protected]>

Update docs/user/dashboard/tsvb.asciidoc

c9ad51b

Co-authored-by: Kaarina Tungseth <[email protected]>

Update docs/user/dashboard/tsvb.asciidoc

15e37a5

Co-authored-by: Kaarina Tungseth <[email protected]>

Update docs/user/dashboard/tsvb.asciidoc

9e0e9dd

Co-authored-by: Kaarina Tungseth <[email protected]>

Update docs/user/dashboard/tsvb.asciidoc

c5dfc2e

Co-authored-by: Kaarina Tungseth <[email protected]>

Update docs/user/dashboard/tsvb.asciidoc

ed223fd

Co-authored-by: Kaarina Tungseth <[email protected]>

Final docs changes

7081397

Remove TSVB from title

08a5d3d

stratoula added the v7.14.0 label Jun 30, 2021

Merge branch 'master' into tsvb-new-mode-docs

6e93830

Merge branch 'master' into tsvb-new-mode-docs

5b745bc

Merge branch 'master' into tsvb-new-mode-docs

e56a86e

kertal approved these changes Jul 1, 2021

View reviewed changes

stratoula merged commit c52e0e1 into elastic:master Jul 1, 2021

stratoula mentioned this pull request Jul 1, 2021

[7.x] [TSVB] Documents the new index pattern mode (#102880) #104063

Merged

stratoula mentioned this pull request Jul 1, 2021

[7.14] [TSVB] Documents the new index pattern mode (#102880) #104064

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[TSVB] Documents the new index pattern mode #102880

[TSVB] Documents the new index pattern mode #102880

stratoula commented Jun 22, 2021 •

edited

Loading

stratoula commented Jun 22, 2021 •

edited

Loading

MichaelMarcialis commented Jun 24, 2021

stratoula commented Jun 28, 2021

stratoula commented Jun 28, 2021

elasticmachine commented Jun 28, 2021

gchaps commented Jun 28, 2021

stratoula commented Jun 29, 2021 •

edited

Loading

stratoula commented Jun 29, 2021

KOTungseth commented Jun 29, 2021 •

edited

Loading

ghudgins commented Jun 29, 2021 •

edited

Loading

stratoula commented Jun 30, 2021

stratoula commented Jun 30, 2021

stratoula commented Jun 30, 2021

stratoula commented Jul 1, 2021

kibanamachine commented Jul 1, 2021

kertal left a comment

[TSVB] Documents the new index pattern mode #102880

[TSVB] Documents the new index pattern mode #102880

Conversation

stratoula commented Jun 22, 2021 • edited Loading

Summary

How to test it

Checklist

stratoula commented Jun 22, 2021 • edited Loading

MichaelMarcialis commented Jun 24, 2021

stratoula commented Jun 28, 2021

stratoula commented Jun 28, 2021

elasticmachine commented Jun 28, 2021

gchaps commented Jun 28, 2021

stratoula commented Jun 29, 2021 • edited Loading

stratoula commented Jun 29, 2021

KOTungseth commented Jun 29, 2021 • edited Loading

ghudgins commented Jun 29, 2021 • edited Loading

stratoula commented Jun 30, 2021

stratoula commented Jun 30, 2021

stratoula commented Jun 30, 2021

stratoula commented Jul 1, 2021

kibanamachine commented Jul 1, 2021

💚 Build Succeeded

Metrics [docs]

Module Count

Async chunks

Page load bundle

History

kertal left a comment

Choose a reason for hiding this comment

stratoula commented Jun 22, 2021 •

edited

Loading

stratoula commented Jun 22, 2021 •

edited

Loading

stratoula commented Jun 29, 2021 •

edited

Loading

KOTungseth commented Jun 29, 2021 •

edited

Loading

ghudgins commented Jun 29, 2021 •

edited

Loading