Add a welcome screen for new Kibana instances #21353
Conversation
New is determined by whether or not there are any index patterns defined.
💔 Build Failed |
💔 Build Failed |
💚 Build Succeeded |
💚 Build Succeeded |
chrisdavies
changed the title
chrisdavies
changed the title
💔 Build Failed |
chrisdavies
changed the title
💚 Build Succeeded |
|
Looking good @chrisdavies! I'm wondering if we should explicitly call out Kibana 7 here or instead just say
I saw some chatter in the design channel, were you ever able to get any help with icons here? Skip the tour I know what I'm doing works unless for some reason a user clears cache and opens Kibana up again. Though I seriously doubt that would be the case. We've taken similar approaches storing this type of metadata locally with recently viewed and recent time selections. This works for me. I'd like to get some more sample data into Kibana for 6.5 so that there are options to choose from. I know in the past @snide had talked about showing the sample data cards as a second navigation within the splash screen vs. dropping them into the Add Data card tabular UI. What are your thoughts here @snide @cchaos? Is the approach Chris is taking fine? The current experience can be seen below:
I have no idea why the GIF is being optimized by GitHub but it's ruing the recording. Either way, I just wanted to show the navigation Also, the fade in does quickly show Kibana, just for a moment. I think it's noted above but is there no way to fade from the loading indicator directly to the splash screen? It's not as bad as a flicker, but it is noticeable |
|
This is planned for design cleanup and copy changes, we'll jump in when it's close. Couple thoughts from the product side. The original design assumed we were leading people on some sort of tour. We're no longer doing that and the premise seems to be to simply install sample data. That's fine, but then we might just want to focus this page on that action, listing the sample data (as cards, the same we do in the sample data page) and allowing people to install it directly. The only other action then is essentially some version of "I don't want sample data" and that should just lead directly to Kibana Home and local_store that decision. A lot of this (including the current sample data list) is pretty awkward when we only have one item to choose from. We should make sure we're committing to providing more if we're going with these layouts. Agree all the loading is awkward. I wouldn't worry about the fades, this can just be a direct page. |
|
@snide What do you mean by "this can just be a direct page"? Totally agree that we need more sample data. Regarding the fade in / flicker, I have a few possible workarounds:
All of those are unfortunately complex, though. |
|
Basically rather than the loading the page as a fade on top of home, load it as its own page outside of the chrome, but it sounds like you can't do that easily. My opinion is that Kibana has enough hacks. If the new platform can solve your loading issue, then I think we just address then fade then, rather than bridging the gap to fake it till then. The fade isn't the end of the world. I agree it's weird. You might be able to just do this stuff in a small modal (where the fade would look more natural). But that layout really depends upon how many sample data sets we plan on loading (it wouldn't be able to handle a lot). I'll leave it to @alexfrancoeur. I can clean up whatever implementation product feels is best. |
|
just checked out the PR, looking great @chrisdavies @ryankeairns! |
|
After checking out the fade in locally, I would reiterate what Dave said in an earlier comment - it's not the end of the world. Is it a little awkward? yeah. Is it worth a hacky solution when (it sounds like) future platform changes will negate it? probably not. In a somewhat odd way, the copy in the welcome screen sorta informs you why this screen just faded in... we were checking your setup and noticed there was no data. Then, clicking either button quickly returns you to the view that flashed up front. This is me rationalizing, but it feels acceptable. |
💔 Build Failed |
💔 Build Failed |
|
Jenkins test this. I think the failure is not this PR. |
💚 Build Succeeded |
💔 Build Failed |
💚 Build Succeeded |
|
|
💚 Build Succeeded |
Add a welcome screen to Kibana home if this is a new Kibana instance. New is determined by whether or not there are any index patterns defined. Local storage is used to retain the user's decision to hide the welcome screen.
This addresses #18828.
The welcome screen should show when you view
#/home, if there are no index patterns. It should allow you to bypass it by heading over to other screens (e.g.#/management). You should also be able to toggle the welcome screen by heading over to#/management/kibana/settings, and togglingShow the welcome screen.This change introduces a delay to the home screen, as we need to query for the existence of data prior to rendering. One thing we might consider doing is adding a max-timeout for that query, and if it hasn't returned in a reasonable time, just show the normal home page. For poor connections, this should improve the experience.
Clicking "I don't need help" should hide the welcome screen forever. This is done on a per-browser basis via
localStorage.Clicking "Play around with sample data" should bring you to the sample data screen.
Fade in
The welcome screen fades in right now, as there doesn't appear to be a good way for us to keep the loading indicator up until the welcome screen has rendered. (A good way to do that is coming in the new platform.) Without the fade in, there is a bad flicker effect.
Flaky tests
This is a potential source of flaky tests. :/ The welcome screen will show up after a delay (after it's queried Elasticsearch to determine whether or not this is a new Kibana instance). This means that any tests that expect the old home screen might pass if they run fast enough to happen before the welcome screen shows up. I'm not sure how to fix this. We could disable the welcome screen by default for test scenarios, and then enable it only for explicit welcome screen tests.
Alternatively, we could hack the UI on the home screen so that the Kibana loading indicator shows up until we've done our query, then we'd show the welcome screen or the home screen, depending on the result of the query. This would have a secondary benefit of avoiding the flash / blink effect caused by the page rendering, then a bit later the welcome screen showing up. I don't know of a good way to accomplish this without resorting to serious hacks, though, as I don't see a good way to tell Kibana to keep the loading screen up until the current app says to remove it.
Global settings
Another note for review is that I'm using a combination of localStorage and the uiSettingsClient to save / load whether or not the welcome screen has been dismissed. This means that if one user dismisses the welcome screen, it's dismissed only for their browser. Incognito or another browser will show the welcome screen again. I'm using a setting in uiSettingsClient to enable the welcome screen to be disabled system-wide. Is uiSettingsClient the right tool for that job?
Testing
#/management/kibana/settings#/homenode scripts/makelogs#/managementand define an index pattern#/home