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.

Sign up for GitHub

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

Jump to bottom

[Guided onboarding] Setup guide button show/hide behavior #141129

Closed
alisonelizabeth opened this issue Sep 20, 2022 · 1 comment · Fixed by #144634
Closed

[Guided onboarding] Setup guide button show/hide behavior #141129

alisonelizabeth opened this issue Sep 20, 2022 · 1 comment · Fixed by #144634
Assignees
@yuliacech
Labels
8.6 candidate enhancement New value added to drive a business result Team:Journey/Onboarding Platform Journey Onboarding team

Comments

@alisonelizabeth
Copy link
Contributor

alisonelizabeth commented Sep 20, 2022 •
edited by yuliacech
Loading

We should implement the following logic to show or hide the "Setup guide" button in the header:

  • There is a timeout period that is considered "active" onboarding period. For 8.6 the period is 30 days is hard coded in the plugin. We can make this period configurable in future releases.
  • During the "active" onboarding period, the header button is displayed
    • if the guide is active and it opens the dropdown panel on click
    • if the user skipped the guided onboarding on the landing page, has not started any guide yet or quit a guide. The button navigates the user back to the landing page. The button label is "Launch setup guide".
    • not displayed if the user completed a guide
  • After the "active" period, the header button is only displayed if a guide is active. Otherwise, the button is hidden and the user can get to the landing page via a help link or a link on the home page.

Screen Shot 2022-10-17 at 12 52 06 PM
@alisonelizabeth alisonelizabeth added enhancement New value added to drive a business result 8.6 candidate Team:Journey/Onboarding Platform Journey Onboarding team labels Sep 20, 2022
@elasticmachine
Copy link
Contributor

Pinging @elastic/platform-onboarding (Team:Journey/Onboarding)

@alisonelizabeth alisonelizabeth changed the title [Guided onboarding] Setup guide button inactive behavior [Guided onboarding] Setup guide button show/hide behavior Sep 20, 2022
@alisonelizabeth alisonelizabeth mentioned this issue Oct 5, 2022
Merged
@alisonelizabeth alisonelizabeth self-assigned this Oct 5, 2022
@yuliacech yuliacech mentioned this issue Nov 3, 2022
Closed
This was referenced Nov 10, 2022
Closed
Merged
yuliacech added a commit that referenced this issue Nov 14, 2022
@yuliacech @kibanamachine
[Guided onboarding] Update header button logic (#144634)
879b101 
## Summary
Fixes #141129
Fixes #144515

This PR introduces a new state to the guided onboarding plugin. The
state keeps track of the `creationDate` and of the overall `status` of
the plugin. The creation date allows us to detect an "active" period
during which the header button will be displayed more prominently in the
header. Currently, the active period is set to 30 days. During this
time, if the user has not started any guide, has quit a guide before
completion or skipped the guide on the landing page, the header button
will be displayed and when clicked, redirect the user to the landing
page to start/continue a guide.
Also this PR adds a check for Cloud deployments and prevents the code
from sending any API requests when not on Cloud, because guided
onboarding is disabled on prem.

#### Screenshot 
<img width="298" alt="Screenshot 2022-11-10 at 18 42 18"
src="https://user-images.githubusercontent.com/6585477/201168414-391a7cd4-0709-492b-9001-1432b5bed3c8.png">



### Checklist

- [x] Any text added follows [EUI's writing
guidelines](https://elastic.github.io/eui/#/guidelines/writing), uses
sentence case text and includes [i18n
support](https://github.com/elastic/kibana/blob/main/packages/kbn-i18n/README.md)
- [x] [Unit or functional
tests](https://www.elastic.co/guide/en/kibana/master/development-tests.html)
were updated or added to match the most common scenarios

Co-authored-by: kibanamachine <42973632+kibanamachine@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@yuliacech yuliacech

Labels
8.6 candidate enhancement New value added to drive a business result Team:Journey/Onboarding Platform Journey Onboarding team
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

[Guided onboarding] Update header button logic yuliacech/kibana
3 participants
@alisonelizabeth @yuliacech @elasticmachine