Skip to content

Commit a7beabd

Browse files
committed
RHIDP-8240 - Create a Quickstart guide to support first-time onboarding for administrators
1 parent bcee247 commit a7beabd

File tree

2 files changed

+12
-10
lines changed

2 files changed

+12
-10
lines changed

artifacts/rhdh-plugins-reference/quickstart/quickstart-plugin-admin.adoc

Lines changed: 1 addition & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -3,13 +3,6 @@
33

44
The Quickstart plugin provides a guided onboarding experience for new users of {product}. It displays a customizable drawer interface with interactive quickstart steps that help users get familiar with the platform.
55

6-
== Features
7-
* Interactive Drawer Interface: Displays quickstart steps in a slide-out drawer
8-
* Progress Tracking: Tracks completion status of individual steps with persistent storage
9-
* Configurable Content: Define custom quickstart items through app configuration
10-
* Visual Progress Indicator: Shows overall completion progress with a progress bar
11-
* Call-to-Action Support: Each step can include clickable action buttons
12-
136
== Installation
147
The Quickstart plugin is pre-loaded in {product-short} with basic configuration properties, and enabled by default. To disable it, set the disabled property to `true` as follows:
158

@@ -55,7 +48,7 @@ app:
5548
Each quickstart item supports the following properties:
5649

5750
* `title` (required): The display title for the quickstart step
58-
description (required): A brief description of what the step covers
51+
* `description` (required): A brief description of what the step covers
5952
* `icon` (optional): Icon identifier (supports Material UI icons)
6053
* `cta` (optional): Call-to-action object with:
6154
* `text`: Button text

artifacts/rhdh-plugins-reference/quickstart/quickstart-plugin-user.adoc

Lines changed: 11 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,13 @@
33

44
The Quickstart plugin provides a guided onboarding experience for new users of {product}. It displays a customizable drawer interface with interactive quickstart steps that help users get familiar with the platform.
55

6+
== Features
7+
Interactive Drawer Interface:: Displays quickstart steps in a slide-out drawer.
8+
Progress Tracking:: Tracks completion status of individual steps with persistent storage.
9+
Configurable Content:: Define custom quickstart items through app configuration.
10+
Visual Progress Indicator:: Shows overall completion progress with a progress bar.
11+
Call-to-Action Support:: Each step can include clickable action buttons.
12+
613
.Procedure
714
. Open the Quickstart drawer
815
.. Navigate to the **top right corner** of the {product-short} interface.
@@ -44,6 +51,7 @@ You can **revisit** or **reset** tasks at any time for review or team onboarding
4451
You can hide the Quickstart drawer by clicking *Hide*
4552
====
4653

54+
////
4755
= Using the Context Hook
4856
Access quickstart drawer functionality in your components:
4957
@@ -58,6 +66,7 @@ const MyComponent = () => {
5866
return <button onClick={openDrawer}>Open Quickstart Guide</button>;
5967
};
6068
----
69+
////
6170

62-
= Progress Persistence
63-
The plugin automatically saves progress to local storage, so users can continue where they left off even after refreshing the page or returning later.
71+
= Progress persistence
72+
The plugin automatically saves progress, so users can continue where they left off even after refreshing the page or returning later.

0 commit comments

Comments
 (0)