Uploaded image for project: 'Red Hat Developer Hub Bugs'
  1. Red Hat Developer Hub Bugs
  2. RHDHBUGS-2264

RHDH Docs: Create a "Golden Path" Guide for New Custom Plugin Development

XMLWordPrintable

    • Icon: Bug Bug
    • Resolution: Unresolved
    • Icon: Undefined Undefined
    • None
    • 1.7.1
    • Documentation, Plugins
    • None
    • False
    • Hide

      None

      Show
      None
    • False

      Description of problem:

      There is a complete lack of a clear, step-by-step guide explaining the "Red Hat way" and the process to start developing a brand-new custom plugin for RHDH, which is critical for customer adoption.

      In addition there are several valid general questions, where our documentation doesn't provide any guidance: 

      • Why do we need to use Backstage to develop a plugin if we are using RHDH?
      • What versions of Backstage and other dependencies should we use? Why do we care about Backstage versions if we are using RHDH?
      • How to bootstrap a new plugin?
      • What does `npx @red-hat-developer-hub/cli package export` do? Why is it needed?
      • Why do we need to package the plugin as an OCI?
      • You told me that I should develop it as a Backstage plugin; why are all these extra steps suddenly required?

      Prerequisites (if any, like setup, operators/versions):

      Steps to Reproduce

      Attempt to start developing a new RHDH custom plugin using only the available documentation.

      Actual results:

      Developers were unable to get started on their own without active help of RH engineering / SSA.

      Expected results:

       

      A comprehensive, streamlined "golden path" guide on bootstrapping and developing a new plugin for RHDH that contrasts favorably with vanilla Backstage.

      Reproducibility (Always/Intermittent/Only Once):

      Always

      Build Details:

      RHDH 1.7.1{}

      Additional info (Such as Logs, Screenshots, etc):

      https://github.com/gashcrumb/dynamic-plugins-getting-started

       

      https://docs.google.com/document/d/1CiuWpdpn-6ckr-pwLEW4ovPHD1iejBOJfDSdnpqngNg/edit?tab=t.0

       

              Unassigned Unassigned
              maschind@redhat.com Manuel Schindler
              RHIDP - Documentation
              Votes:
              0 Vote for this issue
              Watchers:
              2 Start watching this issue

                Created:
                Updated: