Hide Forgot
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
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
currently esb has the following structure docs: dtd examples licenses samples schema ServicesGuide.pdf tools wiki
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.
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
Link: Added: This issue related SOA-889
Link: Added: This issue related SOA-890
Fine with me.
Verified in CR1