-
Story
-
Resolution: Obsolete
-
Minor
-
None
-
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
- is blocked by
-
HAC-55 SDK API consistency review
- Closed
- is cloned by
-
HAC-71 Documentation for App Bootstrap
- Closed
- is incorporated by
-
HAC-456 Bring Documentation Generation Effort to the SDK
- To Do
- is related to
-
HAC-277 Setup Contributing Guidelines for the SDK
- To Do
- relates to
-
HAC-53 split console backend into a sharable component for the SDK
- Closed
-
HAC-69 create a git repository for the SDK
- Closed
(1 relates to)