[ http://issues.apache.org/jira/browse/TUSCANY-388?page=all ]
     
Jean-Sebastien Delfino reopened TUSCANY-388:
--------------------------------------------


I sitll have some issues with the documents under docs:

* sourceBuild.htm
- The title says "Tuscany Sample Setup" but this document is not about setting 
up the samples
- Second line: "Getting Tuscany Obtain Subversion Subversion", I can't parse 
this
- I do not understand why sourceBuild.htm is in the binary distribution
- the steps here duplicate what we have on the web site and are different
- Most of us are using Maven 2.0.4, not 2.0.2

* setup.htm
- Confused as well here, this setup document actually contains less setup 
instructions than sourceBuild.htm, this is not really a setup document, more 
like a getting started document
- The Requirements and Setup sections 

I suggest the following:
- remove sourceBuild.htm for now, we have complete instructions to setup a 
development environment and build from source on our Web site
- rename setup.htm to getttingstarted.htm, this document does not tell you much 
about setup
- in gettingstarted.htm, adjust the title and instead of setup have a 
Requirements section, btw having a JDK is not just for the J2SE samples, it is 
required for running tomcat as well :)
- make sure that the requirements section is correct, in addition to the JDK 
you need Ant and/or Maven to build the samples, best is to use what's already 
on our Web site, which is correct.


> Docs/setup.htm references scripts and steps not relevant to the binary 
> distribution.
> ------------------------------------------------------------------------------------
>
>          Key: TUSCANY-388
>          URL: http://issues.apache.org/jira/browse/TUSCANY-388
>      Project: Tuscany
>         Type: Bug

>   Components: Build System
>     Versions: Java-M1
>     Reporter: Jean-Sebastien Delfino
>     Assignee: Rick Rineholt
>      Fix For: Java-M1, Java-Mx, Java-M1-tentative, Cpp-current, 
> Java-M1-website

>
> This document should be simplified:
> The section talking about samples should just be removed, as it partly 
> duplicates the readme.htm files under the samples.
> The references to the scripts under testing/tomcat should be removed as well. 
> These scripts are not useful anymore now that we have a binary distribution, 
> and are not even available in the distribution, so this is just confusing.
> I think we should just keep a very simple description of which JARs are 
> required for J2SE, which config and JARs are required for Tomcat.
> Also the Web services related section is incorrect as it does not say that 
> these JARs are for use with Axis2, and we're missing a description for Cetlix.
> Instead of listing the JARs I suggest we just point to the directories 
> containing the JARs in the binary distribution, it'll be simpler, more 
> accurate and easier to maintain.
> We will need a separate document for people who build from the source, 
> later... this one needs to be cleaned up to avoid confusing users of the 
> binary distribution.

-- 
This message is automatically generated by JIRA.
-
If you think it was sent incorrectly contact one of the administrators:
   http://issues.apache.org/jira/secure/Administrators.jspa
-
For more information on JIRA, see:
   http://www.atlassian.com/software/jira

Reply via email to