Bug 722920 - Improve documentation of all objects accessible in CLI
Summary: Improve documentation of all objects accessible in CLI
Status: CLOSED CURRENTRELEASE
Alias: None
Product: RHQ Project
Classification: Other
Component: Documentation
Version: 3.0.1
Hardware: Unspecified
OS: Unspecified
high
high vote
Target Milestone: ---
: ---
Assignee: Deon Ballard
QA Contact: Mike Foley
URL:
Whiteboard:
Keywords:
Depends On:
Blocks: jon3
TreeView+ depends on / blocked
 
Reported: 2011-07-18 13:29 UTC by Ondřej Žižka
Modified: 2013-09-01 19:19 UTC (History)
2 users (show)

(edit)
Clone Of:
(edit)
Last Closed: 2013-09-01 19:19:05 UTC


Attachments (Terms of Use)

Description Ondřej Žižka 2011-07-18 13:29:58 UTC
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.

Comment 1 Ondřej Žižka 2011-07-18 14:32:25 UTC
There's also javadocs for the API, but mostly lacks any info beyond method signatures.

http://documentation-stage.bne.redhat.com/docs/en-US/JBoss_Operations_Network/2.4/html/API_Guides/remote-api/index.html

Comment 2 Mike Foley 2011-12-02 19:22:53 UTC
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.

Comment 3 Deon Ballard 2012-06-28 20:24:09 UTC
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:
http://docs.redhat.com/docs/en-US/JBoss_Operations_Network/3.1/html/Dev_Writing_JON_Command-Line_Scripts/index.html

Hopefully, this works to make the CLI and JON scripts more understandable.

Comment 4 Heiko W. Rupp 2013-09-01 19:19:05 UTC
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.


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