[jboss-jira] [JBoss JIRA] Commented: (JBMESSAGING-1644) Work out a suitable way to provide JBM examples/doc for AS 5

[Howard Gao (JIRA)]

    [ https://jira.jboss.org/jira/browse/JBMESSAGING-1644?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=12472037#action_12472037 ] 

Howard Gao commented on JBMESSAGING-1644:
-----------------------------------------

Currently the standard download of AS 5 doesn't include the docs/examples of JBoss Messaging. That makes it hard for new users to learn how to configure and use JBoss Messaging that comes with AS 5 distribution. A lot of questions that the users put to the forum wouldn't have been necessary had there been an easy way to let users get the examples and documents.

However the current structure of a AS 5 distribution structure is not so ready to adapt those doc/example stuff, so I'm trying to find a way to fit in those bits.

My idea is to provide an extra distribution for AS 5. It is a single zip file downloadable along side with the JBoss AS 5 kit on the download page. The name is to be like:

jboss-5.1.0.GA-extra.zip

Once unzipped, it should have the following structure:

jboss-5.1.0.GA/
                       |
                       |----- extra/
                                      |----readme.txt (table of contents)
                                      |
                                      |----jboss-messaging
                                      |                             |
                                      |                             |-----doc
                                      |                             |
                                      |                             |------examples
                                      |
                                      |----other stuffs

This is let the whole stuff be easily copied to an existing AS 5 installation, resulting in an additional /extra sub dir under $JBOSS_HOME.

I believe this method not only address the issue of JBoss Messaging examples/doc, but also can provide a place for some other pieces that are not runtime essential to AS 5. For example, some of the stuff under the docs/ dir is not necessary for a server to startup and many of the files are not related to documentation. Such stuff like that can also goes to the extra package and that will make the AS 5 distribution more concise and slim.

That can benefits both advanced users and novices. For advanced users they don't need to download stuff they don't need. For novices they can easily find more resources regarding to all the supporting components (messaging, transactions, security etc) and get on quickly. That also save many core developers from answering obvious questions. Also this way the users can get the right versions with each release of AS 5 without having to finding out versions of those components within.

To do this, it needs to:

1. Put the extra stuff to somewhere under AS5's maven repository.
2. Add a build target 'extra' to  generate the extra package.
3. Upload the extra zip to the dowload page for AS5.


> Work out a suitable way to provide JBM examples/doc for AS 5
> ------------------------------------------------------------
>
>                 Key: JBMESSAGING-1644
>                 URL: https://jira.jboss.org/jira/browse/JBMESSAGING-1644
>             Project: JBoss Messaging
>          Issue Type: Task
>          Components: AS Integration
>    Affects Versions: 1.4.3.GA
>            Reporter: Howard Gao
>            Assignee: Howard Gao
>            Priority: Critical
>             Fix For: 1.4.5.GA
>
>
> Current AS 5 distribution kit doesn't have JBM doc/examples of the corresponding version included, that makes it very inconvenient to use JBM with AS5. Users often get confused with which version of JBM is the correct version, and where to get the resouces (docs, examples).
> We have to provide a solution to that. 

-- 
This message is automatically generated by JIRA.
-
If you think it was sent incorrectly contact one of the administrators: https://jira.jboss.org/jira/secure/Administrators.jspa
-
For more information on JIRA, see: http://www.atlassian.com/software/jira