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

Document and provide examples for configuring plugin paths.

    • Icon: Task Task
    • Resolution: Unresolved
    • Icon: Normal Normal
    • None
    • 1.4.0
    • Documentation
    • False
    • Hide

      None

      Show
      None
    • False

      Something that I noticed in the 1.3 documentation was that the configuration and enablement of the pre-installed plugins is dependent on you knowing the file path location in the RHDH image, yet this didn't seem to be listed anywhere in the documentation. Instead we list the plugin's ID in the plugin reference doc such as "@backstage/plugin-catalog-backend-module-github" and assume that the PE/Admin knows how to translate this ID into the correct file path. To the best of my knowledge, we didn't anywhere explain how to take the plugin ID and convert it into a file Path.

      Sorry Gerry Forde I must have either missed it with the scroll bar or been looking in the wrong place. Perhaps it's more the fact that we should mention that for the plugins-config.yaml you need to use the path if the plugin has been pre-installed whereas for NPM downloads you need the plugin ID? A simple helpful tip about that in the right places could make it easier for first timers.

              gforde@redhat.com Gerry Forde
              gforde@redhat.com Gerry Forde
              RHIDP - Documentation
              Votes:
              0 Vote for this issue
              Watchers:
              1 Start watching this issue

                Created:
                Updated: