Uploaded image for project: 'Red Hat Internal Developer Platform'
  1. Red Hat Internal Developer Platform
  2. RHIDP-9808

[internal]Create Developer Guide for Exporting Custom Plugins into RHDH Local

    • False
    • Hide

      None

      Show
      None
    • False

      Summary

      New developers struggle to export and test custom plugins in RHDH because no clear documentation exists. This task is to create simple, step-by-step guidance.


      Problem

      Developers building RHDH plugins do not have an RHDH-specific guide on how to export and load their plugin locally.


      Scope / Deliverables

      1. Create an official developer guide covering:
        • How to scaffold a plugin (npx @backstage/create-plugin)
        • Required folder structure for RHDH
        • How to package/export the plugin
        • How to mount it into dynamic-plugins-root for local testing
        • Example Docker commands / local setup steps
      1. Provide a sample plugin repo that includes:
        • Basic plugin source
        • Packaging + export steps
        • How the plugin appears inside RHDH once loaded
      1. Add troubleshooting notes, including:
        • Common build errors
        • How to read/debug logs when a plugin fails to load

      Goal

      Lower the barrier for new plugin developers by giving them a clear, simple workflow for creating and testing custom plugins in RHDH.

              Unassigned Unassigned
              rh-ee-lprabhu Lokananda Prabhu
              RHIDP - Plugins
              Votes:
              0 Vote for this issue
              Watchers:
              1 Start watching this issue

                Created:
                Updated: