RHIDP-8240 - Create a Quickstart guide to support first-time onboarding for administrators

Author: Gerry-Forde

assemblies/assembly-configuring-the-quickstarts.adoc

@@ -0,0 +1,10 @@
+:_mod-docs-content-type: ASSEMBLY
+:context: configuring-the-quickstarts
+[id="{context}"]
+= Configuring the Quickstart plugin
+
+include::modules/configuring-the-quickstarts/con-about-quickstarts.adoc[leveloffset=+1]
+
+include::modules/configuring-the-quickstarts/proc-customize-rhdh-quickstart.adoc[leveloffset=+1]
+
+include::modules/configuring-the-quickstarts/proc-starting-and-completing-modules-in-quickstarts.adoc[leveloffset=+1]

images/rhdh/about-quickstarts.png

@@ -0,0 +1,13 @@
+:_mod-docs-content-type: CONCEPT
+
+[id="about-quickstarts_{context}"]
+= About Quickstarts
+
+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.
+
+The Quickstart plugin is enabled by default and includes the following components:
+
+Set up authentication:: Set up secure login credentials to protect your account from unauthorized access.
+Configure RBAC:: Assign roles and permissions to control who can view, create, or edit resources, ensuring secure and efficient collaboration.
+Configure Git:: Connect your Git providers, such as GitHub to manage code, automate workflows, and integrate with platform features.
+Manage plugins:: Browse and install extensions to add features, connect with external tools, and customize your experience.

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

@@ -0,0 +1,55 @@
+[id="customizing-your-product-quickstart_{context}"]
+= Customizing your {product} Quickstart
+
+You can configure the {product} Quickstart plugin to create a customized learning path for your {product-short} administrators. 
+
+.Prerequisites
+You must have sufficient permissions as a platform engineer.
+
+.Procedure
+. Update your your `app-config.yaml`, as follows:
++
+.Example of customizing the Quickstart plugin 
+[source,yaml]
+----
+app:
+  quickstart:
+    - title: 'Welcome to Developer Hub' # <1>
+      description: 'Learn the basics of navigating the Developer Hub interface' # <2>
+      icon: 'home' # <3>
+      cta:
+        text: 'Get Started' # <4>
+        link: '/catalog' # <5>
+    - title: 'Create Your First Component'
+      description: 'Follow our guide to register your first software component'
+      icon: 'code'
+      cta:
+        text: 'Create Component'
+        link: '/catalog-import'
+    - title: 'Explore Templates'
+      description: 'Discover available software templates to bootstrap new projects'
+      icon: 'template'
+      cta:
+        text: 'Browse Templates'
+        link: '/create'
+----
+<1> (Required) The display title for the quickstart step.
+<2> (Required) A brief description of what the step covers.
+<3> Icon identifier (supports Material UI icons).
+<4> CTA button text.
+<5> CTA target URL or route.
+
+== Disabling the Quickstart plugin
+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:
+
+.Example of disabling the Quickstart plugin
+[source,yaml]
+----
+global:
+  dynamic:
+    includes:
+      - dynamic-plugins.default.yaml
+    plugins:
+      - package: ./dynamic-plugins/dist/red-hat-developer-hub-backstage-plugin-quickstart
+        disabled: true
+----

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

@@ -0,0 +1,22 @@
+[id='proc-starting-and-completing-modules-in-quickstarts_{context}']
+= Starting and completing modules in Quickstarts
+
+You can start a quick start module and complete it at your own pace.
+
+.Prerequisites
+. Your platform engineer has granted you access to the Quickstart plugin.
+
+.Procedure
+To start a quick start module in {product}, complete the following steps:
+
+. In your {product-very-short} navigation menu, click on the (`?`) icon.
+. Click *Quick start*.
+. Select the quick start module that you would like to begin.
+. To close the quick start drawer, click *Hide*.
++
+image::rhdh/about-quickstarts.png[About Quickstarts]
++
+[NOTE]
+====
+Your progress is tracked and displayed at the bottom of the drawer.
+====

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

@@ -30,6 +30,8 @@ include::assemblies/assembly-configuring-the-global-header.adoc[leveloffset=+1]
 
 include::assemblies/assembly-configuring-a-floating-action-button.adoc[leveloffset=+1]
 
+include::assemblies/assembly-configuring-the-quickstarts.adoc[leveloffset=+1]
+
 
 include::assemblies/assembly-customizing-the-tech-radar-page.adoc[leveloffset=+1]