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

[Docs] Incorrect GitHub Org Plugin Package Name

XMLWordPrintable

    • Icon: Bug Bug
    • Resolution: Unresolved
    • Icon: Normal Normal
    • 1.7.2
    • 1.7.0
    • Documentation
    • None
    • 1
    • False
    • Hide

      None

      Show
      None
    • False
    • RHDH Documentation 3283

      Description of problem:

      1. Document Containing the Error:

      Title: Authentication in Red Hat Developer Hub

      URL: https://docs.redhat.com/en/documentation/red_hat_developer_hub/1.7/html/authentication_in_red_hat_developer_hub/enabling-user-authentication-with-github

      Section: Step 3 of "Enabling user authentication with GitHub"

      2. Description of the Error:

      The documentation incorrectly refers to the plugin package as backstage-plugin-catalog-backend-module-github-org.

      Incorrect Text:

      Enable the GitHub organization provisioning plugin (backstage-plugin-catalog-backend-module-github-org).

      Incorrect dynamic-plugins.yaml example:

      plugins:

      • package: './dynamic-plugins/dist/backstage-plugin-catalog-backend-module-github-org'
        disabled: false

      3. The Correct Information:

      According to the official Dynamic Plugins Reference [1], the correct and supported package name is backstage-plugin-catalog-backend-module-github-org-dynamic.

      [1] Reference URL: https://docs.redhat.com/ja/documentation/red_hat_developer_hub/1.7/html-single/dynamic_plugins_reference/index#red-hat-supported-plugins

      4. Suggested Correction:

      The documentation should be updated to use the correct package name with the -dynamic suffix.

      Corrected Text:

      Enable the GitHub organization provisioning plugin (backstage-plugin-catalog-backend-module-github-org-dynamic).

      Corrected dynamic-plugins.yaml example:

      plugins:

      • package: './dynamic-plugins/dist/backstage-plugin-catalog-backend-module-github-org-dynamic'
        disabled: false

      This correction is important for users to successfully configure the dynamic plugin for GitHub organization ingestion.

              ffloreth@redhat.com Fabrice Flore-Thébault
              rhn-support-ksuzumur Keishi Suzumura
              RHIDP - Documentation
              Votes:
              0 Vote for this issue
              Watchers:
              3 Start watching this issue

                Created:
                Updated: