Skip to content

Commit 53cd2f7

Browse files
Gerry-Fordedeerskindollpabel-rh
authored
RHIDP-8240 - Create a Quickstart guide to support first-time onboarding for administrators (#1287)
* RHIDP-8240 - Create a Quickstart guide to support first-time onboarding for administrators * RHIDP-8240 - Create a Quickstart guide to support first-time onboarding for administrators * RHIDP-8240 - Create a Quickstart guide to support first-time onboarding for administrators * RHIDP-8240 - Create a Quickstart guide to support first-time onboarding for administrators * RHIDP-8240 - Create a Quickstart guide to support first-time onboarding for administrators * RHIDP-8240 - Create a Quickstart guide to support first-time onboarding for administrators * RHIDP-8240 - Create a Quickstart guide to support first-time onboarding for administrators * RHIDP-7560 - Install and configure plugins from Extensions page (next phase) * RHIDP-7560 - Install and configure plugins from Extensions page (next phase) * RHIDP-8240 - Create a Quickstart guide to support first-time onboarding for administrators * RHIDP-8240 - Create a Quickstart guide to support first-time onboarding for administrators * Update modules/configuring-the-quickstarts/proc-customize-rhdh-quickstart.adoc Co-authored-by: Jana Vrbkova <[email protected]> * Update modules/configuring-the-quickstarts/proc-customize-rhdh-quickstart.adoc Co-authored-by: Priyanka Abel <[email protected]> * Update modules/configuring-the-quickstarts/proc-starting-and-completing-modules-in-quickstarts.adoc Co-authored-by: Priyanka Abel <[email protected]> --------- Co-authored-by: Jana Vrbkova <[email protected]> Co-authored-by: Priyanka Abel <[email protected]>
1 parent 18d2e45 commit 53cd2f7

File tree

6 files changed

+107
-0
lines changed

6 files changed

+107
-0
lines changed

‎assemblies/assembly-configuring-the-quickstarts.adoc‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
:_mod-docs-content-type: ASSEMBLY
2+
:context: customizing-the-quickstarts
3+
[id="{context}"]
4+
= Customizing the Quickstart plugin
5+
6+
include::modules/configuring-the-quickstarts/con-about-quickstarts.adoc[leveloffset=+1]
7+
8+
include::modules/configuring-the-quickstarts/proc-customize-rhdh-quickstart.adoc[leveloffset=+1]
9+
10+
include::modules/configuring-the-quickstarts/proc-starting-and-completing-modules-in-quickstarts.adoc[leveloffset=+1]

‎images/rhdh/about-quickstarts.png‎

149 KB
Loading

‎modules/configuring-the-quickstarts/con-about-quickstarts.adoc‎

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
:_mod-docs-content-type: CONCEPT
2+
3+
[id="about-quickstarts_{context}"]
4+
= About Quickstarts
5+
6+
The Quickstart plugin provides guided onboarding for adminstrators of {product}. It displays a customizable drawer interface with interactive quickstart steps that help users get familiar with the platform.
7+
8+
[NOTE]
9+
====
10+
If RBAC is enabled, Quickstart is only accesible to users with administrator permissions.
11+
====
12+
13+
The Quickstart plugin is enabled by default and includes the following components:
14+
15+
Set up authentication:: Set up secure login credentials to protect your account from unauthorized access.
16+
Configure RBAC:: Assign roles and permissions to control who can view, create, or edit resources, ensuring secure and efficient collaboration.
17+
Configure Git:: Connect your Git providers, such as GitHub to manage code, automate workflows, and integrate with platform features.
18+
Manage plugins:: Browse and install extensions to add features, connect with external tools, and customize your experience.

‎modules/configuring-the-quickstarts/proc-customize-rhdh-quickstart.adoc‎

Lines changed: 55 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
1+
[id="customizing-your-product-quickstart_{context}"]
2+
= Customizing your {product} Quickstart
3+
4+
As an administrator, you can configure the {product} Quickstart plugin to create customized onboarding for your {product-short} users.
5+
6+
.Prerequisites
7+
You must have administrator permissions.
8+
9+
.Procedure
10+
. Update your `{my-app-config-file}`, as follows:
11+
+
12+
.Example of a customized Quickstart plugin
13+
[source,yaml]
14+
----
15+
app:
16+
quickstart:
17+
- title: 'Welcome to Developer Hub' # <1>
18+
description: 'Learn the basics of navigating the Developer Hub interface' # <2>
19+
icon: 'home' # <3>
20+
cta:
21+
text: 'Get Started' # <4>
22+
link: '/catalog' # <5>
23+
- title: 'Create Your First Component'
24+
description: 'Follow our guide to register your first software component'
25+
icon: 'code'
26+
cta:
27+
text: 'Create Component'
28+
link: '/catalog-import'
29+
- title: 'Explore Templates'
30+
description: 'Discover available software templates to bootstrap new projects'
31+
icon: 'template'
32+
cta:
33+
text: 'Browse Templates'
34+
link: '/create'
35+
----
36+
<1> (Required) The display title for the quickstart step.
37+
<2> (Required) A brief description of what the step covers.
38+
<3> Icon identifier (supports Material UI icons).
39+
<4> CTA button text.
40+
<5> CTA target URL or route.
41+
42+
== Disabling the Quickstart plugin
43+
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:
44+
45+
.Example of disabling the Quickstart plugin
46+
[source,yaml]
47+
----
48+
global:
49+
dynamic:
50+
includes:
51+
- dynamic-plugins.default.yaml
52+
plugins:
53+
- package: ./dynamic-plugins/dist/red-hat-developer-hub-backstage-plugin-quickstart
54+
disabled: true
55+
----

‎modules/configuring-the-quickstarts/proc-starting-and-completing-modules-in-quickstarts.adoc‎

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
[id='proc-starting-and-completing-modules-in-quickstarts_{context}']
2+
= Using Quickstart onboarding steps
3+
4+
You can use the Quickstart onboarding steps to learn more about the administrator features of {product-very-short}.
5+
6+
.Prerequisites
7+
* (Optional) If RBAC is enabled, you must have administrator permissions to access to the Quickstart feature.
8+
9+
.Procedure
10+
To start a Quickstart step in {product}, complete the following steps:
11+
12+
. In your {product-very-short} navigation menu, click the *Help* (`?`) icon.
13+
. In the dropdown menu, click *Quick start*.
14+
. Select the Quickstart step that you would like to begin.
15+
. To close the Quickstart drawer, click *Hide*.
16+
+
17+
image::rhdh/about-quickstarts.png[About Quickstarts]
18+
+
19+
[NOTE]
20+
====
21+
Your overall progress is tracked and displayed as a progress bar and a progress percentage in the Quickstart footer.
22+
====

‎titles/customizing/master.adoc‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,8 @@ include::assemblies/assembly-configuring-the-global-header.adoc[leveloffset=+1]
3030

3131
include::assemblies/assembly-configuring-a-floating-action-button.adoc[leveloffset=+1]
3232

33+
include::assemblies/assembly-configuring-the-quickstarts.adoc[leveloffset=+1]
34+
3335

3436
include::assemblies/assembly-customizing-the-tech-radar-page.adoc[leveloffset=+1]
3537

0 commit comments

Comments
 (0)