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

[QE] Be able to add Techdocs Add-ons to Techdocs - Test Scenarios

    • Icon: Task Task
    • Resolution: Done
    • Icon: Major Major
    • 1.5.0
    • None
    • Quality, TechDocs
    • None
    • RHDH Plugins 3269

      Need to come up with the test scenarios that will be required for the Techdocs add-ons feature and capture them in this spike. Afterwards, we need to create a story to capture the work involved in turning the test scenarios into test automation.

       

      It might also be worth it to wait until after the outcome for RHIDP-5222. In case there are any other requirements that were missing in the original feature.

      Automate test case:

      https://github.com/backstage/backstage/tree/master/plugins/techdocs-module-addons-contrib

      for https://issues.redhat.com/browse/RHIDP-5499

      Test instructions:

      See https://github.com/redhat-developer/rhdh/pull/2238 for screen demo.

       

      1) The techdocs-module-addons-contrib is dynamically installed into RHDH by default so no installation step needs to be taken

      2) Verify that you are able to report issue by clicking on ReportIssue Icon that appears when you select some text in techdocs
      (verify for: Docs -> Backstage Showcase and for Catalog -> Backstage Showcase -> Docs entity tab)

      3) Adjust the app-config to load also TextSize and LightBox addons:

            - package: ./dynamic-plugins/dist/backstage-plugin-techdocs-module-addons-contrib
              disabled: false
              pluginConfig:
                dynamicPlugins:
                  frontend:
                    backstage.plugin-techdocs-module-addons-contrib:
                      techdocsAddons:
                        - importName: TextSize
                        - importName: LightBox
                        - importName: ReportIssue
      

      4) Verify the addons are loaded via Docs and via Catalog -> Backstage Showcase -> Docs entity tab:

      • you are still able to report issue by clicking on ReportIssue Icon that appears when you select some text in techdocs
      • you are able to adjust size of documentation from the header settings (top right corner)
      • clicking on any image will display the image in an overlay

              rh-ee-dzemanov Dominika Zemanovicova
              rh-ee-pknight Patrick Knight
              RHIDP - Plugins
              Votes:
              0 Vote for this issue
              Watchers:
              1 Start watching this issue

                Created:
                Updated:
                Resolved: