Skip to content

Commit 555ea1e

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

File tree

1 file changed

+43
-2
lines changed

1 file changed

+43
-2
lines changed

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

Lines changed: 43 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,48 @@
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-
== Using the Context Hook
6+
.Procedure
7+
. Open the Quickstart drawer
8+
.. Navigate to the **top right corner** of the {product-short} interface.
9+
.. Click the icon labeled **“Quick start”** (represented by a question mark icon in the top menu).
10+
.. The drawer panel on the **right-hand side** of the screen slides open.
11+
12+
. Review the available Quickstart items
13+
+
14+
In the drawer, you will see a list of onboarding tasks, including:
15+
16+
Set up authentication::
17+
Configure secure login credentials to protect your account.
18+
19+
Configure RBAC::
20+
Set up Role-Based Access Control for your team.
21+
22+
Configure Git::
23+
Connect your Git repositories for source control and automation.
24+
25+
Manage plugins::
26+
Enable or disable additional functionality in the Hub.
27+
+
28+
Each item may be expandable and interactive.
29+
30+
. Track Your Progress
31+
* Each Quick Start item includes a **status indicator**, such as:
32+
** _Not started_
33+
** _In progress_
34+
** _Completed_
35+
+
36+
As you complete each step or task, your progress is automatically tracked.
37+
38+
[NOTE]
39+
====
40+
Quickstart items are **configurable**, meaning the content and order can vary depending on your Red Hat Developer Hub instance.
41+
42+
You can **revisit** or **reset** tasks at any time for review or team onboarding.
43+
44+
You can hide the Quickstart drawer by clicking *Hide*
45+
====
46+
47+
= Using the Context Hook
748
Access quickstart drawer functionality in your components:
849

950
[source,yaml]
@@ -18,5 +59,5 @@ const MyComponent = () => {
1859
};
1960
----
2061

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

0 commit comments

Comments
 (0)