Author: trygvis
Date: Fri Apr 15 06:21:48 2005
New Revision: 161451
URL: http://svn.apache.org/viewcvs?view=rev&rev=161451
Log:
o Adding documentation on how to add and build projects.
Modified:
maven/continuum/trunk/continuum-site/project.xml
maven/continuum/trunk/continuum-site/src/site/xdoc/about.fml
maven/continuum/trunk/continuum-site/src/site/xdoc/getting-started.xml
maven/continuum/trunk/continuum-site/src/site/xdoc/planned-features.xml
Modified: maven/continuum/trunk/continuum-site/project.xml
URL:
http://svn.apache.org/viewcvs/maven/continuum/trunk/continuum-site/project.xml?view=diff&r1=161450&r2=161451
==============================================================================
--- maven/continuum/trunk/continuum-site/project.xml (original)
+++ maven/continuum/trunk/continuum-site/project.xml Fri Apr 15 06:21:48 2005
@@ -1,14 +1,15 @@
<?xml version="1.0" encoding="UTF-8"?>
-<!--
+
+<!--
/*
* Copyright 2001-2005 The Apache Software Foundation.
- *
+ *
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
- *
+ *
* http://www.apache.org/licenses/LICENSE-2.0
- *
+ *
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
@@ -46,7 +47,7 @@
<id>jvanzyl</id>
<name>Jason van Zyl</name>
<email>[EMAIL PROTECTED]</email>
- <organization>Maven</organization>
+ <organization>Mergere, Inc</organization>
<roles>
<role>Architect</role>
<role>Release Manager</role>
@@ -56,12 +57,10 @@
<id>trygvis</id>
<name>Trygve Laugstol</name>
<email>[EMAIL PROTECTED]</email>
- <organization>ASF</organization>
+ <organization>Mergere, Inc</organization>
<roles>
- <role>PMC Member</role>
<role>Developer</role>
</roles>
- <timezone>+1</timezone>
</developer>
</developers>
<mailingLists>
Modified: maven/continuum/trunk/continuum-site/src/site/xdoc/about.fml
URL:
http://svn.apache.org/viewcvs/maven/continuum/trunk/continuum-site/src/site/xdoc/about.fml?view=diff&r1=161450&r2=161451
==============================================================================
--- maven/continuum/trunk/continuum-site/src/site/xdoc/about.fml (original)
+++ maven/continuum/trunk/continuum-site/src/site/xdoc/about.fml Fri Apr 15
06:21:48 2005
@@ -10,7 +10,7 @@
For more information on what continous integration is there are lots
of articles on the internet:
<ul>
<li>Martin Fowler has a article called
- <a
href="http://www.martinfowler.com/articles/continuousIntegration.html";>"Continuous
Integration"</a>
+ <a
href="http://www.martinfowler.com/articles/continuousIntegration.html";>"Continuous
Integration"</a>
</li>
<li>The C2 wiki has a page on
<a
href="http://c2.com/cgi/wiki?ContinuousIntegration";>ContinuousIntegration</a>
@@ -27,8 +27,10 @@
</p>
<ul>
<li>A easy to use web interface</li>
- <li>A very easy way to add new projects, see the <a
href="adding-projects.html">adding projects</a> page for
- more information</li>
+ <li>A very easy way to add new projects, see the
+ <a href="getting-started.html#Adding_projects">adding projects</a>
section page for
+ more information
+ </li>
<li>A XML-RPC interface for automation and remoting</li>
<li>Mail notification</li>
</ul>
@@ -68,7 +70,8 @@
join the project.
</p>
<p>
- For more information, please see <a
href="http://maven.apache.org/contributing/help.html";>How to Help</a>.
+ For more information, please see
+ <a href="http://maven.apache.org/contributing/help.html";>How to
Help</a>.
</p>
</answer>
</faq>
Modified: maven/continuum/trunk/continuum-site/src/site/xdoc/getting-started.xml
URL:
http://svn.apache.org/viewcvs/maven/continuum/trunk/continuum-site/src/site/xdoc/getting-started.xml?view=diff&r1=161450&r2=161451
==============================================================================
--- maven/continuum/trunk/continuum-site/src/site/xdoc/getting-started.xml
(original)
+++ maven/continuum/trunk/continuum-site/src/site/xdoc/getting-started.xml Fri
Apr 15 06:21:48 2005
@@ -14,5 +14,64 @@
<a href="http://localhost:8080";>http://localhost:8080</a> or by using
the XML-RPC interface on port 8000.
</p>
</section>
+ <section name="Adding Projects to Continuum">
+ <p>
+ When adding projects note that Continuum will check out the projects
directly after you press the button and
+ will not return untill after the projects has been checked out either
successfully or not. This is a known
+ issue with Continuum and asynchronous checkouts are
+ <a href="planned-features.html#Asynchronous_checkouts">planned</a>.
+ </p>
+ <subsection name="Adding Maven2 Projects">
+ <p>
+ When adding a Maven 2 project all you need is the URL to a POM. The
POM has to include at least the SCM
+ information to be able to check out the project.
+ </p>
+ </subsection>
+ <subsection name="Adding Maven1 Projects">
+ <p>
+ Adding a Maven 1 it pretty much like adding a Maven 2 project, give
it a URL to a POM with SCM information
+ and Continuum will add the projects.
+ </p>
+ <p>
+ There are is a caveat though: The POM cannot extend a parent POM.
When Continuum is downloading the POM it
+ won't know how to find the parent POMs. The best way to use
Continuum with Maven 1 projects is to
+ give Continuum the root POM of your projects only and then have a
special goal in the root projects
+ <code>maven.xml</code> to build all of the projects. This is
something that hopefully will be remedied in
+ Maven 1.1.
+ </p>
+ </subsection>
+ <subsection name="Adding Ant Projects">
+ <p>
+ When adding Ant projects you have to specify the projects name, scm
url, nag email address and version and
+ the targets to execute.
+ </p>
+ </subsection>
+ <subsection name="Adding Shell Projects">
+ <p>
+ When adding Ant projects you have to specify the projects name, scm
url, nag email address and version and
+ the shell script to execute. The working directory of the project
will be prepended to the scripts path.
+ </p>
+ </subsection>
+ </section>
+ <section name="Building Projects">
+ <subsection name="Using the Web Interface">
+ <p>
+ To build a project with the web interface from the project list,
simply press the "build" button and the
+ project will be enqueued on the build list. If Continuum isn't
already building a project it will start the
+ build immediately.
+ </p>
+ </subsection>
+ <subsection name="Using the XML-RPC Interface">
+ <p>
+ By using the <code>continuum_cli.py</code> Python script you can
remotely controll Continuum. Start the
+ script by executing <source>python continuum_cli.py</source> and
write <code>help</code> to list all
+ available commands.
+ </p>
+ <p>
+ There is also a reusable Python library called
<code>continuum.py</code> that can be used to integrate
+ remote control over Continuum into other Python applications.
+ </p>
+ </subsection>
+ </section>
</body>
</document>
Modified:
maven/continuum/trunk/continuum-site/src/site/xdoc/planned-features.xml
URL:
http://svn.apache.org/viewcvs/maven/continuum/trunk/continuum-site/src/site/xdoc/planned-features.xml?view=diff&r1=161450&r2=161451
==============================================================================
--- maven/continuum/trunk/continuum-site/src/site/xdoc/planned-features.xml
(original)
+++ maven/continuum/trunk/continuum-site/src/site/xdoc/planned-features.xml Fri
Apr 15 06:21:48 2005
@@ -43,6 +43,14 @@
</li>
</ul>
</subsection>
+ <subsection name="Asynchronous checkouts">
+ <p>
+ Currently all checkouts are done while the user presses the "add
project" button which can take up to
+ several minutes to complete. Continuum need to do this in the
background and show that the prjoect currently
+ are beeing checked out in the overview pages. For status updates on
this issues take a look at the
+ <a href="http://jira.codehaus.org/browse/CONTINUUM-60";>JIRA
issue</a>.
+ </p>
+ </subsection>
</section>
</body>
</document>
