Bug 2083154 - Dynamic plugin sdk tsdoc generation does not render docs for parameters
Summary: Dynamic plugin sdk tsdoc generation does not render docs for parameters
Alias: None
Product: OpenShift Container Platform
Classification: Red Hat
Component: Management Console
Version: 4.11
Hardware: Unspecified
OS: Unspecified
Target Milestone: ---
: 4.11.0
Assignee: Jon Jackson
QA Contact: Yadan Pei
Depends On:
TreeView+ depends on / blocked
Reported: 2022-05-09 13:10 UTC by Jon Jackson
Modified: 2022-08-10 11:11 UTC (History)
3 users (show)

Fixed In Version:
Doc Type: If docs needed, set a value
Doc Text:
Clone Of:
Last Closed: 2022-08-10 11:10:43 UTC
Target Upstream Version:

Attachments (Terms of Use)

System ID Private Priority Status Summary Last Updated
Github openshift console pull 11501 0 None open Bug 2083154: Fix missing params and formatting issues in dynamic plug in generated API docs 2022-05-16 18:02:31 UTC
Red Hat Product Errata RHSA-2022:5069 0 None None None 2022-08-10 11:10:59 UTC

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.


Note You need to log in before you can comment on or make changes to this bug.