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

Scaffolder relation processor actions has unlucky self-description and no examples

XMLWordPrintable

    • False
    • Hide

      None

      Show
      None
    • False

      Description of problem:

      When using the Installed actions catalog in RHDH, I can see the "in app" self-documentation of the catalog:annotate, catalog:scaffolded-from, catalog:template:version and catalog:timestamping actions. But the description is unlucky and there is no example so far.

      Steps to Reproduce

      1. In RHDH click Self-service ( icon) in the application header
      2. Click on the 3 dot menu icon on the top right side of the content and select Installed Actions

      Actual results:

      Similar for all four actions, here for catalog:annotate

      1. Description says: "Creates a new scaffolder action to annotate the entity object with specified label(s), annotation(s) and spec property(ies)."
      2. There is no example

      Expected results:

      For all four actions:

      1. The description should not include "Creates a new scaffolder action to". It should simply say what the action does.
      2. It should have ready to use examples.

      Build Details:

      1.9.0 (rc from testday)

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

              Unassigned Unassigned
              cjerolim Christoph Jerolimov
              RHDH Plugins
              Votes:
              0 Vote for this issue
              Watchers:
              1 Start watching this issue

                Created:
                Updated: