Bug 779132 (SOA-1530) - Beta1 - QE Review: Getting Started Guide
Summary: Beta1 - QE Review: Getting Started Guide
Keywords:
Status: CLOSED NEXTRELEASE
Alias: SOA-1530
Product: JBoss Enterprise SOA Platform 5
Classification: JBoss
Component: Documentation
Version: 5.0.0 GA
Hardware: Unspecified
OS: Unspecified
high
high
Target Milestone: ---
: 5.0.0 GA
Assignee: David Le Sage
QA Contact:
URL: http://jira.jboss.org/jira/browse/SOA...
Whiteboard:
Depends On:
Blocks:
TreeView+ depends on / blocked
 
Reported: 2009-10-15 03:20 UTC by David Le Sage
Modified: 2010-02-24 22:09 UTC (History)
0 users

Fixed In Version:
Doc Type: Bug Fix
Doc Text:
Clone Of:
Environment:
Last Closed: 2010-02-24 22:09:55 UTC
Type: Task


Attachments (Terms of Use)
Getting_Started_Guide.pdf (399.10 KB, application/pdf)
2009-10-15 03:20 UTC, David Le Sage
no flags Details


Links
System ID Private Priority Status Summary Last Updated
Red Hat Issue Tracker SOA-1530 0 None None None Never

Description David Le Sage 2009-10-15 03:20:14 UTC
Affects: Documentation (Ref Guide, User Guide, etc.)
Date of First Response: 2009-10-23 09:50:11
project_key: SOA

Len, please undertake a first-stage QE review of the SOA-P ESB Getting Started Guide to ensure that all the required material is presented and that any outdated information has been removed.  Many thanks.

Comment 1 David Le Sage 2009-10-15 03:20:51 UTC
Attachment: Added: Getting_Started_Guide.pdf


Comment 2 nwallace 2009-10-23 13:50:11 UTC
Section 2.2. 

In the case of the embedded Enterprise Application Platform version of the software, there is a profile
named default, but this is not actually the default profile. Rather, when the embedded EAP server is
started without any additional parameters, the profile named production is activated. Please refer to
Section 2.1.3, " Securing One's Server in a Production Environment " for more information about this
profile.


By default the Default server is started now.



Comment 3 nwallace 2009-10-23 14:11:03 UTC
section 2.2, Procedure 2.5

The SOA-P will now launch. Depending on if one is running the stand-alone or EAP or versions of the
program one will be running either the default or the production profile, respectively.

Both are Default.


Comment 4 Dana Mison 2009-11-06 07:52:50 UTC
Chapter 3 should be removed, it was new content in the upstream but mostly related to downloading and setting up the ESB

3.3.2 - might need to be added as a known issue, SOA-1584

3.3.3 - should go into a "migrating applications" section somewhere

3.3.4 - might belong towards the start of the programmer's guide

Comment 5 Len DiMaggio 2009-12-09 03:46:48 UTC
Section: Table 1.2. Server Profile Differences

Comment: We should change the phrase "ESB aware" to "Supports ESB archive deployment"

---------------

Section: 1.2. New Features in 5.0

JBoss ESB 4.7
   • Support for UDDI v3

Comment: We need to make it clear - if not in the getting started guide then somewhere - that use of the registry by ESB is an internal implementation detail, and hence configurations of UDDI v.3 might not work with ESB. We need to define the best way to explain this - please ping me, Anne-Louise, Burr and John Graham about the wording.
                       
• support for SAML tokens

Comment: This is a tech preview only!

---------------

Section: 2.1. Operating System Requirements

Comment: Remove the reference to RHEL4
Add: Microsoft Windows Server 2008, Solaris 9, Solaris 10 

---------------

Section 2.2 Java Virtual Machine Requirements

Comment: Remove all references to Java 1.5 in this document. These should be replaced with references to Java 1.6 Sun on all platforms and OpenJDK (on RHEL5).

---------------

Section 2.3 Database Requirements

The databases should be: Postgresql 8.3, Mysql 5.1, Oracle 10g, MS-SQL 2005, DB2 9.7, MS-SQL 2008, Oracle 11g)

---------------

Section 3. Installation

Comment: The JDKs and DBs are listed in comments above. The specific database drivers are listed in the jboss-soa-p.5.0.0/jboss-as/tools/schema/<dbname>/driver/name.properties files:

[ldimaggi@ldimaggi schema]$ cat */driver/name*
db.driver.jar=db2jcc.jar
db.driver.jar=sqljdbc4.jar
db.driver.jar=mysql-connector-java-5.0.*-bin.jar
db.driver.jar=mysql-connector-java-5.1.*-bin.jar
db.driver.jar=ojdbc14*.jar
db.driver.jar=postgresql-8.2-*.jdbc4.jar
db.driver.jar=postgresql-8.3-*.jdbc4.jar
db.driver.jar=jconn2.jar

---------------

Section: 3.3. The JBoss Operations Network Enterprise Service Bus
Plug-In

Note to Darrin and David - this section will change in the GA version of the guide.

---------------

Section: 4.1.2. Creating a Development Profile

Comment: Example 4-1 refers to 4.3 artifacts - these should refer to 5.0 files/dirs only.

---------------

Section 4.2. Starting the JBoss Enterprise Service-Oriented
Architecture Platform

Text:

In the case of the embedded Enterprise Application Platform version of the software, there is a profile
named default, but this is not actually the default profile. Rather, when the embedded EAP server is
started without any additional parameters, the profile named production is activated.

Comment: In 5.0, the "default" profile is the default. This is a change from 4.x

---------------

Section: Example 6.2

        17:25:12,614 INFO [STDOUT] &&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&
17:25:12,615 INFO [STDOUT] Body: Hello World
17:25:12,615 INFO [STDOUT] &&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&
17:25:12,615 INFO [STDOUT] Message structure:
17:25:12,615 INFO [STDOUT] [ message: [ JBOSS_XML ]
Example 6.2. Hello World Quick Start console output

Comment: Formatting of the 1st line ^

---------------

Section: Appendix A. Installing a Java
Development Kit (JDK) on Red Hat
Enterprise Linux

Comment: We need to remove all references to RHEL4 and JDK 1.5











Comment 6 David Le Sage 2009-12-09 04:04:46 UTC
Assigned to Darrin.

Comment 7 Len DiMaggio 2009-12-09 04:10:45 UTC
Correction!  Don't remove the references to RHEL4...sorry!

Comment 8 Len DiMaggio 2009-12-09 12:17:48 UTC
Not a technical review comment - but I think it's worth changing the opening of the first chapter from this: 

==============
JBoss Enterprise SOA Platform is a certified, tested, and supported platform for developing Enterprise Application Integration and Service Oriented Architecture solutions. 

It integrates several stable and scalable open source frameworks and solutions including Hibernate, Seam, JBoss Transactions, JBoss Clustering, the JBoss Application Server, and JBoss Enterprise Service Bus (ESB) to provide an infrastructure for enterprise SOA applications. 

These community developed and enterprise certified and supported products have been combined and tested to provide a solid, robust, and scalable platform. Powered by legendary JBoss innovation and backed by Red Hat engineering and quality assurance, JBoss Enterprise SOA Platform is the platform of choice for a new generation of enterprise applications. 
==============

To this:

==============
JBoss Enterprise SOA Platform is a certified platform for developing Enterprise Application Integration and Service Oriented Architecture solutions. 

The Platform integrates several stable open source frameworks and community developed products including Hibernate, Seam, JBoss Transactions, JBoss Clustering, the JBoss Application Server, and JBoss Enterprise Service Bus (ESB) to provide a solid, robust, and scalable infrastructure for enterprise SOA applications. 

Powered by JBoss innovation and backed by Red Hat engineering, quality assurance and support, JBoss Enterprise SOA Platform is the platform of choice for a new generation of enterprise applications. 
==============

Comment 10 Dana Mison 2009-12-17 08:06:49 UTC
5.0.0 Beta1 doc is available on http://redhat.com/docs/JBoss_SOA_Platform/

Comment 11 Len DiMaggio 2010-01-28 20:53:34 UTC
Starting final review pass.

Comment 13 Petr Vasicek 2010-01-29 16:12:27 UTC
some typos - use of "an" instead of "a"
2.4 - ...do they represent an minimum requirement...
4.3 - ...to Section 5.1, "Launching an Zip installation". 
5.1 - Launching an Zip installation

4.1.2 - Copy the development console WAR archive from the tools/resources directory to the *deploy* directory of the server configuration.
It should be *deploy/jbpm.esb*. It's the same for both standalone and eap-embedded version.

4.1.2 - Not sure about this one but in the sentence above there's a difference for standalone and eap-embeddet version:
for standalone is - to the deploy directory of the *default* server configuration
for eap-embedded just - to the deploy directory of the server configuration

4.1.3 - This value (DownloadServerClasses) is configured to false by default in "EAP Embedded" edition.
Actually it's false only for "production" config, for all others it's true by default. Maybe it should be mentioned there.

7 - In the very first paragraph there is: "They can be used Insert definition of what the quickstarts are and what they are for."
It looks that someone forgot to substitute this for the actual definition :-)

Comment 14 Petr Vasicek 2010-01-29 17:50:22 UTC
In the HelloWorld quickstart the output in my case was:
18:41:45,410 INFO  [STDOUT] &&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&
18:41:45,424 INFO  [STDOUT] Body: Hello World
18:41:45,424 INFO  [STDOUT] &&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&
18:41:45,425 INFO  [STDOUT] Message structure: 
18:41:45,425 INFO  [STDOUT] [Hello World].

So the last line is different from what is in the guide:
17:25:12,615 INFO [STDOUT] [ message: [ JBOSS_XML ] 

Comment 15 Petr Vasicek 2010-01-29 17:56:07 UTC
One more thing, in 7.1 there is: 
Ensure that the ${SOA_ROOT}/samples/quickstart/conf/quickstarts.properties file has the correct

However in 3.1 the SOA_ROOT is defined as follows:
Extract the folder from the zip file to the directory where you want it installed. This directory is referred to as the SOA Root directory or SOA_ROOT

Just thought it may be confusing for someone although it's pretty clear what is meant by SOA_ROOT in the 7.1.


Comment 16 Len DiMaggio 2010-02-01 20:45:56 UTC
David - back to you for a final edit.

Comment 17 Dana Mison 2010-02-18 07:43:59 UTC
feedback from the 29th has been incorporated.

http://documentation-stage.bne.redhat.com/docs/en-US/JBoss_Enterprise_SOA_Platform/5.0.0/html/Getting_Started_Guide/

Comment 18 Petr Vasicek 2010-02-18 16:15:38 UTC
it looks ok


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