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

Documentation on the Software template editor should include a note that the Create button does nothing

Create Doc EPIC for Fe...Prepare for Y ReleasePrepare for Z ReleaseXMLWordPrintable

    • False
    • Hide

      None

      Show
      None
    • False

      Description of problem:

      This is a follow-up on RHDHBUGS-143, where a customer expected that they could test the software template in development test with the Template Editor.

      But the Template editor, available under Create > three dots > Template Editor > Edit Template Form is only to verify the frontend/form part of a software template.

      Software templates always run on the Server; this allows the Software templates to be really powerful. They can clone Git repositories, create Kubernetes, or connect to other APIs if needed. This part is called actions and couldn't be tested from the front end. Also, for security reasons!

      The Software template editor is a UI to test (and play) with these input parameters and the options to configure the UI input fields. For security reasons, users can not trigger any action directly from this editor.

      Our support team asked if we could make this fact clear with a note in the "Create a template by using the Template Editor" documentation:

      https://docs.redhat.com/en/documentation/red_hat_developer_hub/1.3/html/administration_guide_for_red_hat_developer_hub/assembly-admin-templates#proc-creating-templates_assembly-admin-templates

      Prerequisites (if any, like setup, operators/versions):

      None

      Steps to Reproduce

      1. Read the documentation
      2. Try to run a software template in RHDH

      Actual results:

      Software templates couldn't be executed in RHDH Template editor. But there is no hint on that in the documentation.

      Expected results:

      Software templates could still not be executed in RHDH Template editor., bt there is a hint on that in the documentation.

      Reproducibility (Always/Intermittent/Only Once):

      Always

      Build Details:

      1.3, should be similar in 1.4

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

              rhn-support-kavverma Kavya Verma
              cjerolim Christoph Jerolimov
              RHIDP - Documentation
              Votes:
              0 Vote for this issue
              Watchers:
              1 Start watching this issue

                Created:
                Updated: