[Guided onboarding] Search guide copy #144234

yuliacech · 2022-10-31T13:40:56Z

Summary

Partially addresses #139741

This PR updates the config for the Search guide:

The copy is reviewed by @kellyemurphy
Removed the docs link for 8.6 release
Updated the guide to only 2 steps

Screenshot

… copy

yuliacech · 2022-10-31T16:02:39Z

examples/guided_onboarding_example/public/components/main.tsx

@@ -216,7 +216,8 @@ export const Main = (props: MainProps) => {
                  )}
                  {(guideState?.isActive === true ||
                    guideState?.status === 'in_progress' ||
-                    guideState?.status === 'ready_to_complete') && (
+                    guideState?.status === 'ready_to_complete' ||
+                    guideState?.status === 'not_started') && (


not_started status was missing from the examples page

yuliacech · 2022-10-31T16:03:04Z

src/plugins/guided_onboarding/public/components/guide_panel.test.tsx

@@ -21,50 +21,50 @@ import { registerTestBed, TestBed } from '@kbn/test-jest-helpers';

 const applicationMock = applicationServiceMock.createStartContract();

-const mockActiveSearchGuideState: GuideState = {
-  guideId: 'search',
+const mockActiveTestGuideState: GuideState = {


updated the jest test to use the test guide instead of search

yuliacech · 2022-10-31T16:07:02Z

src/plugins/guided_onboarding/public/components/guide_panel_step.tsx

-                  })}
-                </ul>
-              )}
+              {stepConfig.description && <p>{stepConfig.description}</p>}


There is a space between the paragraph and the list so I might need to wait until Cindy's PR is in and use the css to remove the margin.

elasticmachine · 2022-10-31T16:10:46Z

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

alisonelizabeth

Thanks for working on this! Did not test locally. Code looks good overall. I did leave a comment around naming, and also just wanted to confirm the behavior when description is provided as well as descriptionList with only 1 item. If you could take a look before merging that would be great.

alisonelizabeth · 2022-10-31T16:58:39Z

src/plugins/guided_onboarding/public/types.ts

@@ -54,7 +54,8 @@ export interface GuidedOnboardingApi {
 export interface StepConfig {
  id: GuideStepIds;
  title: string;
-  descriptionList: string[];
+  description?: string;


Can we add some code comments here to explain the difference between description and descriptionList? I could see how it could be confusing when to use which, especially since descriptionList renders as a paragraph if only one item is provided (thinking the future, when more teams are registering guides 😄).

Added some comments to the types and updated the step to always render descriptionList as ul. With introduction of description it doesn't make much sense to account for the list with only 1 item, I think.

alisonelizabeth · 2022-10-31T17:01:37Z

src/plugins/guided_onboarding/public/components/guide_panel_step.tsx

-                  })}
-                </ul>
-              )}
+              {stepConfig.description && <p>{stepConfig.description}</p>}


If a guide config contains the description field and descriptionList with only 1 item in the array, does it still render as expected (i.e., two
tags)?

kellyemurphy

I do want Casey's ok on the changes to those final bullet points, but overall just some small tweaks and missing punctuation.

src/plugins/guided_onboarding/public/constants/guides_config/search.ts

kellyemurphy · 2022-10-31T21:42:15Z

src/plugins/guided_onboarding/public/constants/guides_config/search.ts

