Skip to content

[Console] Disable running onboarding tour by default#227978

Merged
damian-polewski merged 7 commits intoelastic:mainfrom
damian-polewski:console/disable_running_tour_by_default
Jul 21, 2025
Merged

[Console] Disable running onboarding tour by default#227978
damian-polewski merged 7 commits intoelastic:mainfrom
damian-polewski:console/disable_running_tour_by_default

Conversation

@damian-polewski
Copy link
Contributor

@damian-polewski damian-polewski commented Jul 15, 2025

Closes #212284

Summary

This PR disables running the Console onboarding tour when opening the page for the first time. The tour can be still accessed by pressing the Start introduction tour button in the Help popover.

Note

Since it is no longer necessary to determine whether the user has completed/skipped the tour to show in orger to display it initial, the consoleTour state is no longer saved in local storage.

Before After
FireShot Capture 033 - Console - Dev Tools - Elastic -  localhost console

Checklist

Check the PR satisfies following conditions.

Reviewers should verify this PR satisfies this list as well.

  • Any text added follows EUI's writing guidelines, uses sentence case text and includes i18n support
  • Documentation was added for features that require explanation or tutorials
  • Unit or functional tests were updated or added to match the most common scenarios
  • If a plugin configuration key changed, check if it needs to be allowlisted in the cloud and added to the docker list
  • This was checked for breaking HTTP API changes, and any breaking changes have been approved by the breaking-change committee. The release_note:breaking label should be applied in these situations.
  • Flaky Test Runner was used on any tests changed
  • The PR description includes the appropriate Release Notes section, and the correct release_note:* label is applied per the guidelines
  • Review the backport guidelines and apply applicable backport:* labels.

Release note

The console onboarding tour is now disabled by default. Users can manually start the tour at any time from the Help popover.

@damian-polewski damian-polewski self-assigned this Jul 15, 2025
@damian-polewski damian-polewski added release_note:enhancement Feature:Console Dev Tools Console Feature Team:Kibana Management Dev Tools, Index Management, Upgrade Assistant, ILM, Ingest Node Pipelines, and more t// backport:skip This PR does not require backporting labels Jul 15, 2025
@damian-polewski damian-polewski marked this pull request as ready for review July 15, 2025 11:37
@damian-polewski damian-polewski requested a review from a team as a code owner July 15, 2025 11:37
@elasticmachine
Copy link
Contributor

Pinging @elastic/kibana-management (Team:Kibana Management)

@kibanamachine
Copy link
Contributor

Flaky Test Runner Stats

🎉 All tests passed! - kibana-flaky-test-suite-runner#8649

[✅] src/platform/test/functional/apps/console/config.ts: 100/100 tests passed.

see run history

@SoniaSanzV SoniaSanzV requested a review from a team July 16, 2025 09:14
@damian-polewski
Copy link
Contributor Author

Hi @elastic/docs I wanted to ask about your opinion about on using Run getting started guide only for the first time user plays the tour and for every other time using Re-run getting started guide instead of just displaying Run getting started guide all the time. Let me know what do you think!

Copy link
Contributor

@florent-leborgne florent-leborgne left a comment

Choose a reason for hiding this comment

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

Hi! I'd use Start introduction tour in all cases, not re- or again or similar "not first time" variations

Copy link
Member

@sabarasaba sabarasaba left a comment

Choose a reason for hiding this comment

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

changes lgtm, nice job @damian-polewski!

Copy link
Contributor

@florent-leborgne florent-leborgne left a comment

Choose a reason for hiding this comment

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

Nice!

@damian-polewski damian-polewski requested a review from a team as a code owner July 17, 2025 10:50
@damian-polewski
Copy link
Contributor Author

damian-polewski commented Jul 17, 2025

Hi @elastic/search-kibana, since the console onboarding tour will not start automatically now I removed extra checks that skip it from x-pack/solutions/search/test/functional_search/tests/solution_navigation.ts and x-pack/test_serverless/functional/test_suites/search/navigation.ts.

@damian-polewski damian-polewski enabled auto-merge (squash) July 21, 2025 04:47
@damian-polewski damian-polewski merged commit fd39e74 into elastic:main Jul 21, 2025
12 checks passed
@elasticmachine
Copy link
Contributor

💚 Build Succeeded

Metrics [docs]

Async chunks

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

id before after diff
console 194.0KB 193.9KB -151.0B

History

cc @damian-polewski

@damian-polewski damian-polewski deleted the console/disable_running_tour_by_default branch July 21, 2025 06:37
Bluefinger pushed a commit to Bluefinger/kibana that referenced this pull request Jul 22, 2025
Closes elastic#212284

## Summary

This PR disables running the Console onboarding tour when opening the
page for the first time. The tour can be still accessed by pressing the
`Run getting started guide` button in the Help popover.
kertal pushed a commit to kertal/kibana that referenced this pull request Jul 25, 2025
Closes elastic#212284

## Summary

This PR disables running the Console onboarding tour when opening the
page for the first time. The tour can be still accessed by pressing the
`Run getting started guide` button in the Help popover.
crespocarlos pushed a commit to crespocarlos/kibana that referenced this pull request Jul 25, 2025
Closes elastic#212284

## Summary

This PR disables running the Console onboarding tour when opening the
page for the first time. The tour can be still accessed by pressing the
`Run getting started guide` button in the Help popover.
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 Feature:Console Dev Tools Console Feature release_note:enhancement Team:Kibana Management Dev Tools, Index Management, Upgrade Assistant, ILM, Ingest Node Pipelines, and more t// v9.2.0

6 participants