Bug 780573 (SOA-3009)

Summary: QE Review: SOA 4.3.CP05 Getting Started Guide
Product: [JBoss] JBoss Enterprise SOA Platform 4 Reporter: David Le Sage <dlesage>
Component: DocumentationAssignee: Len DiMaggio <ldimaggi>
Status: CLOSED NEXTRELEASE QA Contact:
Severity: high Docs Contact:
Priority: high    
Version: 4.3 CP05CC: ldimaggi
Target Milestone: ---   
Target Release: 4.3 CP05   
Hardware: Unspecified   
OS: Unspecified   
URL: http://jira.jboss.org/jira/browse/SOA-3009
Whiteboard:
Fixed In Version: Doc Type: Bug Fix
Doc Text:
Story Points: ---
Clone Of: Environment:
Last Closed: 2011-04-29 18:42:40 UTC Type: Task
Regression: --- Mount Type: ---
Documentation: --- CRM:
Verified Versions: Category: ---
oVirt Team: --- RHEL 7.3 requirements from Atomic Host:
Cloudforms Team: --- Target Upstream Version:

Description David Le Sage 2011-04-05 23:24:27 UTC
project_key: SOA

Please undertake a QE review of the 4.3.CP05 Getting Started Guide.  Note that this is a major revision of this book, as we have backported the structure from 5.1. Please be particularly alert for any 5.x series specific references in this book that will need to be removed.

Book is available on:  http://documentation-stage.bne.redhat.com/docs/en-US/JBoss_Enterprise_SOA_Platform/4.3/html-single/Getting_Started_Guide/index.html

Comment 1 Len DiMaggio 2011-04-07 18:46:33 UTC
Review comments:

Comments on new 4.3 CP05 Getting Started Guide

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

Page 1, Overview

Text:
Chapter 3 contains instructions on how to launch, shutdown and troubleshooting the JBoss
Enterprise SOA Platform product.

Comment:
Grammar - should be "troubleshoot"

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

Page 1, Section 1.1

Text:
JBoss Enterprise SOA Platform is also the supported deployment platform for JBoss Enterprise Data
Services. Refer to http://www.jboss.com/products/platforms/dataservices/ for more information about
this product.

Comment:
Remove this paragraph - EDS is SOA 5.1 only.

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

Page 4, Section 2.3

Text:
Important
This document does not cover the installation of the JBoss Enterprise Data Services Platform.
Refer to the EDS Getting Started Guide for information for installation instructions other details for
that product.

Comment:
Remove this paragraph - EDS is SOA 5.1 only.

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

Page 10, Section 2.2.4

Text:
2.4.4. Managing jUDDI Console Users
Read this section to learn about managing user accounts for publishers in the jUDDI Console.
Only the jUDDI publisher root, or another publisher with administration rights, can grant
administration rights to another publisher. Do this in the jUDDI Console by enabling the isAdmin
checkbox in the Publisher Details screen.
To enable root log-on, create the user root using the procedure described in Section 2.4.1,
“Creating Server Console User Accounts”. The role of user must be assigned to this user.

Comment:
Remove this section. The jUDDI console is added in SOA-P 5.x

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

Page 13, Section 3.1

Text:
Important
The startup time for the server using the production server profile is approximately two
minutes. This is slightly longer than previous releases due to the high number of new features in
this version.

Comment:
Remove this paragraph.

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

Page 17, Section 4.1.1

Text:
4.1.1. The "Helloworld" Quick-Start

Comment:
All references to "Helloworld" should be changed to "helloworld"

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

Page 19, Section 4.1.1 

Comment: We should add a more descriptive definition of "ESB-aware" to this section of the guide:

In describing application clients and services, the term "ESB-aware" means that they can understand the 
message format and transport protocols used by the JBossESB in the SOA Platform. Gateways are used to 
convert messages in ESB-unaware formats into a form that can be processed and routed by the ESB.

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

Page 21, section A2

Comment: We should refer to the Oracle JDK as the "Oracle JDK" not the "Sun Microsystems" JDK. (The following appendix does this already.)

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

Page 27, Appendix C. Verifying Downloaded Files

Comment: The screenshot and example text in this section refer to SOA-P 5 builds, not 4.3.

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

Page 29, Appendix D. Installing Apache Ant

Comment: References to ant 1.8 should be changed to ant 1.7








 







Comment 2 Len DiMaggio 2011-04-07 18:47:00 UTC
Hey David - back to you

Comment 3 David Le Sage 2011-04-07 22:53:10 UTC
Thanks Len. I have incorporated all of the feedback and also made some grammar fixes.  (This is another book that has suffered from awkward wording in places.)

Comment 4 Len DiMaggio 2011-04-29 18:42:40 UTC
Changes verified in the doc here:

http://documentation-stage.bne.redhat.com/docs/en-US/JBoss_Enterprise_SOA_Platform/4.3