Rebuild PMM's onboarding tour

Description


User Story

As a new user of PMM, I want to understand how to navigate it and where to find the major features so I can start using it immediately without much discovery work or trial and error clicking around.

Acceptance criteria

  • Welcome message to the user on the Help Center page

  • Behavior of welcome message disappearing from the Help Center after tour is completed or user clicked elsewhere in UI (= tour completed)

  • Tour messages content and design implemented in the same style and order provided in the Figma file

  • Button to revisit the tour is available on the Help Center page

  • Front-end UI matches the UI design in style, content, and order as inspected in the Figma file

  • Content design reviewed and proofread

  • Backend: Tour reset if upgrade (not fresh install) to PMM version enhanced with new navigation (3.3.0???)

  • Non admin users

    • do not show Add service button

    • show welcome page on the first PMM load only (Admins - persist till new service added)

UI Design

Inspect front-end specifications directly on the UI design: https://www.figma.com/design/SwDFX83gKMgOZT7mKrgkQP/New-native-PMM-navigation?node-id=6-66&m=dev (Password: slaw-card-easel-snack)

The welcome message is displayed on the Help Center page, as exemplified below.

PMM’s onboarding tour is triggered by the “Start PMM tour” button in the welcome message.

Suggested implementation

Also, after the welcome message disappears, the PMM’s onboarding tour can be triggered by the “Start PMM tour” button replica in the “Useful tips” card. Both buttons can coexist and should trigger the same functionality.

Out of scope

Help Center page building scope should be handled in the ticket https://perconadev.atlassian.net/browse/PMM-13700. In this ticket, we need to work on top of what exist on that page.

Details

Initiative context and Discovery log: Notion page

Dev Notes

  • After implementation remove tour from grafana source code

  • Check Alerting tour compatibility for any clashes / bugs

How to test

None

How to document

None

Attachments

3
  • 27 Jan 2025, 12:48 PM
  • 27 Jan 2025, 12:48 PM
  • 27 Jan 2025, 12:48 PM

is blocked by

Activity

Show:

Details

Assignee

Reporter

Priority

Components

Labels

Needs QA

Yes

Needs Doc

No

Story Points

Smart Checklist

Created January 27, 2025 at 11:52 AM
Updated last month