Bug 778481 (SOA-971) - Review SOA-P 4.3 /docs/esb/Programmers_Guide.pdf
Summary: Review SOA-P 4.3 /docs/esb/Programmers_Guide.pdf
Keywords:
Status: CLOSED NEXTRELEASE
Alias: SOA-971
Product: JBoss Enterprise SOA Platform 4
Classification: JBoss
Component: Documentation
Version: 4.3 CR1
Hardware: Unspecified
OS: Unspecified
high
high
Target Milestone: ---
: 4.3 CP01
Assignee: Jiri Pechanec
QA Contact:
URL: http://jira.jboss.org/jira/browse/SOA...
Whiteboard:
Depends On: SOA-1061
Blocks:
TreeView+ depends on / blocked
 
Reported: 2008-10-16 20:45 UTC by Len DiMaggio
Modified: 2009-03-17 15:46 UTC (History)
0 users

Fixed In Version:
Doc Type: Bug Fix
Doc Text:
Clone Of:
Environment:
Last Closed: 2009-03-17 15:46:50 UTC
Type: Task


Attachments (Terms of Use)


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

Description Len DiMaggio 2008-10-16 20:45:21 UTC
Date of First Response: 2008-10-23 04:17:00
project_key: SOA

Let's collect all comments for Darrin for the /docs/esb/Programmers_Guide.pdf in this JIRA

Comment 1 Len DiMaggio 2008-10-21 15:07:10 UTC
Security: Added: Public


Comment 2 Jiri Pechanec 2008-10-23 08:17:00 UTC
2.2
Rosetta is built on three core architectural components:
but there are FOUR items in the list
3.2
Example 4.3, Figure 3.1 and Figure 3.2 - each describes the same but have
different structure (missing pieces in the figures)
3.2.1
header property Action shold be explained in more detail
replace MessageIDas with MessageIDs
3.2.4
The name for any given named object in a message must be unique or an exception will be thrown. - is it really true? How this can happen?
3.2.5
Creating different body types - there is  org.jboss.soa.esb.message.body.content.Payload class for this purpose
List of different message bodies - there are duplicate items
4.1 Routers are in the section name but are not mentioned in the text -
also need to explain difference between routers and notifiers
Would be also good to mention that it is not necessary to provide the
information to listener - the reference to provider for given transport is
typically used
5
This chapter should contain also Service orchestration section
7.1.1
Note - should refer to 4.4 version, not 4.2.1

B.4
Arethe versions correct? Should not be 4.4?

Versions in general, in text there are multiple references to ESB 4.3 GA. I think it should be 4.4 (maybe CP1)

page 73 - Note and page 34 - Note: The latter says that the gateway EPRs are not stored in registry and the former says they are

page 76 - enumeration - replace <jms-provder> with <jms-provider>, >services> with <services>, busrefid with busidref

Chapter 10 - the is new style functionality related to WS - EBWS (ESB services exposed as Web Services)

Appendix A - there is nothing in the text that justifies the inclusion of this Appendix - for what the JAXB is used in ESB context?

Comment 3 Dana Mison 2008-10-23 08:41:03 UTC
Note to self, Chapter 9: table alignment & formatting issues 

Comment 4 Dana Mison 2008-10-27 04:55:40 UTC
* "3.2 Figure 3.1 and Figure 3.2 - each describes the same but have different structure (missing pieces in the figures)"
Diagrams are derived from the ESB Programmers Guide & I beleive 3.1 is supposed to be a much generalised image.

* "3.2.4 The name for any given named object in a message must be unique or an exception will be thrown. - is it really true? How this can happen?"
JIRA to verify content in ESB Programmers Guide

* "3.2.5 Creating different body types - there is org.jboss.soa.esb.message.body.content.Payload class for this purpose
List of different message bodies - there are duplicate items"
JIRA to verify content in ESB Programmers Guide

* "4.1 Routers are in the section name but are not mentioned in the text - also need to explain difference between routers and notifiers Would be also good to mention that it is not necessary to provide the information to listener - the reference to provider for given transport is typically used
JIRA to update content in ESB Programmers Guide

* "5 This chapter should contain also Service orchestration section"
JIRA to update content in ESB Programmers Guide

* "page 73 - Note and page 34 - Note: The latter says that the gateway EPRs are not stored in registry and the former says they are"
JIRA to verify/update content in ESB Programmers Guide

* "Chapter 10 - the is new style functionality related to WS - EBWS (ESB services exposed as Web Services)"
JIRA to update content in ESB Programmers Guide

* "Appendix A - there is nothing in the text that justifies the inclusion of this Appendix - for what the JAXB is used in ESB context?"
JIRA to verify/update content in ESB Programmers Guide

Comment 5 nwallace 2008-12-03 09:14:50 UTC
Link: Added: This issue depends SOA-1061


Comment 6 nwallace 2008-12-03 09:23:04 UTC
I've raised another jira SOA-1061 and assigned it to Daniel Bevenius to get technical updates.

Comment 7 Dana Mison 2009-01-27 04:48:19 UTC
Updates from SOA-1061 have been incorporated.  From my previous note items 1,3,5,7 and 8 have NOT been included as they were considered not to be a problem.

I have highlighted the sections in the book's index that have had changes and should be reviewed.

Comment 8 Len DiMaggio 2009-02-26 01:21:36 UTC
Assigning to QE to verify that the change is (also) in the 4.3 CP01 docs.

Comment 9 Len DiMaggio 2009-03-17 15:46:50 UTC
Issues for 4.3 CP01 tracked in SOA-1173


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