Red Hat Summit Red Hat SummitSupportoConsoleSviluppatoriInizia una provaContatti

Questo contenuto non è disponibile nella lingua selezionata.

Chapter 8. Customizing the Quickstart plugin

8.1. About Quickstarts
Copia collegamento

The Quickstart plugin provides guided onboarding for users 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 not 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.

You can manage user access to Quickstarts by using RBAC to define user roles that use the following logic in your RBAC configuration:

  • If RBAC is enabled (permission.enabled: true), the system determines user roles based on permissions, as follows:

    • Users with policy.entity.create permission are assigned the admin role.
    • Users without this permission are assigned the developer role.
Note

If RBAC is disabled (permission.enabled: false) or not configured, users are assumed to be platform engineers setting up Red Hat Developer Hub (RHDH) and are assigned the admin role.

The following two roles are supported for defining access to Quickstarts:

admin
Platform engineers, administrators, and users with elevated permissions
developer
Regular developers and users with standard permissions

The following behavior applies when you use RBAC to assign roles for your Quickstarts:

  • Quickstart items without a roles property default to the admin role.
  • Items can specify multiple roles, for example, admin and developer.
  • Users see Quickstart items that match their assigned role.

Example configuring RBAC for a Quickstart in your app-config.yaml file

permission:
  enabled: true

app:
  quickstart:
    - title: 'Platform Configuration'
      titleKey: steps.platformConfiguration.title
      roles: ['admin']
      # Only admins see this
    - title: 'Getting Started as Developer'
      titleKey: steps.gettingStarted.title
      roles: ['developer']
      # Only developers see this
    - title: 'Universal Welcome Guide'
      titleKey: steps.universalWelcome.title
      roles: ['admin', 'developer']
      # Both user roles see this
Copy to Clipboard Toggle word wrap

8.3. Customizing your Red Hat Developer Hub Quickstart
Copia collegamento

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 with the following code: 

    app:
  quickstart:
    - title: 'Welcome to Developer Hub'
      description: 'Learn the basics of navigating the Developer Hub interface'
      icon: 'home'
      roles: ['admin', 'developer'] # Show to both roles
      cta:
        text: 'Get Started'
        link: '/catalog'
    - title: 'Create Your First Component'
      description: 'Follow our guide to register your first software component'
      icon: 'code'
      roles: ['admin', 'developer'] # Show to both roles
      cta:
        text: 'Create Component'
        link: '/catalog-import'
    - title: 'Explore Templates'
      description: 'Discover available software templates to bootstrap new projects'
      icon: 'template'
      roles: ['admin', 'developer'] # Show to both roles
      cta:
        text: 'Browse Templates'
        link: '/create'
    Copy to Clipboard Toggle word wrap

    where:

    title
    Enter the display title for the quickstart step.
    description
    Enter the brief description of what the step covers.
    icon

    (Optional) Enter the icon identifier. You can use a full image URL, a valid SVG path, or one of the following common keys:

    • home
    • group
    • category
    • extension
    • school
    • add
    • list
    • layers
    • star
    • favorite
    • bookmarks
    • queryStats
    • chart
    • business
    • storefront
    • folder
    • cloud
    • monitor
    • feedback
    • validate
    • security
    • help
    • support
    • quickstart
    • notifications
    • manageAccounts
    • logout
    • developerHub
    • account
    • admin
    • roles: Optional: Enter an array of user roles that must see this quickstart item. Supported values: ['admin', 'developer']. If not specified, defaults to ['admin'].
    • cta
    • text: Optional: Enter the CTA button text.
    • link: Optional: Enter the CTA target URL or route.

8.3.1. Disabling the Quickstart plugin
Copia collegamento

The Quickstart plugin is pre-loaded in Developer Hub with basic configuration properties, and enabled by default.

Procedure

  • To disable the Quickstart plugin, set the disabled property to true as shown in the following code: 

    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

8.4. Using Quickstart onboarding steps
Copia collegamento

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.

    About Quickstarts
    View larger image
    About Quickstarts
    Note

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

8.5. Enabling Quickstart localization in RHDH
Copia collegamento

You can enable translation key support for Quickstart titles, descriptions, and CTAs, so that users can onboard in their preferred language. In Developer Hub, all existing and newly created Quickstart steps support localization using dedicated translation keys (titleKey, descriptionKey, cta.textKey).

Note

If a translation key is present but the corresponding localized string is missing, the system defaults to the original text defined in the Quickstart configuration (title, description, text). If no translation key is defined at all, the original text is displayed.

Prerequisites

  • You have enabled localization in your RHDH application.

Procedure

  1. For all Quickstart steps (both existing and new) in your configuration file, you must define both the original text and the new localization keys. For example, in the quickstart section of your custom app-config.yaml file, add the titleKey, descriptionKey, and textKey values, as follows:

    app-config.yaml fragment

    app:
  quickstart:
    # Existing Quickstart steps should also be updated with keys
    - title: 'Setup Authentication'
      titleKey: steps.setupAuth.title
      description: 'Learn the basics of navigating the Developer Hub interface'
      descriptionKey: steps.setupAuth.description
      icon: 'home'
      cta:
        text: 'Get Started'
        textKey: steps.setupAuth.ctaTitle
        link: '/catalog'
# ...
    Copy to Clipboard Toggle word wrap

    where:

    title
    (Mandatory) Fallback for the title.
    titleKey
    Key for the translated title.
    description
    (Mandatory) Fallback for the description.
    descriptionKey
    Key for the translated description.
    text
    (Mandatory) Fallback for the CTA text.
    textKey
    Key for the translated CTA text.

  2. In your dynamic-plugins.yaml file, add the translationResources section to your red-hat-developer-hub-backstage-plugin-quickstart configuration, as follows:

    app-config.yaml fragment

    plugins:
  - package: ./dynamic-plugins/dist/red-hat-developer-hub-backstage-plugin-quickstart
      disabled: false
      pluginConfig:
        dynamicPlugins:
          frontend:
            red-hat-developer-hub.backstage-plugin-quickstart:
              # translationResources definition is required for translations to work
              translationResources:
                - importName: quickstartTranslations
                  ref: quickstartTranslationRef
              # ... other configurations like mountPoints ...
    Copy to Clipboard Toggle word wrap

    where:

    importName
    Enter the name used to reference the import.
    ref
    Reference to the resource definition.

  3. In your translation file, map the keys from the first step to the localized strings for each supported language.

    allTranslations.json fragment

    "plugin.quickstart": {
  "en": {
    "steps.setupAuth.title": "Manage plugins EN",
    "steps.setupAuth.description": "EN Browse and install extensions to add features, connect with external tools, and customize your experience.",
    "steps.setupAuth.ctaTitle": "Start"
  },
  "fr": {
    "steps.setupAuth.title": "Gérer les plugins FR",
    "steps.setupAuth.description": "FR Parcourez et installez des extensions pour ajouter des fonctionnalités, vous connecter à des outils externes et personnaliser votre expérience.",
    "steps.setupAuth.ctaTitle": "Commencer"
  }
}
    Copy to Clipboard Toggle word wrap

Torna in cima
Red Hat logoGithubredditYoutubeTwitter

Formazione

Prova, acquista e vendi

Community

Informazioni sulla documentazione di Red Hat

Aiutiamo gli utenti Red Hat a innovarsi e raggiungere i propri obiettivi con i nostri prodotti e servizi grazie a contenuti di cui possono fidarsi. Esplora i nostri ultimi aggiornamenti.

Rendiamo l’open source più inclusivo

Red Hat si impegna a sostituire il linguaggio problematico nel codice, nella documentazione e nelle proprietà web. Per maggiori dettagli, visita il Blog di Red Hat.

Informazioni su Red Hat

Forniamo soluzioni consolidate che rendono più semplice per le aziende lavorare su piattaforme e ambienti diversi, dal datacenter centrale all'edge della rete.

Theme

© 2025 Red Hat