Getting Started page

[ycombinator]

The original PR for this feature was #11673. Unfortunately it had to be reverted because it was failing the build. This PR re-introduces the changes made in #11673, along with any changes to functional tests in order to get the build green.

This PR has 4 commits: d16d1fb, f77e0a0, bdda576, and 6982dfb. Of these, bdda576 and 6982dfb are the actual new commits that fix the build. The other two commits are cherry-picked over from the original Getting Started PR (211b3d4) and a follow up testbed cleanup PR (ab0cfb3).

This PR implements a Getting Started page for first-time users of Kibana.

Why is this important

First-run Kibana experience is increasingly the first time the user interacts with the Elastic stack. The current out of the box experience in Kibana is to land on the index pattern creation page, when there are no existing index patterns, and that page is really unfriendly (see here).

What does this page look like

This page can be accessed under two scenarios, and looks slightly different under each scenario:

1. When the user has never defined any index patterns defined AND the user has not explicitly opted out of the Getting Started page. The user must be shown the Getting Started page by default, regardless of which Kibana app they try and visit (manually, because the navigation is hidden from view).

   Screenshot:

   

2. When there are index patterns defined OR the user has explicitly opted out of the Getting Started page. In this case the user can perform business as usual around Kibana. However, they may re-visit the Getting Started page if they like from Management > Kibana > Getting Started.

   Screenshot:

   

Additionally, orthogonal to the two scenarios described above, the page has a couple of optional sections as well, that may be populated dynamically. The two sections are:

• A horizontal (row-like) section in between the Kibana logo and the two boxes. This section can accept a string of formatted text and display it.
• A third "Manage and Monitor" box that would show up to the right of the "Visualize and explore" box. The section can accept an array of message strings (sentences). The message strings are concatenated and displayed as a paragraph.

Screenshot showing both optional sections populated:

What's in the box

This PR:

• Implements a new core plugin called getting_started, that implements the controller and template of the Getting Started page, along with the routing and logic on when the page should be shown to the user.

• Provides a registry for dynamically populating the two optional sections in the Getting Started page.

• Provides an attribute directive, kbnGettingStartedOptOut that clickable elements (links, buttons) on the Getting Started Page can use to opt users out of the Getting Started page as they navigate away.

• Consolidates logic for defining default index patterns into the logic for showing the Getting Started page under Scenario 1 (described above). Without this consolidation there was a race condition which would cause the Getting Started page to be displayed along with a Notifier message about no default index pattern being defined if the user tried to visit a Kibana app (e.g. Discover).

• Includes SVG images for various logos.

What to test

1. Delete all index patterns (by directly manipulating the .kibana index, and not via the Index Patterns UI), then load up Kibana. You should see the Getting Started page as described under Scenario 1 above. Attempting to visit another Kibana app (e.g. Discover) should bring you back to the Getting Started page.

2. Opt out of the Getting Started page by clicking the link in the top right. This decision is recorded in localStorage in the key, kibana.isGettingStartedOptedOut. You should see the nav again and be able to visit other Kibana apps. However, visiting a Kibana app that requires an index pattern (i.e. Discover, Visualize, or Dashboard) should take you to the index patterns page with a Notifier about there being no default index pattern (same as before this PR).

3. Delete the localStorage key kibana.isGettingStartedOptedOut. Refresh Kibana. You should be back in Scenario 1. Now click on the link in the "Visualize and explore" box on the Getting Started page. This should opt you out of the Getting Started page.

4. Once you have opted out of the Getting Started page or index patterns exist, try visiting the Getting Started page via Management > Kibana > Getting Started. Check that it looks and functions as described in Scenario 2 above.

5. Try dynamically registering content for both optional sections on the Getting Started page and ensure that it shows up as expected. The code to do this is:

   import { GettingStartedTopMessagesRegistryProvider } from 'ui/getting_started/top_messages_registry';
   
   GettingStartedTopMessagesRegistryProvider.register(() => ({
     template: `Hello there, I'm on top!`
   }));

   import { GettingStartedMonitorAndManageMessagesRegistryProvider } from 'ui/getting_started/monitor_and_manage_messages_registry';
   
   GettingStartedMonitorAndManageMessagesRegistryProvider.register(() => ({
     template: `Hello there, I'm in the right-most box!`
   }));

/cc @tbragin @skearns64 @alexfrancoeur

For Release Notes

Summary: Introduces a Getting Started page in Kibana for first-time users. Previously we would drop first-time users onto the Index Patterns page, without providing much context for why they were there or good instructions on what to do next. The Getting Started page provides a short introduction to Kibana and a link to the Index Patterns page along with some context around when and why to use it.

[kobelb]

LGTM - pending CI builds going green

[ycombinator]

Backported to:

• 5.x / 5.5: 547feb1