Bug 778412 (SOA-896)

Summary:	need to revisit docs structure
Product:	[JBoss] JBoss Enterprise SOA Platform 4	Reporter:	trev <tkirby>
Component:	Build Process	Assignee:	trev <tkirby>
Status:	CLOSED NEXTRELEASE	QA Contact:
Severity:	high	Docs Contact:
Priority:	high
Version:	4.3 IR5
Target Milestone:	---
Target Release:	4.3 CR1
Hardware:	Unspecified
OS:	Unspecified
URL:	http://jira.jboss.org/jira/browse/SOA-896
Whiteboard:
Fixed In Version:		Doc Type:	Bug Fix
Doc Text:		Story Points:	---
Clone Of:		Environment:
Last Closed:	2008-10-20 11:57:30 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 trev 2008-09-30 09:32:48 UTC

Date of First Response: 2008-09-30 08:52:58
project_key: SOA

Currently the docs exist in a top level directory with some docs that are really config files  exisiting in a docs dir  under the AS root

EAP have a similar structure but ESB does not.

Does it make sense to move the ESB docs into this new structure as ESB users are less familiar with this layout
Should standalone and embedded have the same layout, if so what should be the layout
Previous discussions have been in various locations, not all of which are recorded, this Jira has been created to get the discussion and decision recorded

Comment 1 trev 2008-09-30 12:22:45 UTC

currently eap has following layout 

jboss-eap-4.3/doc
cache		     
Installation_Guide.pdf
Common_Content	     
jbossts
examples	     
JDK6_Compatibility_Notes.pdf
Getting_Started.pdf  
messaging
hibernate	     
seam
images		     
seamfp
index.html	     
Server_Configuration_Guide.pdf

 jboss-eap-4.3/jboss-as/docs/
dtd  examples  licenses  schema

NB.  jboss-eap-4.3/doc contains differing files to boss-eap-4.3/jboss-as/docs/examples

Comment 2 trev 2008-09-30 12:26:02 UTC

currently esb has the following structure

docs:
dtd  
examples  
licenses  
samples  
schema  
ServicesGuide.pdf  
tools  
wiki

Comment 3 Mark Little 2008-09-30 12:52:58 UTC

We should mirror the EAP approach, at least when doing the embedded version. We should also take the ESB doc structure for the stand-alone to minimise changes and resultant errors. If that structure is not sufficient then let's look at influencing the ESB project structure.

Comment 4 trev 2008-10-02 10:38:33 UTC

 the only question left to be resolved is,  for the embedded what do we do with the esb extra drectories  ie. tools  and wiki .
 I propose copying them into  the embedded jboss-as/docs dir and not at the top level as they were for 4.2, this give embedded and standalone the same layout.


I suggest leaving  the top level docs with the following structure
docs/ jboss-eap-4.3 - this will contain the eap top level docs exactly as laid out by EAP and the seam FP
docs/esb  - this will contain the updated documents that the docs team have been producing

This leaves us with the service-guide.pdf, as this is superseded by the docs team version I'd suggest deleting the original

Comment 5 trev 2008-10-03 10:40:13 UTC

Link: Added: This issue related SOA-889

Comment 6 trev 2008-10-03 10:41:35 UTC

Link: Added: This issue related SOA-890

Comment 7 Mark Little 2008-10-04 09:14:43 UTC

Fine with me.

Comment 8 Jiri Pechanec 2008-10-20 11:57:30 UTC

Verified in CR1