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.

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

[Guided onboarding] Setup guide panel component #140836

Merged

Conversation

alisonelizabeth
Copy link
Contributor

@alisonelizabeth alisonelizabeth commented Sep 15, 2022

This PR polishes the setup guide button and dropdown panel to align with latest design.

Addresses #138557, #139751

How to test

  1. Start up Kibana with the example plugins enabled: yarn start --run-examples
  2. Navigate to /app/guidedOnboardingExample
  3. You can click the "Search" guide example to trigger the guide

What's missing

This PR is the first step to polish the setup guide component. There is additional work that will be addressed in follow-up PRs:

Screenshots

Screen Shot 2022-09-19 at 12 37 13 PM

@@ -26,7 +26,7 @@ import {
} from '@elastic/eui';
import {
GuidedOnboardingPluginStart,
GuidedOnboardingState,
SetupGuideState,
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I renamed this interface and other areas in the code to "setupGuide..." to better align with the name of the actual component. However, if you feel this causes more confusion than not (i.e., the plugin is still called guided_onboarding), I can revert this change.

Copy link
Contributor

@yuliacech yuliacech left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hi @alisonelizabeth, thanks a lot for cleaning up the code! Changes LGTM.
About the naming of the variables and components: I think the word "setup" is a bit confusing because for me it has something to do with the plugin setup. So for the component I'm thinking if "checklist" might be better? And for the state, for now "GuidedOnboardingState" seems clearer to me. Maybe though we could use "guided setup" in both cases instead?

@alisonelizabeth
Copy link
Contributor Author

alisonelizabeth commented Sep 20, 2022

Thanks @yuliacech for the review!

I ended up leaving GuidedOnboardingState named as-is. I think it's out of scope for this particular PR. We can reassess as we continue working on this if it makes sense to rename or not. All the component-related work I updated to use the term "guide-" to keep it simple.

I also added some very lightweight component tests. I expect to build upon these as we continue working on this project.

@alisonelizabeth alisonelizabeth marked this pull request as ready for review September 20, 2022 19:16
@alisonelizabeth alisonelizabeth requested a review from a team as a code owner September 20, 2022 19:16
@elasticmachine
Copy link
Contributor

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

@alisonelizabeth alisonelizabeth added the release_note:skip Skip the PR/issue when compiling release notes label Sep 20, 2022
@alisonelizabeth
Copy link
Contributor Author

@elasticmachine merge upstream

@cindychangy
Copy link
Contributor

cindychangy commented Sep 21, 2022

@alisonelizabeth: I checked this locally and overall it looks good to me 🙂, there are two things I wanted to note (please ignore if these are to be added later):

  • Currently when a step is open, the other steps are not expandable when clicked, but we would like them to be. We want the user to be able to view the details of the other steps but only be able to start the current step as that one will be the only one with the start button.

  • There are some custom stylings for the panel located in a global stylesheet. Sorry on my end, if that was unclear. This file has styles that control the accordion titles to be black when active and gray when inactive and the progress labels.

@alisonelizabeth
Copy link
Contributor Author

Thanks for the feedback @cindychangy!

Currently when a step is open, the other steps are not expandable when clicked, but we would like them to be. We want the user to be able to view the details of the other steps but only be able to start the current step as that one will be the only one with the start button.

Thanks for pointing this out! I will address this in a follow-up PR. I've opened #141223 to track misc design feedback.

This file has styles that control the accordion titles to be black when active and gray when inactive and the progress labels.

👍 This should be addressed as part of #140981. Let me know if I missed anything though in the issue description.

@kibana-ci
Copy link
Collaborator

💚 Build Succeeded

Metrics [docs]

Module Count

Fewer modules leads to a faster build time

id before after diff
guidedOnboarding 13 16 +3

Page load bundle

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

id before after diff
guidedOnboarding 11.7KB 15.5KB +3.8KB

History

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

@alisonelizabeth alisonelizabeth merged commit ccca9cc into elastic:main Sep 21, 2022
@alisonelizabeth alisonelizabeth deleted the guided_onboarding/panel_component branch September 21, 2022 13:59
@kibanamachine kibanamachine added v8.5.0 backport:skip This commit does not require backporting labels Sep 21, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backport:skip This commit does not require backporting release_note:skip Skip the PR/issue when compiling release notes Team:Journey/Onboarding Platform Journey Onboarding team v8.5.0
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants