Skip to content

Commit 1b50fe2

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

File tree

2 files changed

+19
-27
lines changed

2 files changed

+19
-27
lines changed
Lines changed: 16 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -1,33 +1,22 @@
1-
= Using the Nexus Repository Manager plugin
1+
[id="using-quickstart-plugin"]
2+
= Using the Quickstart plugin
23

3-
The Nexus Repository Manager plugin displays the information about your build artifacts in your {product-short} application. The build artifacts are available in the Nexus Repository Manager.
4+
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.
45

5-
[IMPORTANT]
6-
====
7-
The Nexus Repository Manager plugin is a Technology Preview feature only.
6+
== Using the Context Hook
7+
Access quickstart drawer functionality in your components:
88

9-
Technology Preview features are not supported with Red Hat production service level agreements (SLAs), might not be functionally complete, and Red Hat does not recommend using them for production. These features provide early access to upcoming product features, enabling customers to test functionality and provide feedback during the development process.
9+
[source,yaml]
10+
----
11+
import { useQuickstartDrawerContext } from '@red-hat-developer-hub/backstage-plugin-quickstart';
1012
11-
For more information on Red Hat Technology Preview features, see https://access.redhat.com/support/offerings/techpreview/[Technology Preview Features Scope].
13+
const MyComponent = () => {
14+
const { openDrawer, closeDrawer, isDrawerOpen } =
15+
useQuickstartDrawerContext();
1216
13-
Additional detail on how Red Hat provides support for bundled community dynamic plugins is available on the https://access.redhat.com/policy/developerhub-support-policy[Red Hat Developer Support Policy] page.
14-
====
17+
return <button onClick={openDrawer}>Open Quickstart Guide</button>;
18+
};
19+
----
1520

16-
The Nexus Repository Manager is a front-end plugin that enables you to view the information about build artifacts.
17-
18-
.Prerequisites
19-
20-
- Your {product-short} application is installed and running.
21-
- You have installed the Nexus Repository Manager plugin.
22-
//For the installation process, see xref:installing-configuring-nexus-plugin[Installing and configuring the Nexus Repository Manager plugin].
23-
24-
.Procedure
25-
26-
1. Open your {product-short} application and select a component from the *Catalog* page.
27-
2. Go to the *BUILD ARTIFACTS* tab.
28-
+
29-
--
30-
The *BUILD ARTIFACTS* tab contains a list of build artifacts and related information, such as *VERSION*, *REPOSITORY*, *REPOSITORY TYPE*, *MANIFEST*, *MODIFIED*, and *SIZE*.
31-
32-
image::rhdh-plugins-reference/nexus-repository-manager.png[nexus-repository-manager-tab]
33-
--
21+
== Progress Persistence
22+
The plugin automatically saves progress to local storage, so users can continue where they left off even after refreshing the page or returning later.

assemblies/dynamic-plugins/assembly-using-rhdh-plugins.adoc

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,9 @@ include::../../artifacts/rhdh-plugins-reference/keycloak/keycloak-plugin-user.ad
1616
// Nexus
1717
include::../../artifacts/rhdh-plugins-reference/nexus-repository-manager/nexus-repository-manager-plugin-user.adoc[leveloffset=+1]
1818

19+
// Quickstart
20+
include::../../artifacts/rhdh-plugins-reference/quickstart/quickstart-plugin-user.adoc[leveloffset=+1]
21+
1922
// Tekton
2023
include::../../artifacts/rhdh-plugins-reference/tekton/tekton-plugin-user.adoc[leveloffset=+1]
2124

0 commit comments

Comments
 (0)