Uploaded image for project: 'OpenShift Console'
  1. OpenShift Console
  2. CONSOLE-3083

Add missing ts-doc for dynamic plugin SDK components

    XMLWordPrintable

Details

    • HAC Infra - Sprint 220, HAC Infra - Sprint 221

    Description

      This story only covers API components. We will create a separate story for other utility functions.

      Today we are generating documentation for Console's Dynamic Plugin SDK in
      frontend/packages/dynamic-plugin-sdk. We are missing ts-doc for a set of hooks and components.

      We are generating the markdown from the dynamic-plugin-sdk using

      yarn generate-doc

      Here is the list of the API that the dynamic-plugin-sdk is exposing:

      https://gist.github.com/spadgett/0ddefd7ab575940334429200f4f7219a

      Acceptance Criteria:

      • Add missing jsdocs for the API that dynamic-plugin-sdk exposes

      Out of Scope:

      • This does not include work for integrating the API docs into the OpenShift docs
      • This does not cover other public utilities, only components.

      Attachments

        Issue Links

          Activity

            People

              zherman Zac Herman
              jhadvig@redhat.com Jakub Hadvig
              YaDan Pei YaDan Pei
              Votes:
              0 Vote for this issue
              Watchers:
              2 Start watching this issue

              Dates

                Created:
                Updated:
                Resolved: