Red Hat Bugzilla – Bug 535375
add support for managed product configuration instructions embedded in plugin descriptors
Last modified: 2014-05-05 16:48:34 EDT
I see a 'help' element used in a couple places in on-plugin.xsd, but it doesn't look fully baked. A couple thoughts...
1) The help element should support version ranges, e.g.:
Configure Apache 1.3.x as follows...
2) The help text should be linked and/or displayed in both the docs and the GUI (i.e. for disconnected Servers). Our docs are Confluence, and the GUI is HTML. To avoid defining each help block twice in the descriptor, in two different formats, only define it one in Confluence format (for generating docs from), then simply make the help in the GUI a link to the docs page. This would also mean that we would only have to store the help links in the database, rather than all of the help text. Note, we'd probably want to have two help URLs associated with a resource type - a main help URL (i.e. the Managed Product page) and a connection help URL; both could be linked to from the GUI.
3) It would be nice, but not essential, to support include and append attributes for the help element, as Hyperic did in 1.x. This would prevent some redundancy, e.g.:
<help name="Apache 1.3" append="restart-server, test-snmp">...</help>
<help name="Apache 2.x" append="restart-server, test-snmp">...</help>
Move features/improvements to 1.4
This bug was previously known as http://jira.rhq-project.org/browse/RHQ-2078
mass add of key word FutureFeature to help track
Mazz, did any of these ever actually get implemented?
none of this got implemented. the help text is only shown in the plugin page when viewing the plugin information.