Bug 777979 (SOA-508)

Summary: SOA-P Embedded EAP docs state the wrong paths to the documents because they are embedded into different directories
Product: [JBoss] JBoss Enterprise SOA Platform 4 Reporter: Jay Balunas <tech4j>
Component: DocumentationAssignee: Joshua Wulf <jwulf>
Status: CLOSED NEXTRELEASE QA Contact:
Severity: medium Docs Contact:
Priority: medium    
Version: 4.2 CP01CC: lcarlon
Target Milestone: ---   
Target Release: 4.2 CP02   
Hardware: Unspecified   
OS: Unspecified   
URL: http://jira.jboss.org/jira/browse/SOA-508
Whiteboard:
Fixed In Version: Doc Type: Bug Fix
Doc Text:
Story Points: ---
Clone Of: Environment:
Last Closed: 2008-06-10 10:17:23 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 Jay Balunas 2008-04-08 21:14:46 UTC
Affects: Documentation (Ref Guide, User Guide, etc.)
Date of First Response: 2008-04-10 21:08:45
project_key: SOA

Because EAP docs are embedded at different directories and packages than they are for EAP the paths and directory references are sometime incorrect.  Suggestion: would it be possible to not have such direct references or maybe they can be centralized for easier productization?

The ones I found are in :
      - jboss-soa-p.4.2.0/docs/eap/jboss-eap-4.3/readme.html
      - jboss-soa-p.4.2.0/docs/eap/jboss-eap-4.3/doc/getting_started_guide.pdf

Comment 1 Joshua Wulf 2008-04-11 01:08:45 UTC
Do you have some specific examples that you could share with us?

cheers,
--josh

Comment 2 Jay Balunas 2008-04-11 13:30:48 UTC
Search the docs for "/" and you will find them.  

When I did it I found these:

* readme.html
   - (JBOSS_DIST/doc/seam/Seam_Reference_Guide.pdf)

* getting_started_guide.pdf 
  - JBOSS_DIST/doc/examples/gettingstarted
  - JBOSS_DIST/doc/examples/gettingstarted/jsfejb3
  - JBOSS_DIST/doc/examples/gettingstarted/seamejb3
  - JBOSS_DIST/doc/examples/gettingstarted/<seamejb3|jsfejb3>

Comment 3 Joshua Wulf 2008-04-14 04:16:11 UTC
Gotcha. 

These are easy enough to fix. We provide a definition of JBOSS_DIST for the SOA platform, as well as the EAP platform.

We'll have to rewrite the EAP directory structure section, however, as this is really changed when EAP is mashed up with SOA. 

Comment 4 Joshua Wulf 2008-06-03 11:14:14 UTC
From the CP02 Release Notes:

"Please note that the description of the documentation locations given in the EAP Release Notes and EAP Getting Started Guide differ from the actual paths of the EAP docs embedded with the SOA Platform. The EAP documentation is located in the jboss-soa-p.4.2.0/docs/eap/jboss-eap-4.3 directory."

Comment 5 Jiri Pechanec 2008-06-10 10:17:23 UTC
Verifien in CR01 release notes