Bug 780988 (SOA-3464)

Summary: QE Review: SOA 5.2 Data Services Getting Started Guide
Product: [JBoss] JBoss Enterprise SOA Platform 5 Reporter: Van Halbert <vhalbert>
Component: Documentation, EDSAssignee: Emma Le Strange <elestran>
Status: CLOSED DUPLICATE QA Contact:
Severity: high Docs Contact:
Priority: unspecified    
Version: 5.2.0 GACC: dlesage, ldimaggi, vhalbert, vhalbert
Target Milestone: DR1Keywords: Documentation
Target Release: One Off Releases   
Hardware: Unspecified   
OS: Unspecified   
URL: http://jira.jboss.org/jira/browse/SOA-3464
Whiteboard:
Fixed In Version: Doc Type: Bug Fix
Doc Text:
Story Points: ---
Clone Of: Environment:
Last Closed: 2012-04-26 13:08:09 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: 780698    
Attachments:
Description Flags
chap-Data_Services.zip
none
chap-overview.xml
none
sect-install.xml
none
sect-requirements.xml none

Description Van Halbert 2011-10-06 20:48:08 UTC
project_key: SOA

Comment 1 Van Halbert 2011-10-06 20:54:59 UTC
The following are some initial suggestions at the beginning of the documnt, but section 3.1 Data Services Examples will really change, how would you prefer I submit the changes?   I can attach a doc with the rest of the suggested changes or I can cut and paste them here.  Your choice.


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


5.2 Getting Started Guide Review

General

[note]  suggestion:  remove the version (i.e., 5.1.0) when JBoss Enterprise Data Services Platform is referenced, provides no additional context other than what the version of the document is referring to in the Title.  If not,  change the 5.10 to 5.2.0.



Chapter 1

1.1

-	reference to  http://www.jboss.com/products/platforms/soa/components/ , is this right link?  Cause this page doesn't contain Data Services or anything about its components.    Or maybe that page needs to be changed to point to:  http://www.jboss.com/products/platforms/dataservices/components/.  


Chapter 2

2.1

- 	JBoss SOA Platform version should be changed to 5.2.0, as well as, Standalone.
- 	Link to tested configurations should be to:   http://www.jboss.com/products/platforms/dataservices/supportedconfigs/


2.3

-	(my observation) The WARNING about CXF is no longer an issue in ER5, cause you can only deploy EDS to all, production or default.  Since CXF and EDS has to be deployed to the same configuration,  and CXF can only be deployed to those 3 because there is no option to install elsewhere, this shouldn't occur, since EDS is now changed to not allow other profiles.

-	in step 4 - "Run installation script",  can the sentence "Apache CXF must ..." or the word "must" be emphasized to stress its need if using webservices?
-      in step 5  - "Configure",  can we rephrase to:     However, user accounts will need to be created to enable data access and other features. Refer....


Chapter 3

-     sentence:  VDB's can be queried ..... 
       add ODBC:     VDB's .... JDBC, ODBC and web-services.


Comment 2 Van Halbert 2011-10-06 21:14:38 UTC
I've got the xml files in docbook form, I'll change those and submit those via the jira.

Comment 4 Van Halbert 2011-10-13 19:50:26 UTC
Attachment: Added: chap-Data_Services.zip


Comment 5 Van Halbert 2011-10-13 19:51:23 UTC
Chapter Overview xml file.

Comment 6 Van Halbert 2011-10-13 19:51:23 UTC
Attachment: Added: chap-overview.xml


Comment 7 Van Halbert 2011-10-13 19:52:22 UTC
chap-setup xml file update

Comment 8 Van Halbert 2011-10-13 19:52:22 UTC
Attachment: Added: sect-install.xml


Comment 10 Van Halbert 2011-10-13 19:52:52 UTC
Attachment: Added: sect-requirements.xml


Comment 12 David Le Sage 2011-10-25 03:21:38 UTC
Attached files have been diffed and merged.

Comment 13 David Le Sage 2011-10-27 05:00:52 UTC
Release Notes Docs Status: Added: Not Required
Writer: Added: dlesage


Comment 14 Len DiMaggio 2011-11-11 18:56:37 UTC
Assigning to QE for doc review.


Comment 15 Paul Nittel 2011-11-14 19:01:58 UTC
Chapter 1 Overview refers to 5.1.0 Release notes. I suspect the 5.2.0 release notes is what was meant.

Please add a note that the EDS quick starts for federation, hibernate, and esb all require the default profile. (They use hsql which is not available to the production profile.)

Comment 16 Paul Nittel 2011-11-15 13:23:22 UTC
David -

I suspect you're in a better position to implement, or counter, the suggestions I made in the comments.

Comment 17 Emma Le Strange 2012-02-01 04:04:38 UTC
Van

I am wanting to include Apache topics in skynet for the next release that will accompany the Getting Started Guide or even possibly the Reference Guide.

I was wondering if you could provide some information on Apache Ant and Apache CXF in relation to their purpose in EDS.

Bullet points would be great.

Thanks

Comment 18 Van Halbert 2012-02-01 22:42:26 UTC
Apache Ant - its used for installation purposes only.   There are several SOA components (i.e., EDS, CXF and SEAM) that utilize ant, as well as, the quick starts. 

Apache CXF - it would be preferred that its stated that we depend upon the JBoss CXF version.  The JBoss CXF is utilized in consuming and producing web services.   On the consumption side, if there is a web service data source that Teiid would be communicating with, CXF would be involved in translating that information.   On the producing side (web service request from Teiid), CXF is used to generate the war file that will be used in producing the web service response.

Comment 19 Len DiMaggio 2012-04-26 13:08:09 UTC

*** This bug has been marked as a duplicate of bug 795221 ***