Uploaded image for project: 'Hybrid Application Console'
  1. Hybrid Application Console
  2. HAC-56

documentation for plugin developers

This issue belongs to an archived project. You can view it, but you can't modify it. Learn more

XMLWordPrintable

    • Icon: Story Story
    • Resolution: Obsolete
    • Icon: Minor Minor
    • 02-04
    • None
    • Core
    • False
    • False

      All tools necessary to build and develop a plugin should be documented.

      Acceptance Criteria

      • JSDoc all APIs and extensions
        • Intent is to generate API documentation
        • Extension docs are already generated from JSDoc
      •  Document
        • extensions
        • utilities apis
          • Eg. the utilities like `useActivePerspective` and others provided in the api.ts
        • UI components - react props
          • Eg: Custom resources like a Resource Link or some other generic part of the puzzle (not necessarily something that can be provided by extensions)
          • Do we want another repo for these?
          • Does this stuff really belong in the SDK, can it be in Patternfly?
        • plugin development / build

      Details

      • Some existing documentation foundational work exists today

              spadgett@redhat.com Samuel Padgett
              christianvogt Christian Vogt
              Archiver:
              rhn-support-sthamilt Stacey Hamilton

                Created:
                Updated:
                Resolved:
                Archived: