Este contenido no está disponible en el idioma seleccionado.

Chapter 9. Customizing the Quickstart plugin


9.1. About Quickstarts

The Quickstart plugin provides guided onboarding for adminstrators of Red Hat Developer Hub. It displays a customizable drawer interface with interactive quickstart steps that help users get familiar with the platform.

Note

If RBAC is enabled, Quickstart is only accesible to users with administrator permissions.

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.

9.1.1. Disabling the Quickstart plugin

The Quickstart plugin is pre-loaded in Developer Hub 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

global:
  dynamic:
    includes:
      - dynamic-plugins.default.yaml
    plugins:
      - package: ./dynamic-plugins/dist/red-hat-developer-hub-backstage-plugin-quickstart
        disabled: true
Copy to Clipboard Toggle word wrap

9.2. Customizing your Red Hat Developer Hub Quickstart

As an administrator, you can configure the Red Hat Developer Hub Quickstart plugin to create customized onboarding for your Developer Hub users.

Prerequisites

You must have administrator permissions.

Procedure

  1. Update your app-config.yaml, as follows:

    Example of a customized Quickstart plugin

    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'
    Copy to Clipboard Toggle word wrap

    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.

9.3. Using Quickstart onboarding steps

You can use the Quickstart onboarding steps to learn more about the administrator features of RHDH.

Prerequisites

  • (Optional) If RBAC is enabled, you must have administrator permissions to access to the Quickstart feature.

Procedure

To start a Quickstart step in Red Hat Developer Hub, complete the following steps:

  1. In your RHDH navigation menu, click the Help (?) icon.
  2. In the dropdown menu, click Quick start.
  3. Select the Quickstart step that you would like to begin.
  4. To close the Quickstart drawer, click Hide.

    Note

    Your overall progress is tracked and displayed as a progress bar and a progress percentage in the Quickstart footer.

Volver arriba
Red Hat logoGithubredditYoutubeTwitter

Aprender

Pruebe, compre y venda

Comunidades

Acerca de la documentación de Red Hat

Ayudamos a los usuarios de Red Hat a innovar y alcanzar sus objetivos con nuestros productos y servicios con contenido en el que pueden confiar. Explore nuestras recientes actualizaciones.

Hacer que el código abierto sea más inclusivo

Red Hat se compromete a reemplazar el lenguaje problemático en nuestro código, documentación y propiedades web. Para más detalles, consulte el Blog de Red Hat.

Acerca de Red Hat

Ofrecemos soluciones reforzadas que facilitan a las empresas trabajar en plataformas y entornos, desde el centro de datos central hasta el perímetro de la red.

Theme

© 2025 Red Hat