+        defaultMessage: 'Build a search experience',
+      }),
+      description: i18n.translate('guidedOnboarding.searchGuide.searchExperienceStep.description', {
+        defaultMessage: 'Take a tour of Elastic’s relevance refinement tools, including:',


@zumwalt can you please review my suggestions here? I just realized we're mentioning relevance on every line.

Good catch! I suggested the correct copy for this step.

…earch.ts Co-authored-by: Kelly Murphy <[email protected]>

yuliacech · 2022-11-02T12:09:43Z

Thank you for the review, @alisonelizabeth! Good catch with description and descriptionList, addressed your comments in the latest commit.

yuliacech · 2022-11-02T12:10:33Z

Thanks a lot for you review and suggestions, @kellyemurphy! I'll commit your text changes and update the screenshots in the PR description.

zumwalt

@yuliacech I suggested changes to the "Build a Search Experience" step

zumwalt · 2022-11-02T13:01:13Z

src/plugins/guided_onboarding/public/constants/guides_config/search.ts

+        defaultMessage: 'Build a search experience',
+      }),
+      description: i18n.translate('guidedOnboarding.searchGuide.searchExperienceStep.description', {
+        defaultMessage: 'Take a tour of Elastic’s relevance refinement tools, including:',


We can remove this in favor of a simple description list

src/plugins/guided_onboarding/public/constants/guides_config/search.ts

…earch.ts Co-authored-by: Casey Zumwalt <[email protected]>

kibana-ci · 2022-11-02T14:46:31Z

💚 Build Succeeded

Buildkite Build
Commit: 6ad5c3d

Metrics [docs]

Page load bundle

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

id	before	after	diff
`guidedOnboarding`	23.8KB	23.9KB	+61.0B

Unknown metric groups

ESLint disabled in files

id	before	after	diff
`osquery`	1	2	+1

ESLint disabled line counts

id	before	after	diff
`enterpriseSearch`	19	21	+2
`fleet`	57	63	+6
`osquery`	103	108	+5
`securitySolution`	439	445	+6
total			+19

Total ESLint disabled count

id	before	after	diff
`enterpriseSearch`	20	22	+2
`fleet`	65	71	+6
`osquery`	104	110	+6
`securitySolution`	516	522	+6
total			+20

History

💚 Build #84058 succeeded 5273f4b
💚 Build #83997 succeeded 00bddf4
💚 Build #83952 succeeded 4773ac0

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

[Guided onboarding] Update the search guide config to use the correct…

4773ac0

… copy

yuliacech added release_note:skip Skip the PR/issue when compiling release notes Team:Journey/Onboarding Platform Journey Onboarding team v8.6.0 labels Oct 31, 2022

[Guided onboarding] Remove the docs link, not needed in 8.6

00bddf4

yuliacech commented Oct 31, 2022

View reviewed changes

[Guided onboarding] Delete the step id type for the removed search step

5273f4b

yuliacech marked this pull request as ready for review October 31, 2022 16:10

yuliacech requested a review from a team as a code owner October 31, 2022 16:10

yuliacech requested review from kellyemurphy, alisonelizabeth and zumwalt October 31, 2022 16:11

alisonelizabeth approved these changes Oct 31, 2022

View reviewed changes

kellyemurphy reviewed Oct 31, 2022

View reviewed changes

yuliacech and others added 8 commits November 2, 2022 12:35

Merge branch 'main' into guided_onboarding/8.6_search_copy

defeb90

Update src/plugins/guided_onboarding/public/constants/guides_config/s…

3f350e7

…earch.ts Co-authored-by: Kelly Murphy <[email protected]>

Update src/plugins/guided_onboarding/public/constants/guides_config/s…

1de20f5

…earch.ts Co-authored-by: Kelly Murphy <[email protected]>

Update src/plugins/guided_onboarding/public/constants/guides_config/s…

e44118e

…earch.ts Co-authored-by: Kelly Murphy <[email protected]>

Update src/plugins/guided_onboarding/public/constants/guides_config/s…

3afb278

…earch.ts Co-authored-by: Kelly Murphy <[email protected]>

Update src/plugins/guided_onboarding/public/constants/guides_config/s…

68f3b6a

…earch.ts Co-authored-by: Kelly Murphy <[email protected]>

Update src/plugins/guided_onboarding/public/constants/guides_config/s…

1765312

…earch.ts Co-authored-by: Kelly Murphy <[email protected]>

[Guided onboarding] Update step description and description list

b25cad5

zumwalt reviewed Nov 2, 2022

View reviewed changes

yuliacech and others added 2 commits November 2, 2022 14:21

Update src/plugins/guided_onboarding/public/constants/guides_config/s…

8e8c9ae

…earch.ts Co-authored-by: Casey Zumwalt <[email protected]>

Update src/plugins/guided_onboarding/public/constants/guides_config/s…

5c112cd

…earch.ts Co-authored-by: Casey Zumwalt <[email protected]>

yuliacech and others added 2 commits November 2, 2022 14:22

Update src/plugins/guided_onboarding/public/constants/guides_config/s…

d8c569b

…earch.ts Co-authored-by: Casey Zumwalt <[email protected]>

[Guided onboarding] Update the copy

6ad5c3d

yuliacech enabled auto-merge (squash) November 2, 2022 13:29

yuliacech merged commit 92db69c into elastic:main Nov 2, 2022

kibanamachine added the backport:skip This commit does not require backporting label Nov 2, 2022

alisonelizabeth mentioned this pull request Nov 2, 2022

[Guided onboarding] Copy changes #139741

Closed

yuliacech deleted the guided_onboarding/8.6_search_copy branch November 22, 2022 09:32

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Guided onboarding] Search guide copy #144234

[Guided onboarding] Search guide copy #144234

yuliacech commented Oct 31, 2022 •

edited

Loading

yuliacech Oct 31, 2022

yuliacech Oct 31, 2022

yuliacech Oct 31, 2022

elasticmachine commented Oct 31, 2022

alisonelizabeth left a comment

alisonelizabeth Oct 31, 2022

yuliacech Nov 2, 2022

alisonelizabeth Oct 31, 2022

kellyemurphy left a comment

kellyemurphy Oct 31, 2022

zumwalt Nov 2, 2022

yuliacech commented Nov 2, 2022

yuliacech commented Nov 2, 2022

zumwalt left a comment

zumwalt Nov 2, 2022

kibana-ci commented Nov 2, 2022

ESLint disabled in files

ESLint disabled line counts

Total ESLint disabled count

[Guided onboarding] Search guide copy #144234

[Guided onboarding] Search guide copy #144234

Conversation

yuliacech commented Oct 31, 2022 • edited Loading

Summary

Screenshot

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

elasticmachine commented Oct 31, 2022

alisonelizabeth left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

kellyemurphy left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

yuliacech commented Nov 2, 2022

yuliacech commented Nov 2, 2022

zumwalt left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

kibana-ci commented Nov 2, 2022

💚 Build Succeeded

Metrics [docs]

Page load bundle

ESLint disabled in files

ESLint disabled line counts

Total ESLint disabled count

History

yuliacech commented Oct 31, 2022 •

edited

Loading