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

[Docs] Improve Documentation for Entities: Mandatory Fields, Entity Tabs, and Conditional Visibility

XMLWordPrintable

    • 5
    • False
    • Hide

      None

      Show
      None
    • False

      Customers have requested clearer documentation about the different entity types in RHDH, including:

      • A list of all supported entities and their mandatory fields.
      • Guidance on when specific entity tabs (such as Provided APIs and Consumed APIs) appear in the UI. For example, these tabs are only displayed when the component type is set to service.
      • More explicit explanations aligned with the Backstage descriptor format (reference: https://backstage.io/docs/features/software-catalog/descriptor-format/).

      This enhancement should provide a consolidated and easy-to-follow section that explains entity structure, required attributes, and conditional UI behavior to help customers correctly configure their catalog entities.

              jvrbkova@redhat.com Jana Vrbkova
              hmanwani@redhat.com Heena Manwani
              RHDH Documentation
              Votes:
              0 Vote for this issue
              Watchers:
              1 Start watching this issue

                Created:
                Updated: