[esb-issues] [JBoss JIRA] Closed: (JBESB-702) MR3 Issues with Getting Started Guide

MR3 Issues with Getting Started Guide -------------------------------------- Key: JBESB-702 URL: http://jira.jboss.com/jira/browse/JBESB-702 Project: JBoss ESB Issue Type: Bug Security Level: Public(Everyone can see) Components: Documentation Affects Versions: 4.2 Milestone Release 3 Reporter: Tom Cunningham Assigned To: Tom Cunningham Priority: Critical Fix For: 4.2 Milestone Release 3 There's a lot of issues with the "Getting Started" guide - Burr came up with a list that he saw (see below). A lot of these are pretty heinous (telling users to use the wrong version of the appserver, incorrect steps with deployment.properties, etc) because it hasn't been updated since MR2. I'd really like to get this in to MR3 because this is the first thing that a new user looks at. * Page 9 has "After downloading and expanding the JBoss ESB 4.0 GA distribution" and the directory structure is now different based on the new samples that have been added or renamed. * Page 10 has "JBoss Application Server v4.0.5GA [with ejb3]" I believe we are now focused on AS 4.2 + Messaging 1.3.0 * Page 10: "You can deploy it to JBossAS, to Tomcat, or run it in standalone mode. " is not accurate. We have standalone bootstrapper & we have the standalone ESB Server. Page 12 walks the user through using the bootstrapper as the very first test so it is important that we clearly articulate what that animal is OR we change the nature of the test. Since this is the "Getting Started" guide we should really push the user into the use of the AS, not bootstrapper, not ESB Server, not Tomcat. The AS model is the only one that supports all features (e.g. WS hosting only works with AS). Plus that is the only deployment option that is well tested. * Page 10: "download the JBossESB 4.0.5GA" should refer to the proper version of AS that we want. * Page 10: "Run 'ant'. This will deploy the esb to your JBossAS instance. It copies the jbossesb.sar into your deploy directory." is no longer accurate, we deploy a couple of SARs and a several .esbs. We should list the files that are in fact deployed/tweaked on an existing AS instance. We should insert a screenshot of what the deploy directory now looks like. This section is confusing because it refers to "Standalone" and "Deploy to JBossAS" and it is unclear if I have to do both or that I can just pick one of these options. The example of the deployment.properties needs to be updated to reflect the correct version of AS and the "messaging" profile instead of "default". Note: I've not tested any of the quickstarts against the Tomcat deployment model so it is not clear to me if this even works. * Page 12: There a spurious "JBossESB" directly after "Content-Based Router," in the line that describes jbrules.esb * Page 12/13: should also demonstrate the .esb archive deployment model. Plus it should include screen shots of the various command windows so that it is even easier to visually "see" a valid test. * Page 14: The diagram is no longer accurate. It refers to 2 queues and those names are no longer used by the helloworld quickstart. Plus the Service Name has changed. * Page 14: Step 1 Service Registry is not accurate. It tries to describe the service registry capability as if it is "db" based, when in this particular quickstart (and virtually all of them) we are using the RMI-based trick to work with the UDDI registry living inside of the ESB Server or AS. Step 3 refers to the wrong service name and wrong queue name. We are trying to eliminate all references to "queue/B", "A,C &D" in the quickstarts so there are no overlapping service names or queue names as that causes havoc when you deploy more than one at a time. * Page 16: It seems the diagram is repeated (with the same errors as before) for some reason that is not clear to me. This document should also be published on the wiki/website for users who wish to review but not yet download. Plus, I intend to built "videos" of various demos that are hung off our blogs/wiki for those people who don't wish to ready & try first but just sit back and get a series of demos to determine if this is the right technology for them. Finally, we need a quickstarts "trailmap": 1. helloworld 2. helloworld_action 3. more_action 4. helloworld_file_action 5. helloworld_ftp_action 6. simple_cbr 7. fun_cbr 8. business_service 9. business_rules_service 10. scripting_groovy 11. transform_CSV2XML 12. transform_XML2POJO 13. transform_XML2XML_simple 14. transform_XML2XML_date_manipulation 15. aggregator 16. bpm_orchestration1 17. bpm_orchestration2 18. webservice_consumer1 19. webservice_producer The rest based upon what feature you need to understand next. aggregator & the bpm examples are fairly advanced so they build on the previous ones. the webservice ones are somewhat hard to grok so you need to feel really good about jboss-esb.xml and actions classes long before you get to this example.