Skip to content

[Guided onboarding] Add a config for test guide#143973

Merged
yuliacech merged 8 commits intoelastic:mainfrom
yuliacech:guided_onboarding/8.6_testing_guide_config
Oct 27, 2022
Merged

[Guided onboarding] Add a config for test guide#143973
yuliacech merged 8 commits intoelastic:mainfrom
yuliacech:guided_onboarding/8.6_testing_guide_config

Conversation

@yuliacech
Copy link
Contributor

@yuliacech yuliacech commented Oct 25, 2022

Summary

Fixes #143392

This PR adds a 4th guide config that is used for unit tests. This test guide can also be used for e2e tests (#138568). In follow up work we want to also add storybook for UI components and mocks for other guides for testing.

@yuliacech yuliacech marked this pull request as ready for review October 26, 2022 14:04
@yuliacech yuliacech requested a review from a team as a code owner October 26, 2022 14:04
@alisonelizabeth alisonelizabeth added release_note:skip Skip the PR/issue when compiling release notes Team:Journey/Onboarding Platform Journey Onboarding team labels Oct 26, 2022
@elasticmachine
Copy link
Contributor

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

Copy link
Contributor

@alisonelizabeth alisonelizabeth left a comment

Choose a reason for hiding this comment

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

Thanks for working on this @yuliacech! I left a few comments on the PR that I'd like to see addressed before merging, but I'm going to go ahead and approve to not block you.

Also, I noticed for the last step that the "Continue using Elastic" button shows before the "Mark done" button is clicked. I think this might be a bug. Do you mind taking a look and open up a separate issue if so? Thanks!

Screen Shot 2022-10-26 at 8 06 59 PM

descriptionList: [
`This step is directly completed by clicking the button that uses the API function 'completeGuideStep`,
'Navigate to /guidedOnboardingExample/stepOne to complete the step.',
'Vivamus pretium, elit dictum lacinia aliquet, libero nibh dictum enim, a rhoncus leo magna in sapien.',
Copy link
Contributor

Choose a reason for hiding this comment

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

Do you want to delete this filler text?

descriptionList: [
'This step is set to ready_to_complete on page navigation.',
'After that click the popover on the guide button in the header and mark the step done',
'Vivamus pretium, elit dictum lacinia aliquet, libero nibh dictum enim, a rhoncus leo magna in sapien.',
Copy link
Contributor

Choose a reason for hiding this comment

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

Do you want to delete this filler text?

id="guidedOnboardingExample.guidesSelection.stepTwo.explanation1"
defaultMessage="The code on this page is listening to the guided setup state using an Observable subscription. If the state is set to
Search guide, step Browse documents, a EUI tour will be displayed, pointing to the button below."
Search guide, step Browse documents, a EUI tour will be displayed."
Copy link
Contributor

Choose a reason for hiding this comment

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

I think this text should be deleted

content={
<EuiText>
<p>Click this button to complete step 2.</p>
<p>The tour step is displayed when Test guide, step 2 is active.</p>
Copy link
Contributor

Choose a reason for hiding this comment

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

Can you delete the tour? I don't think it's necessary for step 2, but flashes briefly.

@yuliacech yuliacech enabled auto-merge (squash) October 27, 2022 12:09
@yuliacech
Copy link
Contributor Author

Hey @mibragimov, adding you to the conversation in this PR so that you can get a notification when it's merged. You'll probably get some merge conflicts for your api integration tests work. Sorry about that!

@mibragimov
Copy link
Contributor

Thanks for the heads up @yuliacech! No problem about the merge conflicts, I'll resolve them.

@kibana-ci
Copy link

💚 Build Succeeded

Metrics [docs]

Module Count

Fewer modules leads to a faster build time

id before after diff
guidedOnboarding 19 20 +1

Public APIs missing comments

Total count of every public API that lacks a comment. Target amount is 0. Run node scripts/build_api_docs --plugin [yourplugin] --stats comments for more detailed information.

id before after diff
guidedOnboarding 36 37 +1

Page load bundle

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

id before after diff
guidedOnboarding 21.5KB 23.0KB +1.5KB
Unknown metric groups

API count

id before after diff
guidedOnboarding 36 37 +1

History

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

@yuliacech yuliacech merged commit 460cf89 into elastic:main Oct 27, 2022
@kibanamachine kibanamachine added v8.6.0 backport:skip This PR does not require backporting labels Oct 27, 2022
@yuliacech yuliacech deleted the guided_onboarding/8.6_testing_guide_config branch November 22, 2022 09:32
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

backport:skip This PR does not require backporting release_note:skip Skip the PR/issue when compiling release notes Team:Journey/Onboarding Platform Journey Onboarding team v8.6.0

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[Guided onboarding] Add a guide for testing

6 participants