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

Improve content in Chapter 2 of Configuring Dynamic Plugins guide

Prepare for Y ReleasePrepare for Z ReleaseRemove QuarterXMLWordPrintable

    • RHDH Documentation 3266

      Make the following changes to improve the clarity of the content in the Configuring plugins in Red Hat Developer Hub guide: 

      Configuring plugins in Red Hat Developer Hub

      • Current: The name of the title is Configuring... but the majority of chapters are about/titled Installing... 
      • Suggested: Consider whether we are using the correct terms throughout the guide (installing / enabling / configuring) and also confirm whether the guide is accurately/appropriately named. 

      2.2. Preinstalled dynamic plugins

      • Current: To enable this plugin, add a package with the same name to the Helm chart and change the value in the disabled field to ‘false’.
      • Suggested: To enable a preinstalled plugin that is disabled by default, add a package with the same name as the plugin to the Helm chart and change the value in the disabled field to ‘false’.

      2.3. Installation of dynamic plugins using the Helm chart

      • Current:

      Enabling a plugin from an included file
      global: dynamic: includes:- dynamic-plugins.default.yaml
      plugins:- package: <some imported plugins listed in dynamic-plugins.custom.yaml> disabled: false
      Enabling a plugin that is disabled in an included file
      global: dynamic: includes:- dynamic-plugins.default.yaml
      plugins:- package: <some imported plugins listed in dynamic-plugins.custom.yaml> disabled: false

      • Suggested: Remove the Enabling a plugin that is disabled in an included file example since it is redundant to the Enabling a plugin from an included file __ example. 

       

      • Current: The content of the 2.3 and 2.3.3 sections seems connected and very relevant to each other, but these sections are separated by other modules 
      • Suggested:
        • Combine 2.3.1 Obtaining the integrity checksum with 2.3 so that 2.3.1 is no longer a separate module. 
        • Reposition 2.3.3 Installing external dynamic plugins using a Helm chart to 2.3.1
        • Reposition 2.3.2 Example Helm chart configurations to 2.3.3
        • Also consider whether the content in Installation of dynamic plugins using the Helm chart and Installing external dynamic plugins using a Helm chart should be combined into a single module or remain separate. 

       

      • Current: 2.7.1.1 Installing and configuring the AAP Backend plugin is under 2.7.1 For administrators, but there is no mention of an administrative role/permission requirement in the content 
      • Suggested: Add the role/permission requirements to the Prerequisite section of the proc module. 
      • Optional: In the Prerequisites section of 2.7.2.1 Accessing templates from AAP in Developer Hub, clarify that installing and configuring the AAP Backend plugin needs to have been done by an administrator. 

       
       
       
       

              gforde@redhat.com Gerry Forde
              rhn-support-lfrazier Lindsey Frazier (Inactive)
              RHIDP - Documentation
              Votes:
              0 Vote for this issue
              Watchers:
              4 Start watching this issue

                Created:
                Updated: