EPIC Goal

The new Quick Start plugin for RHDH provides a guided, interactive onboarding experience specifically for administrators. It automatically appears on first login, offering clear, step-by-step instructions for essential setup tasks.

Background/Feature Origin

RHIDP-6928

Why is this important?

Improve the on-boarding experience and avoid "empty catalog issues".

Dependencies (internal and external)

The content, see other epics in RHIDP-7015

Acceptance Criteria

• As a first-time RHDH administrator, I want the Quick Start guide to automatically appear upon my initial login, so that I can immediately begin configuring essential platform settings.
• As a non administrator, I should not see the quickstart (This will be in RHD 1.8)
• As an RHDH administrator, I want the Quick Start guide to present clear, step-by-step instructions with relevant links for admin-specific tasks, so that I can efficiently set up RHDH.
• As an RHDH administrator, I want the Quick Start guide to track my progress through the setup steps, so that I can easily resume or review my configuration at any time.
• As an RHDH administrator, I want to see a progress bar or indicator showing my overall completion of the Quick Start guide, so that I can easily view my progress.
• As an RHDH administrator, I want a step to be marked as complete once I click on a last step button, automatically updating my progress.
• As an RHDH administrator, I want all steps within the Quick Start guide to be closed by default when it first appears, so that I can choose which sections to expand and focus on.
• As an RHDH administrator, when I open a step within the Quick Start guide, I want it to remain open until I explicitly close it or open another step, so that I can easily follow the instructions.
• As an RHDH administrator, I want only one step to be open at a time within the Quick Start guide, so that I can focus on the current task without distraction.
• As an RHDH administrator, when I click on a button of a specific step that directs to another page, I want the relevant Quick Start guide to appear alongside the plugin's page, so that I can follow instructions contextually without losing my place.
• As an RHDH administrator, I want to be able to close the Quick Start guide, and have it remain hidden on subsequent sessions until I explicitly re-open it from the header.
• As an RHDH administrator, when I open the Quick Start guide from the header, I want it to remain visible across all pages and sessions until I explicitly close it.
• As an RHDH administrator, after closing the Quick Start guide, I want to see a tooltip in the header indicating where I can re-open it, so that I can easily find it again when needed.
• As an RHDH administrator, if a Floating Action Button (FAB) is enabled on a page, I want it to appear on the page and not be obscured by or overlap the Quick Start guide's docked display, so that all interactive elements are clearly accessible.
• e2e tests as part of RHDH repo that checks that the actual content is loaded

Designs

• https://www.figma.com/design/6ORS1mhUaxeyTBjMmE95Rn/Home-page-redesign?node-id=1957-14245&t=jc2rWwpKfOJB3uA1-1

Open questions:

1. The content will be "hard-coded" into the home page plugin? Where do we store videos and how do we ship them?
   • Christophe on Apr 15th: Could be hard coded, maybe the content can be loaded from a local YAML. Expect content and links, not videos in the first version.
2. Can we use https://backstage.io/docs/reference/plugin-user-settings/ to store the progress and of the quick start card should be shown or not?
   • Christophe on Apr 15th: It's enough to save the data per user. It's not required to save the progress between multiple admins because in the most cases just one admin will setup a new cluster.
3. Does it make sense to reuse something from https://www.patternfly.org/extensions/quick-starts? Maybe the format?
4. Will the docs team create the videos or?
   • Christophe on Apr 15th: Let us start with text and links and we'll investigate our optiosn for the video problem when we have one.
5. Upon clicking CTA for jumping to a plugin, should the quickstart be visible in the plugin or is it something we want currently only in homepage?
   • Christophe on Apr 15th: The new quick start should be visible also when the user clicks in one of the card on a link like "Configure RBAC". So it should not be just visible as a card on the homepage.