Bug 2083154

Summary: Dynamic plugin sdk tsdoc generation does not render docs for parameters
Product: OpenShift Container Platform Reporter: Jon Jackson <jonjacks>
Component: Management ConsoleAssignee: Jon Jackson <jonjacks>
Status: CLOSED ERRATA QA Contact: Yadan Pei <yapei>
Severity: medium Docs Contact:
Priority: high    
Version: 4.11CC: jhadvig, spadgett, yapei
Target Milestone: ---   
Target Release: 4.11.0   
Hardware: Unspecified   
OS: Unspecified   
Fixed In Version: Doc Type: If docs needed, set a value
Doc Text:
Story Points: ---
Clone Of: Environment:
Last Closed: 2022-08-10 11:10:43 UTC Type: Bug
Regression: --- Mount Type: ---
Documentation: --- CRM:
Verified Versions: Category: ---
oVirt Team: --- RHEL 7.3 requirements from Atomic Host:
Cloudforms Team: --- Target Upstream Version:

Description Jon Jackson 2022-05-09 13:10:09 UTC
Description of problem:
Dynamic plugin doc generation script does not render parameters.

Version-Release number of selected component (if applicable):

How reproducible:

Steps to Reproduce:
1. cd into ./packages/console-dynamic-plugin-sdk
2. Run `yarn generate-docs` 
3. Check in ./packages/console-dynamic-plugin-sdk/generated/doc/api.md

Actual results:
No parameter fields are rendered in the generated markdown

Expected results:
Documentation for parameters should be rendered in the API docs

Additional info:
There is a typo in ./packages/console-dynamic-plugin-sdk/scripts/templates/api.md.ejs where parameters are supposed to be rendered, but the logic also needs to be updated so that when parameters is empty, no section is  rendered.

Comment 2 Yadan Pei 2022-06-01 08:53:21 UTC
1. cd into ./packages/console-dynamic-plugin-sdk
2. Run `yarn generate-docs` 
3. Check in ./packages/console-dynamic-plugin-sdk/generated/doc/api.md

WHEN no parameters, Parameters section table is not rendered, also the parameters are now correctly rendered

Comment 4 errata-xmlrpc 2022-08-10 11:10:43 UTC
Since the problem described in this bug report should be
resolved in a recent advisory, it has been closed with a
resolution of ERRATA.

For information on the advisory (Important: OpenShift Container Platform 4.11.0 bug fix and security update), and where to find the updated
files, follow the link below.

If the solution does not work for you, open a new bug report.