[Guided onboarding] Update observability tour #143006

alisonelizabeth · 2022-10-10T17:28:50Z

This PR updates the Observability product tour implemented in 8.4 to work with the new guided onboarding framework. The tour will now display as part of step 3 of the Kubernetes guide.

Fixes #140656

How to test

Enable guided onboarding via your kibana.dev.yml file: guidedOnboarding.ui: true
Start up Kibana with the example plugins enabled: yarn start --run-examples
Navigate to /app/guidedOnboardingExample
Use the "Set guide state" form to trigger step 3 of the Observability guide. Click save after setting the following values:
```
Guide: observability
Step ID: tour_observability
```
Start the step. Verify the guide navigates the user to the Observability Overview page and the EuiTour displays.
Complete the tour. Verify the step is completed and the guide panel reopens.
All other tour behavior implemented via [Guided onboarding] Observability tour #133909 should largely remain. Skipping a tour should complete the guide. If you leave the tour mid-tour and come back, the correct step should display. Clicking on the "Data assistant" button should also complete the guide.

Note: There is a bug right now when clicking on other links in the side nav with the tour in progress. This appears to be a regression introduced in the KibanaPageTemplate. I opened #143114 to track.

Demo

observ_tour.mp4

…ng/observability_tour

…-ref HEAD~1..HEAD --fix'

alisonelizabeth · 2022-10-12T12:18:31Z

x-pack/test/functional/apps/infra/tour.ts

      await browser.removeLocalStorageItem(observTourStepStorageKey);
    });

    describe('Tour enabled', () => {
+      beforeEach(async () => {


I'm not sure if it makes sense to keep these tests around once #138568 is implemented, but thought it would be good to maintain them for now until we have a clearer picture of what our E2E testing looks like.

elasticmachine · 2022-10-12T12:20:19Z

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

elasticmachine · 2022-10-12T12:27:38Z

Pinging @elastic/apm-ui (Team:APM)

elasticmachine · 2022-10-12T12:27:39Z

Pinging @elastic/uptime (Team:uptime)

legrego

Import formatting changes in x-pack/plugins/security/public/management/roles/edit_role/privileges/kibana/feature_table/feature_table.tsx LGTM

yuliacech

Thanks a lot, @alisonelizabeth!
Tested locally and the tour works as expected, code changes LGTM too 🎉

alisonelizabeth · 2022-10-13T18:47:54Z

@elasticmachine merge upstream

alisonelizabeth · 2022-10-17T12:37:58Z

@elasticmachine merge upstream

weltenwort · 2022-10-17T18:31:26Z

x-pack/plugins/infra/kibana.json

@@ -16,7 +16,8 @@
    "observability",
    "ruleRegistry",
    "unifiedSearch",
-    "lens"
+    "lens",
+    "guidedOnboarding"


Could you help me understand why this would have to become a dependency of the infra plugin?

@weltenwort Happy path, the EuiTour steps render on the Overview page. However, if a user navigates away via the left nav during the tour, the tour steps should still render (e.g., to the “Stream” page). The tour logic lives within the shared Observability page template, and is dependent on the guidedOnboarding plugin.

I see, thanks for the explanation. But wouldn't the existing dependency on the observability plugin (through which the infra plugin renders the observability page template in the first place) already extend to the guidedOnboarding dependency transitively?

@weltenwort I went back and looked through the code, and I was able to inject it as a dependency when createLazyObservabilityPageTemplate is called. This should remove the need to make it a dependency of each plugin. Thanks for calling this out!

That's great, thanks for the thoroughness!

…ng/observability_tour

kellyemurphy · 2022-10-18T21:23:12Z

@alisonelizabeth can we change the text on the final step of the setup guide? It shouldn't be a bullet point if there's only one and I think the text would read better as Get familiar with the rest of Elastic Observability and explore even more integrations.

alisonelizabeth · 2022-10-19T00:06:39Z

@alisonelizabeth can we change the text on the final step of the setup guide? It shouldn't be a bullet point if there's only one and I think the text would read better as Get familiar with the rest of Elastic Observability and explore even more integrations.

Thanks @kellyemurphy! I've updated the copy (f8f28b4). The bullet point issue will be addressed via #143606.

kibana-ci · 2022-10-19T01:37:39Z

💚 Build Succeeded

Buildkite Build
Commit: 34da2e3

Metrics [docs]

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
`observability`	535	536	+1

Async chunks

Total size of all lazy-loaded chunks that will be downloaded as the user navigates the app

id	before	after	diff
`observability`	521.7KB	522.0KB	+345.0B

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.6KB	21.6KB	+34.0B
`observability`	67.6KB	67.6KB	+59.0B
total			+93.0B

Unknown metric groups

API count

id	before	after	diff
`observability`	539	540	+1

History

💔 Build #81233 failed f8f28b4
💛 Build #81108 was flaky cd5074f
💛 Build #80708 was flaky 4f768ea
💚 Build #80247 succeeded 9a7770f
💚 Build #79641 succeeded 51683ef
💔 Build #79575 failed 913fb3b

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

update observability tour

352e538

alisonelizabeth added the Team:Journey/Onboarding Platform Journey Onboarding team label Oct 10, 2022

alisonelizabeth and others added 8 commits October 10, 2022 13:32

Merge branch 'main' of github.com:elastic/kibana into guided_onboardi…

d533951

…ng/observability_tour

complete guide step on tour end

90d0177

Merge branch 'main' of github.com:elastic/kibana into guided_onboardi…

08b21a9

…ng/observability_tour

add guidedOnboarding as dependency for other Observ plugins

2859155

update functional tests

0f619ea

fix jest test

bd42773

Merge branch 'main' of github.com:elastic/kibana into guided_onboardi…

5ba9637

…ng/observability_tour

[CI] Auto-commit changed files from 'node scripts/precommit_hook.js -…

a120a67

…-ref HEAD~1..HEAD --fix'

alisonelizabeth added release_note:skip Skip the PR/issue when compiling release notes v8.6.0 labels Oct 11, 2022

alisonelizabeth added 2 commits October 11, 2022 15:43

fix test setup

913fb3b

enable guided onboarding for tests; fix test setup

51683ef

alisonelizabeth changed the title ~~[Guided onboarding] [WIP] Update observability tour~~ [Guided onboarding] Update observability tour Oct 12, 2022

alisonelizabeth commented Oct 12, 2022

View reviewed changes

alisonelizabeth marked this pull request as ready for review October 12, 2022 12:20

alisonelizabeth requested review from a team as code owners October 12, 2022 12:20

alisonelizabeth requested a review from yuliacech October 12, 2022 12:20

alisonelizabeth added the ui-copy Review of UI copy with docs team is recommended label Oct 12, 2022

shahzad31 approved these changes Oct 12, 2022

View reviewed changes

botelastic bot added Team:APM All issues that need APM UI Team support Team:Uptime - DEPRECATED Synthetics & RUM sub-team of Application Observability labels Oct 12, 2022

legrego approved these changes Oct 12, 2022

View reviewed changes

gchaps requested a review from kellyemurphy October 12, 2022 14:35

yuliacech approved these changes Oct 12, 2022

View reviewed changes

gbamparop approved these changes Oct 13, 2022

View reviewed changes

Merge branch 'main' into guided_onboarding/observability_tour

9a7770f

Merge branch 'main' into guided_onboarding/observability_tour

4f768ea

weltenwort reviewed Oct 17, 2022

View reviewed changes

alisonelizabeth added 2 commits October 18, 2022 10:34

Merge branch 'main' of github.com:elastic/kibana into guided_onboardi…

7595e50

…ng/observability_tour

Merge branch 'main' of github.com:elastic/kibana into guided_onboardi…

cd5074f

…ng/observability_tour

alisonelizabeth added 2 commits October 18, 2022 19:53

address review feedback

d3184fa

update copy

f8f28b4

update tests

34da2e3

alisonelizabeth merged commit 048b11d into elastic:main Oct 19, 2022

kibanamachine added the backport:skip This commit does not require backporting label Oct 19, 2022

alisonelizabeth deleted the guided_onboarding/observability_tour branch October 19, 2022 12:16

kc13greiner pushed a commit to kc13greiner/kibana that referenced this pull request Oct 19, 2022

[Guided onboarding] Update observability tour (elastic#143006)

7032cf8

guskovaue pushed a commit to guskovaue/kibana that referenced this pull request Oct 22, 2022

[Guided onboarding] Update observability tour (elastic#143006)

93585ee

e40pud pushed a commit to e40pud/kibana that referenced this pull request Oct 24, 2022

[Guided onboarding] Update observability tour (elastic#143006)

ced7196

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Guided onboarding] Update observability tour #143006

[Guided onboarding] Update observability tour #143006

alisonelizabeth commented Oct 10, 2022 •

edited

Loading

alisonelizabeth Oct 12, 2022

elasticmachine commented Oct 12, 2022

elasticmachine commented Oct 12, 2022

elasticmachine commented Oct 12, 2022

legrego left a comment

yuliacech left a comment

alisonelizabeth commented Oct 13, 2022

alisonelizabeth commented Oct 17, 2022

weltenwort Oct 17, 2022

alisonelizabeth Oct 18, 2022 •

edited

Loading

weltenwort Oct 18, 2022

alisonelizabeth Oct 19, 2022

weltenwort Oct 19, 2022

kellyemurphy commented Oct 18, 2022

alisonelizabeth commented Oct 19, 2022 •

edited

Loading

kibana-ci commented Oct 19, 2022

API count

[Guided onboarding] Update observability tour #143006

[Guided onboarding] Update observability tour #143006

Conversation

alisonelizabeth commented Oct 10, 2022 • edited Loading

How to test

Demo

alisonelizabeth Oct 12, 2022

Choose a reason for hiding this comment

elasticmachine commented Oct 12, 2022

elasticmachine commented Oct 12, 2022

elasticmachine commented Oct 12, 2022

legrego left a comment

Choose a reason for hiding this comment

yuliacech left a comment

Choose a reason for hiding this comment

alisonelizabeth commented Oct 13, 2022

alisonelizabeth commented Oct 17, 2022

weltenwort Oct 17, 2022

Choose a reason for hiding this comment

alisonelizabeth Oct 18, 2022 • edited Loading

Choose a reason for hiding this comment

weltenwort Oct 18, 2022

Choose a reason for hiding this comment

alisonelizabeth Oct 19, 2022

Choose a reason for hiding this comment

weltenwort Oct 19, 2022

Choose a reason for hiding this comment

kellyemurphy commented Oct 18, 2022

alisonelizabeth commented Oct 19, 2022 • edited Loading

kibana-ci commented Oct 19, 2022

💚 Build Succeeded

Metrics [docs]

Public APIs missing comments

Async chunks

Page load bundle

API count

History

alisonelizabeth commented Oct 10, 2022 •

edited

Loading

alisonelizabeth Oct 18, 2022 •

edited

Loading

alisonelizabeth commented Oct 19, 2022 •

edited

Loading