Red Hat Bugzilla – Bug 722920
Improve documentation of all objects accessible in CLI
Last modified: 2013-09-01 15:19:05 EDT
Especially Managers are quite undocumented.
There are some examples in http://documentation-stage.bne.redhat.com/docs/en-US/JBoss_Operations_Network/2.4/html-single/CLI_Guide/index.html
But complete reference is missing.
For example, an information that ResourceManager.findResourcesByCriteria(criteria)
does not return anything if the resource type is not specified must be found by user by triage/error method.
There's also javadocs for the API, but mostly lacks any info beyond method signatures.
also ... the proxy object has methods that are in addition to the remote interfaces of the SLSBs that are not contained in the javadoc. example see bz https://bugzilla.redhat.com/show_bug.cgi?id=759173 which has examples of methods on the proxy object that are not in the javadoc.
This is a tall order, but I have new chapters to the CLI doc that cover what the CLI is, what the different APIs are (at a very high level), and tasks that can be performed, with examples:
Hopefully, this works to make the CLI and JON scripts more understandable.
Bulk closing of BZs that have no target version set, but which are ON_QA for more than a year and thus are in production for a long time.