Bug 779822 (SOA-2183)

Summary: QE Review - Programmers' Guide
Product: [JBoss] JBoss Enterprise SOA Platform 5 Reporter: David Le Sage <dlesage>
Component: DocumentationAssignee: David Le Sage <dlesage>
Status: CLOSED NEXTRELEASE QA Contact:
Severity: high Docs Contact:
Priority: high    
Version: 5.1.0 GACC: dlesage
Target Milestone: ---   
Target Release: 5.1.0 GA   
Hardware: Unspecified   
OS: Unspecified   
URL: http://jira.jboss.org/jira/browse/SOA-2183
Whiteboard:
Fixed In Version: Doc Type: Bug Fix
Doc Text:
Story Points: ---
Clone Of: Environment:
Last Closed: 2011-02-17 23:37:42 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:
Bug Depends On:    
Bug Blocks: 779671, 779833    

Description David Le Sage 2010-07-27 04:42:36 UTC
Affects: Documentation (Ref Guide, User Guide, etc.)
project_key: SOA

Len, please undertake a QE review of the SOA 5.1 Programmers' Guide.

Document for review here: http://documentation-stage.bne.redhat.com/docs/en-US/JBoss_Enterprise_SOA_Platform/5/html/ESB_Programmers_Guide/index.html

Comment 2 David Le Sage 2010-07-27 04:44:11 UTC
Attachment: Added: JBoss_Enterprise_SOA_Platform-5-ESB_Programmers_Guide-en-US.pdf


Comment 4 David Le Sage 2010-07-28 06:45:21 UTC
Attachment: Added: JBoss_Enterprise_SOA_Platform-5-ESB_Programmers_Guide-en-US.pdf


Comment 5 Len DiMaggio 2010-08-03 19:52:03 UTC
Link: Added: This issue is a dependency of SOA-2194


Comment 6 Len DiMaggio 2010-08-03 19:55:07 UTC
JBoss Enterprise SOA Platform

    * JBoss Enterprise SOA Platform
    * SOA-2194

Typos in the Programmers Guide, Transport Specific Type Implementations section


This issue depends:
Major Open
JBESB-3424 Typos in the Programmers Guide, Transport Specific Type Implementations section 

Comment 7 David Le Sage 2010-08-03 22:26:43 UTC
Len, this seems to already be corrected in the current build. Page 94 reads:


2. SQL: <sql-provider>, <sql-bus>, <sql-listener> and <sql-message-filter>: The <sql-message-
   filter> can be added to either the <sql-bus> or <sql-listener> elements. Where the <sql-provider>
   and <ftp-bus> specify the JDBC connection properties, the <sql-message-filter> specifies the
   message/row selection and processing properties.
3. FTP: <ftp-provider>, <ftp-bus>, <ftp-listener> and <ftp-message-filter>: The <ftp-message-filter>
   can be added to either the <ftp-bus> or <ftp-listener> elements. Where the <ftp-provider> and
   <ftp-bus> specify the FTP access properties, the <ftp-message-filter> specifies the message/file
   selection and processing properties
4. Hibernate: <hibernate-provider>, <hibernate-bus>, <hibernate-listener> : The <hibernate-
   message-filter> can be added to either the <hibernate-bus> or <hibernate-listener> elements.
   Where the <hibernate-provider> specifies file system access properties like the location of the
   hibernate configuration property, the <hibernate-message-filter> specifies what classnames and
   events should be listened to.
5. File system: <fs-provider>, <fs-bus>, <fs-listener> and <fs-message-filter> The <fs-message-
   filter> can be added to either the <fs-bus> or <fs-listener> elements. Where the <fs-provider>
   and <sql-bus> specify the File System access properties, the <fs-message-filter> specifies the
   message/file selection and processing properties.


Is this the section to which Jehudi is referring?  If so, it seems to be correct in the current version of the book attached.  Cheers.

Comment 8 Jehudi Castro Sierra 2010-08-04 08:45:16 UTC
Yes, that's the section I'm referring to, note the problem here:

2.  SQL: Where the <sql-provider> and *<ftp-bus>* specify the JDBC connection properties...
5. File system: Where the <fs-provider> and *<sql-bus>* specify specify the File System access properties...

Comment 9 Jehudi Castro Sierra 2010-08-04 09:09:29 UTC
Another small detail that I found is an empty bullet point on the page 73 (Schedule-Driven Listener section)

Comment 10 Jehudi Castro Sierra 2010-08-04 11:06:57 UTC
please review the layout of the tables, for example in 9.5 and 9.8 there are words out of the frame

Comment 11 Jehudi Castro Sierra 2010-08-04 13:58:03 UTC
please try to fix the note on the section 4.3.4. InVM Transport, page 43.
the xml snip inside the note is almost impossible to see

Comment 12 Jehudi Castro Sierra 2010-08-04 14:32:52 UTC
Talking about that same note on page 43, the service showed there does not define an InVm Listener.
I think that its InVM listener needs to be enabled using invmScope="GLOBAL"

Comment 13 Kevin Conner 2010-08-04 15:35:25 UTC
invmScope="GLOBAL" does not always have to be specified explicitly.

Comment 17 Dana Mison 2010-08-20 06:33:47 UTC
Attachment: Removed: JBoss_Enterprise_SOA_Platform-5-ESB_Programmers_Guide-en-US.pdf 


Comment 18 Dana Mison 2010-08-20 06:34:03 UTC
Attachment: Removed: JBoss_Enterprise_SOA_Platform-5-ESB_Programmers_Guide-en-US.pdf 


Comment 19 Laura Bailey 2010-12-17 00:41:26 UTC
Writer: Added: Darrin


Comment 20 Laura Bailey 2010-12-17 00:47:56 UTC
Release Notes Docs Status: Added: Not Yet Documented


Comment 21 Len DiMaggio 2010-12-18 04:42:48 UTC
Assigning back to Darrin - the book will need a 2nd review - the sections on annotation-based actions and the camel gateway are missing. The remaining sections should be unchanged from 5.0.2.


Comment 22 Len DiMaggio 2010-12-20 02:42:28 UTC
Link: Added: This issue is a dependency of SOA-2036


Comment 23 David Le Sage 2010-12-23 03:12:07 UTC
First pass completed and changes incorporated.  (See DocSpace for details.)  Assigning back to Len for second pass.

Comment 24 David Le Sage 2010-12-23 03:12:45 UTC
Assigning to Len for second review.

Comment 26 Len DiMaggio 2011-01-06 04:17:19 UTC
Assigning back to David for final edits.

Comment 27 David Le Sage 2011-01-10 03:56:03 UTC
Minor changes made, based on QE feedback document.

Comment 28 Dana Mison 2011-02-17 23:37:42 UTC
Release Notes Docs Status: Removed: Not Yet Documented Added: Not Required