You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@continuum.apache.org by de...@apache.org on 2010/01/15 00:24:17 UTC
svn commit: r899465 - in /continuum/trunk/continuum-docs/src/site/apt: ./
administrator_guides/ installation/ user_guides/building_project/
user_guides/cancelling_build/ user_guides/managing_builddef/
user_guides/managing_project/ user_guides/notificat...
Author: dennisl
Date: Thu Jan 14 23:24:16 2010
New Revision: 899465
URL: http://svn.apache.org/viewvc?rev=899465&view=rev
Log:
Improve the documentation:
- Fix typos
- Fix broken links
- Fix broken formating
- Add more formating
Manually merged from 1.3.x branch.
Modified:
continuum/trunk/continuum-docs/src/site/apt/administrator_guides/projectgroup.apt
continuum/trunk/continuum-docs/src/site/apt/getting-started.apt
continuum/trunk/continuum-docs/src/site/apt/index.apt
continuum/trunk/continuum-docs/src/site/apt/installation/build-agent.apt
continuum/trunk/continuum-docs/src/site/apt/installation/geronimo.apt
continuum/trunk/continuum-docs/src/site/apt/installation/glassfish.apt
continuum/trunk/continuum-docs/src/site/apt/installation/index.apt
continuum/trunk/continuum-docs/src/site/apt/installation/installation.apt
continuum/trunk/continuum-docs/src/site/apt/installation/jboss.apt
continuum/trunk/continuum-docs/src/site/apt/installation/jetty.apt
continuum/trunk/continuum-docs/src/site/apt/installation/requirements.apt
continuum/trunk/continuum-docs/src/site/apt/installation/standalone.apt
continuum/trunk/continuum-docs/src/site/apt/installation/tomcat.apt
continuum/trunk/continuum-docs/src/site/apt/installation/upgrade.apt
continuum/trunk/continuum-docs/src/site/apt/user_guides/building_project/build_results.apt
continuum/trunk/continuum-docs/src/site/apt/user_guides/building_project/forced_build.apt
continuum/trunk/continuum-docs/src/site/apt/user_guides/building_project/index.apt
continuum/trunk/continuum-docs/src/site/apt/user_guides/building_project/schedule_build.apt
continuum/trunk/continuum-docs/src/site/apt/user_guides/cancelling_build/cancelProjectBuild.apt
continuum/trunk/continuum-docs/src/site/apt/user_guides/managing_builddef/builddefGroup.apt
continuum/trunk/continuum-docs/src/site/apt/user_guides/managing_builddef/builddefProject.apt
continuum/trunk/continuum-docs/src/site/apt/user_guides/managing_builddef/index.apt
continuum/trunk/continuum-docs/src/site/apt/user_guides/managing_project/addProject.apt
continuum/trunk/continuum-docs/src/site/apt/user_guides/managing_project/editProject.apt
continuum/trunk/continuum-docs/src/site/apt/user_guides/managing_project/removeProject.apt
continuum/trunk/continuum-docs/src/site/apt/user_guides/notification/index.apt
continuum/trunk/continuum-docs/src/site/apt/user_guides/notification/irc.apt
continuum/trunk/continuum-docs/src/site/apt/user_guides/notification/jabber.apt
continuum/trunk/continuum-docs/src/site/apt/user_guides/notification/mail.apt
continuum/trunk/continuum-docs/src/site/apt/user_guides/notification/msn.apt
continuum/trunk/continuum-docs/src/site/apt/user_guides/notification/wagon.apt
continuum/trunk/continuum-docs/src/site/apt/user_guides/release/index.apt
continuum/trunk/continuum-docs/src/site/apt/user_guides/release/perform.apt
continuum/trunk/continuum-docs/src/site/apt/user_guides/release/prepare.apt
continuum/trunk/continuum-docs/src/site/apt/user_guides/release/release_results.apt
continuum/trunk/continuum-docs/src/site/apt/user_guides/viewing_queues/index.apt
Modified: continuum/trunk/continuum-docs/src/site/apt/administrator_guides/projectgroup.apt
URL: http://svn.apache.org/viewvc/continuum/trunk/continuum-docs/src/site/apt/administrator_guides/projectgroup.apt?rev=899465&r1=899464&r2=899465&view=diff
==============================================================================
--- continuum/trunk/continuum-docs/src/site/apt/administrator_guides/projectgroup.apt (original)
+++ continuum/trunk/continuum-docs/src/site/apt/administrator_guides/projectgroup.apt Thu Jan 14 23:24:16 2010
@@ -25,7 +25,7 @@
* Project Group Name
* Project Group Id
-
+
[]
* Editing a Project Group
@@ -54,7 +54,7 @@
[]
And, projects can be moved to another project group.
-
+
* Deleting a Project Group
There are two ways to delete a project group.
@@ -68,4 +68,4 @@
Note that user roles for this project group will not be removed. This is intentional so that if you are
sharing a user database among several Continuum instances, users will still be able to access the same
group on a different server.
-
+
Modified: continuum/trunk/continuum-docs/src/site/apt/getting-started.apt
URL: http://svn.apache.org/viewvc/continuum/trunk/continuum-docs/src/site/apt/getting-started.apt?rev=899465&r1=899464&r2=899465&view=diff
==============================================================================
--- continuum/trunk/continuum-docs/src/site/apt/getting-started.apt (original)
+++ continuum/trunk/continuum-docs/src/site/apt/getting-started.apt Thu Jan 14 23:24:16 2010
@@ -11,12 +11,12 @@
When you start Continuum for the first time (without an existing database), the first thing you will
do is create the admin account and perform the {{{administrator_guides/configuration.html}General Configuration}}.
-
+
[images/admin-account-creation.png] Admin account creation
- After admin account creation, you can log as the admin. The next thing you will see is the General Configuration
+ After the admin account has been created, you can log as the admin user. The next thing you will see is the <<General Configuration>>
page.
[images/configuration.png] General Configuration
- You may also create users, {{{user_guides/managing_project/addProject.html}add projects}}, etc.
\ No newline at end of file
+ You may also create more users, {{{user_guides/managing_project/addProject.html}add projects}}, etc.
\ No newline at end of file
Modified: continuum/trunk/continuum-docs/src/site/apt/index.apt
URL: http://svn.apache.org/viewvc/continuum/trunk/continuum-docs/src/site/apt/index.apt?rev=899465&r1=899464&r2=899465&view=diff
==============================================================================
--- continuum/trunk/continuum-docs/src/site/apt/index.apt (original)
+++ continuum/trunk/continuum-docs/src/site/apt/index.apt Thu Jan 14 23:24:16 2010
@@ -4,13 +4,14 @@
Emmanuel Venisse
------
Oct 3 2007
+ ------
Welcome to Apache Continuum
Apache Continuum is an enterprise-ready continuous integration server with features such as automated builds,
- release management, role-based security, and integration with popular build tools and source control management
+ release management, role-based security and integration with popular build tools and source control management
systems. Whether you have a centralized build team or want to put control of releases in the hands of developers,
- Continuum can help you improve quality and maintain a consistent build environment.
+ Continuum can help you improve quality and maintain a consistent build environment.
* Documentation
@@ -21,25 +22,25 @@
* {{{installation/index.html}Installation}}
* Standalone version:
-
+
{{{installation/standalone.html}Standard (Linux, Mac OSX, Solaris, Windows, others) as a service or not}}
- * Webapp:
-
+ * Webapp:
+
{{{installation/tomcat.html}Tomcat}},
-
+
{{{installation/jetty.html}Jetty}},
-
+
{{{installation/jboss.html}JBoss}},
-
+
{{{installation/geronimo.html}Geronimo}},
-
+
{{{installation/glassfish.html}GlassFish}}
-
+
[]
* {{{installation/upgrade.html} How to upgrade from a previous version}}
-
+
[]
* {{{user_guides/index.html} User's Guide}}
@@ -57,7 +58,7 @@
{{{http://docs.codehaus.org/display/CONTINUUMUSER/Home}Old Wiki}}
{{{http://apache-continuum.blogspot.com/}Blog}}
-
+
[]
This documentation is also available in {{{./apache-continuum.pdf}PDF}} format.
Modified: continuum/trunk/continuum-docs/src/site/apt/installation/build-agent.apt
URL: http://svn.apache.org/viewvc/continuum/trunk/continuum-docs/src/site/apt/installation/build-agent.apt?rev=899465&r1=899464&r2=899465&view=diff
==============================================================================
--- continuum/trunk/continuum-docs/src/site/apt/installation/build-agent.apt (original)
+++ continuum/trunk/continuum-docs/src/site/apt/installation/build-agent.apt Thu Jan 14 23:24:16 2010
@@ -1,5 +1,9 @@
-
-
+ ------
+ Installing and Configuring a Build Agent
+ ------
+ ------
+ 2010-01-13
+ ------
Installing and Configuring a Build Agent
@@ -14,33 +18,33 @@
The Build Agent is available as a separate standalone Jetty-bundled
webapp. Installing it is as simple as extracting it to a preferred
- directory.
+ directory.
The Build Agent runs on a specific port (defaulting to 8181), so it is possible
to install multiple Build Agents in one machine. It is also possible to
install Agents in the same machine as the Master. To configure the Build Agent
- to run using a different port, edit the
+ to run using a different port, edit the
<<<$CONTINUUM_BUILDAGENT_HOME/conf/jetty.xml>>> file.
Another configuration file to look at is the
<<<$CONTINUUM_BUILDAGENT_HOME/conf/continuum-buildagent.xml>>>. This file must
- be manually edited, as there is no web interface for configuration.
+ be manually edited, as there is no web interface for this configuration.
+--------------+
<continuum-buildagent-configuration>
-<buildOutputDirectory>/path/to/build/agent/data/build-output-directory</buildOutputDirectory>
- <workingDirectory>/path/to/build/agent/data/working-directory</workingDirectory>
- <continuumServerUrl>http://builds.example.com:8080/continuum/master-xmlrpc</continuumServerUrl>
- <installations>
- <installation>
- <name>Maven 2 Home</name>
- <type>maven2</type>
- <varValue>/Applications/apache-maven-2.0.9</varValue>
- </installation>
- </installations>
+ <buildOutputDirectory>/path/to/build/agent/data/build-output-directory</buildOutputDirectory>
+ <workingDirectory>/path/to/build/agent/data/working-directory</workingDirectory>
+ <continuumServerUrl>http://builds.example.com:8080/continuum/master-xmlrpc</continuumServerUrl>
+ <installations>
+ <installation>
+ <name>Maven 2 Home</name>
+ <type>maven2</type>
+ <varValue>/Applications/apache-maven-2.0.9</varValue>
+ </installation>
+ </installations>
</continuum-buildagent-configuration>
+----------------+
-
+
A minimal configuration will have the following fields:
* <<<buildOutputDirectory>>> - similar to the build output directory of Continuum
@@ -50,37 +54,49 @@
* <<<continuumServerUrl>>> - the url pointing to the XML-RPC context of the Master Build Agent
* <<<installations>>> - a list of the installations available on the build agent, including Maven, Ant, JDK, etc.
-
- Note that all of your agents need not be identical, as there is a way to control which agent Continuum chooses by using a
- {{{../administrator_guides/build-agent-groups.html} Build Agent Group}}. In addition, you need to {{{../administrator_guides/buildEnvironment.html} configure}}
+
+ Note that all of your agents need not be identical, as there is a way to control which agent Continuum chooses by using a
+ {{{../administrator_guides/build-agent-groups.html}Build Agent Group}}. In addition, you need to {{{../administrator_guides/buildEnvironment.html} configure}}
the Build Environment from the Master in order to specify which installation to use for the build.
Now start the Build Agent by executing the startup script available in
<<<$CONTINUUM_BUILDAGENT_HOME/bin/>>>. For example:
- <<<continuum-buildagent start>>> (or <<<continuum-buildagent console>>> on Windows).
++---+
+continuum-buildagent start
++---+
+
+ or if you are on Windows
+
++---+
+continuum-buildagent console
++---+
- Next, enable the Distributed Builds option in the {{{../administrator_guides/configuration.html}General Configuration}},
+ Next, enable the <<Distributed Builds>> option in the {{{../administrator_guides/configuration.html}General Configuration}},
and {{{../administrator_guides/build-agents.html}add the agent}} to the Continuum master server.
- TODO: Does the Jetty bundle still want CONTINUUM_BUILDAGENT_HOME set?
+~~ TODO: Does the Jetty bundle still want CONTINUUM_BUILDAGENT_HOME set?
* Webapp
The build agent is also available as a web application which you can install into your own container.
- The build agent needs two things in order to function properly: A CONTINUUM_BUILDAGENT_HOME environment variable,
- and a continuum-buildagent.xml configuration file in $CONTINUUM_BUILDAGENT_HOME/conf.
+ The build agent needs two things in order to function properly: A <<<CONTINUUM_BUILDAGENT_HOME>>> environment variable,
+ and a <<<continuum-buildagent.xml>>> configuration file in <<<$CONTINUUM_BUILDAGENT_HOME/conf>>>.
First, set the environment variable:
- export CONTINUUM_BUILDAGENT_HOME=/path/to/build/agent/home
++---+
+export CONTINUUM_BUILDAGENT_HOME=/path/to/build/agent/home
++---+
or
- set CONTINUUM_BUILDAGENT_HOME=c:\path\to\build\agent\home
++---+
+set CONTINUUM_BUILDAGENT_HOME=c:\path\to\build\agent\home
++---+
- Next, create the continuum-buildagent.xml file as shown above, and save it in $CONTINUUM_BUILDAGENT_HOME/conf.
+ Next, create the <<<continuum-buildagent.xml>>> file as shown above, and save it in <<<$CONTINUUM_BUILDAGENT_HOME/conf>>>.
You will need to create these directories.
Finally, drop the webapp into your container, and start it.
Modified: continuum/trunk/continuum-docs/src/site/apt/installation/geronimo.apt
URL: http://svn.apache.org/viewvc/continuum/trunk/continuum-docs/src/site/apt/installation/geronimo.apt?rev=899465&r1=899464&r2=899465&view=diff
==============================================================================
--- continuum/trunk/continuum-docs/src/site/apt/installation/geronimo.apt (original)
+++ continuum/trunk/continuum-docs/src/site/apt/installation/geronimo.apt Thu Jan 14 23:24:16 2010
@@ -18,7 +18,7 @@
Continuum uses two datasources (<<<jdbc/continuum>>> and <<<jdbc/users>>>). You can create one or two databases for them.
- Here, we create only one database '<<<continuum>>>' used by both datasources.
+ Here, we create only one database <<<continuum>>> used by both datasources.
Look at {{{http://cwiki.apache.org/GMOxDOC20/configuring-database-pools.html}Configuring database pools}} in Geronimo User's Guide.
* {Deployment Plan}
@@ -40,17 +40,17 @@
<groupId>console.dbpool</groupId>
<artifactId>continuum</artifactId>
</dependency>
- <dependency>
+ <dependency>
<groupId>org.apache.geronimo.configs</groupId>
<artifactId>javamail</artifactId>
<version>2.0.2</version>
<type>car</type>
</dependency>
- <dependency>
- <groupId>commons-lang</groupId>
- <artifactId>commons-lang</artifactId>
- <version>2.2</version>
- <type>jar</type>
+ <dependency>
+ <groupId>commons-lang</groupId>
+ <artifactId>commons-lang</artifactId>
+ <version>2.2</version>
+ <type>jar</type>
</dependency>
</dependencies>
@@ -77,7 +77,7 @@
</web-app>
-----------------------------
- The '<<<continuum>>>' string used in <<<console.dbpool>>> and <<<\<resource-link\>>>> is the name of the datasource created in the previous part.
+ The <<<continuum>>> string used in <<<console.dbpool>>> and <<<\<resource-link\>>>> is the name of the datasource created in the previous part.
<<<commons-lang 2.2>>> is required by Continuum and must be installed in the geronimo repository.
@@ -91,5 +91,5 @@
* {Continuum Configuration}
- By default, the '<<<working directory>>>' and the '<<<build output directory>>>' are stored under the WEB-INF directory. If you want to change them (necessary on Windows
+ By default, the <<working directory>> and the <<build output directory>> are stored under the <<<WEB-INF>>> directory. If you want to change them (necessary on Windows
due to the path length limitation), you can configure them in the {{{../administrator_guides/configuration.html}Configuration page}}.
Modified: continuum/trunk/continuum-docs/src/site/apt/installation/glassfish.apt
URL: http://svn.apache.org/viewvc/continuum/trunk/continuum-docs/src/site/apt/installation/glassfish.apt?rev=899465&r1=899464&r2=899465&view=diff
==============================================================================
--- continuum/trunk/continuum-docs/src/site/apt/installation/glassfish.apt (original)
+++ continuum/trunk/continuum-docs/src/site/apt/installation/glassfish.apt Thu Jan 14 23:24:16 2010
@@ -17,11 +17,11 @@
* {Datasource Configuration}
- * Create a connection pool named '<<continuum>>' for your database
+ * Create a connection pool named <<<continuum>>> for your database
- * Create a JDBC resource named '<<jdbc/continuum>>' linked to the '<<continuum>>' connection pool
+ * Create a JDBC resource named <<<jdbc/continuum>>> linked to the <<<continuum>>> connection pool
- * Create a JDBC resource named '<<jdbc/users>>' linked to the '<<continuum>>' connection pool
+ * Create a JDBC resource named <<<jdbc/users>>> linked to the <<<continuum>>> connection pool
* {Install Continuum}
@@ -31,5 +31,5 @@
* {Continuum Configuration}
- By default, the '<<<working directory>>>' and the '<<<build output directory>>>' are stored under the WEB-INF directory. If you want to change them (necessary on Windows
+ By default, the <<working directory>> and the <<build output directory>> are stored under the <<<WEB-INF>>> directory. If you want to change them (necessary on Windows
due to the path length limitation), you can configure them in the {{{../administrator_guides/configuration.html}Configuration page}}.
Modified: continuum/trunk/continuum-docs/src/site/apt/installation/index.apt
URL: http://svn.apache.org/viewvc/continuum/trunk/continuum-docs/src/site/apt/installation/index.apt?rev=899465&r1=899464&r2=899465&view=diff
==============================================================================
--- continuum/trunk/continuum-docs/src/site/apt/installation/index.apt (original)
+++ continuum/trunk/continuum-docs/src/site/apt/installation/index.apt Thu Jan 14 23:24:16 2010
@@ -8,11 +8,11 @@
Installation/Upgrade Guides
- In this section, you'll find informations about Continuum installations:
+ In this section, you'll find information about Continuum installations:
* {{{requirements.html}System Requirements}}
- * {{{installation.html}Installation in different environment (standalone, webapp, service)}}
+ * {{{installation.html}Installation in different environments (standalone, webapp, service)}}
* {{{../release-notes.html}Release Notes}}
Modified: continuum/trunk/continuum-docs/src/site/apt/installation/installation.apt
URL: http://svn.apache.org/viewvc/continuum/trunk/continuum-docs/src/site/apt/installation/installation.apt?rev=899465&r1=899464&r2=899465&view=diff
==============================================================================
--- continuum/trunk/continuum-docs/src/site/apt/installation/installation.apt (original)
+++ continuum/trunk/continuum-docs/src/site/apt/installation/installation.apt Thu Jan 14 23:24:16 2010
@@ -8,7 +8,7 @@
Continuum Installation
- In this section, you'll find all information about Continuum installation:
+ In this section, you'll find information about Continuum installations:
* {{{standalone.html}Standalone}}
Modified: continuum/trunk/continuum-docs/src/site/apt/installation/jboss.apt
URL: http://svn.apache.org/viewvc/continuum/trunk/continuum-docs/src/site/apt/installation/jboss.apt?rev=899465&r1=899464&r2=899465&view=diff
==============================================================================
--- continuum/trunk/continuum-docs/src/site/apt/installation/jboss.apt (original)
+++ continuum/trunk/continuum-docs/src/site/apt/installation/jboss.apt Thu Jan 14 23:24:16 2010
@@ -78,11 +78,11 @@
</datasources>
+--------------------------------+
- With <<<../database>>> used for the derby db path, databases will be created into <<<$JBOSS_HOME>>>
+ With <<<../database>>> used for the Derby db path, databases will be created in <<<$JBOSS_HOME>>>.
* {Mail Configuration}
- Edit <<<$JBOSS_HOME/server/default/deploy/mail-service.xml>>>
+ Edit <<<$JBOSS_HOME/server/default/deploy/mail-service.xml>>>.
* {Install Continuum}
@@ -92,9 +92,9 @@
* {Continuum Configuration}
- By default, the '<<<working directory>>>' and the '<<<build output directory>>>' are stored under the WEB-INF directory. If you want to change them (necessary on Windows
+ By default, the <<working directory>> and the <<build output directory>> are stored under the <<<WEB-INF>>> directory. If you want to change them (necessary on Windows
due to the path length limitation), you can configure them in the {{{../administrator_guides/configuration.html}Configuration page}}.
- By default, Continuum logs are stored into <<<${appserver.base}/logs/>>>. appserver.base is a system property. If you don't define it in the JBoss startup script, it will be empty,
+ By default, Continuum logs are stored into <<<${appserver.base}/logs/>>>. <<<appserver.base>>> is a system property. If you don't define it in the JBoss startup script, it will be empty,
so the Continuum logs directory will be at the root of your disk. If you want to use another location, you should modify
<<<$JBOSS_HOME/server/default/deploy/continuum.war/WEB-INF/classes/log4j.xml>>>
Modified: continuum/trunk/continuum-docs/src/site/apt/installation/jetty.apt
URL: http://svn.apache.org/viewvc/continuum/trunk/continuum-docs/src/site/apt/installation/jetty.apt?rev=899465&r1=899464&r2=899465&view=diff
==============================================================================
--- continuum/trunk/continuum-docs/src/site/apt/installation/jetty.apt (original)
+++ continuum/trunk/continuum-docs/src/site/apt/installation/jetty.apt Thu Jan 14 23:24:16 2010
@@ -16,13 +16,13 @@
* {Datasource Configuration}
- * Create a JDBC resource named '<<jdbc/continuum>>'
+ * Create a JDBC resource named <<<jdbc/continuum>>>
- * Create a JDBC resource named '<<jdbc/users>>'
+ * Create a JDBC resource named <<<jdbc/users>>>
For derby you can copy the following configuration in your <<<$JETTY_HOME/etc/jetty.xml>>>
- For other databases see {{{https://svn.apache.org/repos/asf/continuum/trunk/continuum-webapp/src/jetty-env-postgres.xml}PostgreSQL}}
+ For other databases see {{{https://svn.apache.org/repos/asf/continuum/trunk/continuum-webapp/src/jetty-env-postgres.xml}PostgreSQL}}
and {{{https://svn.apache.org/repos/asf/continuum/trunk/continuum-webapp/src/jetty-env-mysql.xml}MySQL}}
+-------------------------------------+
@@ -106,9 +106,9 @@
* {Start Jetty}
- To start Jetty, you'll need to use $JETTY_HOME/etc/jetty.xml <<and>> $JETTY_HOME/etc/jetty-plus.xml due to the datasources and mail configuration.
+ To start Jetty, you'll need to use <<<$JETTY_HOME/etc/jetty.xml>>> <<and>> <<<$JETTY_HOME/etc/jetty-plus.xml>>> due to the datasources and mail configuration.
* {Continuum Configuration}
- By default, the '<<<working directory>>>' and the '<<<build output directory>>>' are stored under the WEB-INF directory. If you want to change them (necessary on Windows
+ By default, the <<working directory>> and the <<build output directory>> are stored under the <<<WEB-INF>>> directory. If you want to change them (necessary on Windows
due to the path length limitation), you can configure them in the {{{../administrator_guides/configuration.html}Configuration page}}.
Modified: continuum/trunk/continuum-docs/src/site/apt/installation/requirements.apt
URL: http://svn.apache.org/viewvc/continuum/trunk/continuum-docs/src/site/apt/installation/requirements.apt?rev=899465&r1=899464&r2=899465&view=diff
==============================================================================
--- continuum/trunk/continuum-docs/src/site/apt/installation/requirements.apt (original)
+++ continuum/trunk/continuum-docs/src/site/apt/installation/requirements.apt Thu Jan 14 23:24:16 2010
@@ -13,7 +13,7 @@
*----------------------+--------------------------------------------------------------------------------------------------------------------------------+
| <<Memory>> | No minimum requirement |
*----------------------+--------------------------------------------------------------------------------------------------------------------------------+
-| <<Disk>> | The Continuum application package is less than 30MB but will use more disk space when it's checking out and building sources |
+| <<Disk>> | The Continuum application package is less than 30MB but will use more disk space when it's checking out and building sources |
*----------------------+--------------------------------------------------------------------------------------------------------------------------------+
| <<Operating System>> | No minimum requirement. Tested on Windows XP, Debian, Fedora Core, Solaris and Mac OS X |
*----------------------+--------------------------------------------------------------------------------------------------------------------------------+
Modified: continuum/trunk/continuum-docs/src/site/apt/installation/standalone.apt
URL: http://svn.apache.org/viewvc/continuum/trunk/continuum-docs/src/site/apt/installation/standalone.apt?rev=899465&r1=899464&r2=899465&view=diff
==============================================================================
--- continuum/trunk/continuum-docs/src/site/apt/installation/standalone.apt (original)
+++ continuum/trunk/continuum-docs/src/site/apt/installation/standalone.apt Thu Jan 14 23:24:16 2010
@@ -15,14 +15,14 @@
* Download the standalone version from the {{{http://continuum.apache.org/download.html} Download page}}
* Extract the file
-
- * Set a JAVA_HOME environment variable which use a jdk >= 1.5
+
+ * Set a <<<JAVA_HOME>>> environment variable which use a jdk >= 1.5
** {Defining JNDI Resources}
*** {Mail server configuration}
- Before to start Continuum, you must configure your SMTP configuration for mail notification. The configuration to do is in <<<$CONTINUUM_HOME/conf/jetty.xml>>>:
+ Before you start Continuum, you must configure your SMTP configuration for mail notification. The configuration is in <<<$CONTINUUM_HOME/conf/jetty.xml>>>:
%{snippet|id=mail|url=http://svn.apache.org/repos/asf/continuum/trunk/continuum-jetty/src/main/conf/jetty.xml}
@@ -41,29 +41,29 @@
continuum.bat install
------------------
- * Edit the <<<'Apache Continuum'>>> service
+ * Edit the <<Apache Continuum>> service
- * To see the services that are on your computer go to Start|Run and enter <<<'services.msc'>>>.
+ * To see the services that are on your computer go to Start|Run and enter <<<services.msc>>>.
- * Select the <<<'Startup Type'>>>
+ * Select the <<Startup Type>>
- * Go to the <<<'Log On'>>> tab and select a real user. A real user is required because you'll need a home directory for maven repository and some other things
+ * Go to the <<Log On>> tab and select a real user. A real user is required because you'll need a home directory for Maven repository and some other things
* Validate your changes
* {Installing as a Linux Service}
- Since the Continuum linux script bin/linux/run.sh understands the same arguments as linux boot scripts, there is no need to write a particular
+ Since the Continuum Linux script <<<bin/linux/run.sh>>> understands the same arguments as Linux boot scripts, there is no need to write a particular
startup script to add Continuum to the linux boot process. All you need to do, as root, is:
-
+
** {Basic script in /etc/init.d}
- * Create a <<<'continuum'>>> file under <<</etc/init.d/>>> with the following content (replacing <<<continuum_user>>> with the name of an account you have already created):
+ * Create a <<<continuum>>> file under <<</etc/init.d/>>> with the following content (replacing <<<continuum_user>>> with the name of an account you have already created):
------------------
#!/bin/sh
-CONTINUUM_HOME=/opt/continuum-1.2
+CONTINUUM_HOME=/opt/continuum-1.3
su - continuum_user -c "$CONTINUUM_HOME/bin/continuum console $@ &"
------------------
@@ -74,13 +74,13 @@
------------------
At this point you have Continuum ready to be symlinked from different runlevels. This might sound a bit esoteric, but it is not, you will find these words
- very fast as soon as you start reading about the init process. Fortunately, Debian GNU/Linux comes with a very handy utility to create this links, just run as root:
+ very fast as soon as you start reading about the init process. Fortunately, Debian GNU/Linux comes with a very handy utility to create these links, just run as root:
------------------
update-rc.d -n continuum defaults 80
------------------
- If you run this command, you will see something like this:
+ If you run this command, you will look something like this:
------------------
Adding system startup for /etc/init.d/continuum ...
@@ -97,16 +97,16 @@
** {In a RedHat-based system}
- Configuring Continuum in a RedHat-based system (like Fedora Core) is slightly different: Instead of running update-rc.d, you need to add a new
- service using chkconfig. And in order to add Continuum to chkconfig, it is necessary to add some comments to the /etc/rc.d/init.d/continuum script
- and run a couple of commands; these tasks are automatically executed by running the chkconfig_install.sh script (note that _continuum_user_ needs to be
+ Configuring Continuum in a RedHat-based system (like Fedora Core) is slightly different: Instead of <<<running update-rc.d>>>, you need to add a new
+ service using <<<chkconfig>>>. And in order to add Continuum to <<<chkconfig>>>, it is necessary to add some comments to the <<</etc/rc.d/init.d/continuum>>> script
+ and run a couple of commands; these tasks are automatically executed by running the <<<chkconfig_install.sh>>> script (note that _continuum_user_ needs to be
replaced by the name of an account you have already created):
------------------
#! /bin/sh
#
# chkconfig_install.sh - install Continuum on a chkconfig-bases system
-#
+#
# Author: Felipe Leme <felipeal at apache.org>
#
@@ -123,7 +123,7 @@
exit 1
fi
-echo "Creating file ${INITD_SCRIPT}"
+echo "Creating file ${INITD_SCRIPT}"
cat >> ${INITD_SCRIPT} <<EOF
#! /bin/sh
# chkconfig: 345 90 10
@@ -146,10 +146,10 @@
EOF
chmod +x ${INITD_SCRIPT}
-echo "Adding Continuum to chkconfig"
+echo "Adding Continuum to chkconfig"
chkconfig --add continuum
-echo "Enabling Continuum on chkconfig"
+echo "Enabling Continuum on chkconfig"
chkconfig continuum on
echo "Continuum set to start on run levels 3, 4 and 5."
echo "To start continuum now, run 'service continuum start'"
Modified: continuum/trunk/continuum-docs/src/site/apt/installation/tomcat.apt
URL: http://svn.apache.org/viewvc/continuum/trunk/continuum-docs/src/site/apt/installation/tomcat.apt?rev=899465&r1=899464&r2=899465&view=diff
==============================================================================
--- continuum/trunk/continuum-docs/src/site/apt/installation/tomcat.apt (original)
+++ continuum/trunk/continuum-docs/src/site/apt/installation/tomcat.apt Thu Jan 14 23:24:16 2010
@@ -19,7 +19,7 @@
With every Tomcat version you will need a few things before you can deploy Continuum.
- [[1]] Use at least Java JDK 1.5.0_11 to run Tomcat w/Continuum.
+ [[1]] Use at least Java JDK 1.5.0_11 to run Tomcat with Continuum.
[[1]] A defined \<Context\> xml section to define the JNDI resources.
@@ -54,7 +54,7 @@
The individual techniques for describing these resources, and the parameters associated with them are specific to the Tomcat version, resource type, and even JDBC implementation type.
For the purposes of this document, the following assumptions are made.
-
+
[[1]] You are an Apache Tomcat administrator.
[[1]] You have an SMTP Server on localhost, port 25, with no login / password.
@@ -67,8 +67,8 @@
<<Note:>> Continuum requires JavaMail 1.4 (or later)
- Apache Tomcat does not typically ship with a copy of the JavaMail or Activation jar files.
- In your role as the Apache Tomcat administrator of your installation, you will need to obtain these jar files and place it into your preferred lib directory.
+ Apache Tomcat does not typically ship with a copy of the JavaMail or Activation JAR files.
+ In your role as the Apache Tomcat administrator of your installation, you will need to obtain these JAR files and place it into your preferred <<<lib>>> directory.
The appropriate lib directory to choose is a personal preference, and we do not encourage or enforce a specific location for it, as all installations of Apache Tomcat are different.
@@ -84,9 +84,11 @@
<<Note:>>Continuum 1.2 has been tested with Apache Derby 10.1.3.1
+~~TODO What version of Derby should be used with Continuum 1.3?
+
The default installation of Continuum uses the Apache Derby 100% Java database to maintain Continuum-specific information, and also the Users / Security Database.
- You will need to obtain the derby.jar and derbytools.jar and place them into your preferred lib directory.
+ You will need to obtain the <<<derby.jar>>> and <<<derbytools.jar>>> and place them into your preferred lib directory.
We put them into the <<<$CATALINA_HOME/common/lib/>>> directory.
@@ -115,10 +117,12 @@
* {Tomcat 5.0.x Specifics}
- Tested on Tomcat v5.0.28
+ Tested on Tomcat v5.0.28.
These instructions explain how to deploy the Continuum 1.2 web application in an existing installation of Tomcat 5.0.x.
+~~TODO What about for Continuum 1.3?
+
<<Extra Jars:>>
* You will need the {{{http://repo1.maven.org/maven2/xalan/xalan/2.7.0/xalan-2.7.0.jar}xalan-2.7.0.jar}} copied into your <<<$CATALINA_HOME/common/lib/>>> directory.
@@ -191,7 +195,7 @@
* {Tomcat 5.5.x Specifics}
- Tested on Tomcat v5.5.17 and v5.5.25
+ Tested on Tomcat v5.5.17 and v5.5.25.
This example \<Context\> assumes technique #2 in the {{{#Defining_JNDI_Resources}Define JNDI Resource}} list. (This example lists out the <<<docBase>>> to the war file itself.)
@@ -222,12 +226,12 @@
</Context>
------------------------------------------
- <<Warning:>> The Tomcat 5.5.20 and 5.5.23 releases are missing MailSessionFactory and a few other classes.
+ <<Warning:>> The Tomcat 5.5.20 and 5.5.23 releases are missing MailSessionFactory and a few other classes.
JNDI mail sessions will <<not>> work. Use Tomcat 5.5.17 or see the workaround on {{{http://issues.apache.org/bugzilla/show_bug.cgi?id=40668}Bug 40668}}.
* {Tomcat 6.0.x Specifics}
- Tested on Tomcat v6.0.14
+ Tested on Tomcat v6.0.14.
------------------------------------------
<Context path="/continuum"
Modified: continuum/trunk/continuum-docs/src/site/apt/installation/upgrade.apt
URL: http://svn.apache.org/viewvc/continuum/trunk/continuum-docs/src/site/apt/installation/upgrade.apt?rev=899465&r1=899464&r2=899465&view=diff
==============================================================================
--- continuum/trunk/continuum-docs/src/site/apt/installation/upgrade.apt (original)
+++ continuum/trunk/continuum-docs/src/site/apt/installation/upgrade.apt Thu Jan 14 23:24:16 2010
@@ -12,7 +12,7 @@
This document will help you upgrade Continuum from 1.2.x to 1.3.3 and above.
When upgrading Continuum, it could have some database model changes. Usually these changes will be migrated for you, but in some cases
- you may need to use a backup from the previous version and to restore the data into the new version. The Data Management tool exports data from the
+ you may need to use a backup from the previous version and restore that data into the new version. The Data Management tool exports data from the
old database model and imports the data into the new database model.
<<Note:>> The Jetty version in Continuum 1.3.4 and above has been upgraded to 6.1.19.
@@ -70,7 +70,7 @@
<<Note:>> Remove <<<-strict>>> when importing data from 1.3.1 to 1.3.x to ignore unrecognized tags due to model changes.
[]
-
+
Finally, be aware that sometimes the NEXT_VAL values in the SEQUENCE_TABLE need to be adjusted.
* Before starting Continuum for the first time after the import, connect to the db with a client like {{{http://squirrel-sql.sourceforge.net/}Squirrel SQL}} and check the values in the <<NEXT_VAL>> column of the SEQUENCE_TABLE.
@@ -97,4 +97,4 @@
[]
Now you can start your new version of Continuum.
-
+
Modified: continuum/trunk/continuum-docs/src/site/apt/user_guides/building_project/build_results.apt
URL: http://svn.apache.org/viewvc/continuum/trunk/continuum-docs/src/site/apt/user_guides/building_project/build_results.apt?rev=899465&r1=899464&r2=899465&view=diff
==============================================================================
--- continuum/trunk/continuum-docs/src/site/apt/user_guides/building_project/build_results.apt (original)
+++ continuum/trunk/continuum-docs/src/site/apt/user_guides/building_project/build_results.apt Thu Jan 14 23:24:16 2010
@@ -10,24 +10,24 @@
[../../images/build_result-2.png] Builds tab
To view the result of the build:
-
+
[[1]] Click the link for the project group of the project you want to view - the link will be
under the <<Name>> column.
-
+
[[2]] Click the build number link under the <<Build>> column of the project you want to view.
Or you can click the project link again and click the <<Builds>> link at the top of the page, then click
- the <<Result>> link, next to the State column.
-
+ the <<Result>> link, next to the <<State>> column.
+
[]
-
+
When builds are executed frequently, deleting unnecessary and failed build results is needed.
To delete build results, follow these steps:
[[1]] Click the name of the project group.
-
+
[[2]] Click on the build number under the <<Build>> column. You will be directed to the build result
page as shown below.
-
+
\
[../../images/build_result-1.png] Build Results page
@@ -37,10 +37,10 @@
Or you can click on the name of the project that you want to delete build results from.
- * Click the <<Builds>> tab. Build results list will be displayed.
-
+ * Click the <<Builds>> tab. The build results list will be displayed.
+
* Check the box of the build results that you want to delete.
-
+
[]
-
+
[[3]] Click the <<Delete>> button.
Modified: continuum/trunk/continuum-docs/src/site/apt/user_guides/building_project/forced_build.apt
URL: http://svn.apache.org/viewvc/continuum/trunk/continuum-docs/src/site/apt/user_guides/building_project/forced_build.apt?rev=899465&r1=899464&r2=899465&view=diff
==============================================================================
--- continuum/trunk/continuum-docs/src/site/apt/user_guides/building_project/forced_build.apt (original)
+++ continuum/trunk/continuum-docs/src/site/apt/user_guides/building_project/forced_build.apt Thu Jan 14 23:24:16 2010
@@ -9,46 +9,46 @@
Occasionally you may want to force a build outside of the regular schedule.
When builds are triggered manually, the following happens:
-
+
* Projects are updated from the SCM.
- These are queued under the Prepare Build Queues section in <<Queues>> page.
-
+ These are queued under the <<Prepare Build Queues>> section in <<Queues>> page.
+
* Builds of the projects are executed.
- These are queued under the Build Queues in <<Queues>> page.
-
+ These are queued under the <<Build Queues>> in <<Queues>> page.
+
[]
-
+
If there are duplicates of a project in <<another project group>> (duplicates would mean
another instance of a project with the same groupId, artifactId, and version),
all the projects are built.
-
+
However, if there are duplicates of a project in the <<same project group>>, only one (1) of the duplicated
projects is built.
-
+
To manually build a project perform the following steps:
-
+
[[1]] Click <<Show Project Groups>>.
-
+
[[2]] Click the project group link of the project you want to build.
This will put you on the <<Summary>> page of the project group.
-
+
[[3]] You can click <<Build all projects>> button under <<Group Actions>> to build all
the projects in the project group.
-
+
[../../images/force_build.png] Project Group Actions
[[4]] To build an individual project, you can click on the build icon that is found
along the row of the project you want to build. It is the first icon on the right of
the project name. This will execute the default build goal you have defined for that project.
-
+
To build selected projects, check the box beside the name of the project,
then click the <<Build Project(s)>> button.
-
+
If you want to build the project according to a specific build goal other than the
default build goal, click on the project name to go to the <<Project's Information>> page.
All build goal definitions for the project are listed under the <<Build Definitions>> section.
Click on the build icon to the right of the specific build goal you want to execute.
-
+
[]
-
+
To view the results of the build, refer to {{{build_results.html}Build Results Management}}.
Modified: continuum/trunk/continuum-docs/src/site/apt/user_guides/building_project/index.apt
URL: http://svn.apache.org/viewvc/continuum/trunk/continuum-docs/src/site/apt/user_guides/building_project/index.apt?rev=899465&r1=899464&r2=899465&view=diff
==============================================================================
--- continuum/trunk/continuum-docs/src/site/apt/user_guides/building_project/index.apt (original)
+++ continuum/trunk/continuum-docs/src/site/apt/user_guides/building_project/index.apt Thu Jan 14 23:24:16 2010
@@ -9,38 +9,38 @@
Building Projects
For Ant and maven builds the following system properties will be added via -D command line:
-
- * continuum.project.group.name
-
- * continuum.project.lastBuild.state : last build state int flag
-
- * continuum.project.lastBuild.number
-
- * continuum.project.nextBuild.number
-
- * continuum.project.id
-
- * continuum.project.name
-
- * continuum.project.version
-
- []
-
+
+ * <<<continuum.project.group.name>>>
+
+ * <<<continuum.project.lastBuild.state>>> : last build state int flag
+
+ * <<<continuum.project.lastBuild.number>>>
+
+ * <<<continuum.project.nextBuild.number>>>
+
+ * <<<continuum.project.id>>>
+
+ * <<<continuum.project.name>>>
+
+ * <<<continuum.project.version>>>
+
+ []
+
When building projects, the build order is determined by the inter-dependency of the projects.
This would mean that the dependencies of a project are built first.
-
+
In cases when a project group can build projects in parallel build queues but one of those projects depend
on another project, the inter-dependent projects will build in the same build queue.
-
+
Projects can be built in two ways:
-
+
[[1]] {{{schedule_build.html} Scheduled Builds}}
-
+
[[2]] {{{forced_build.html} Forced Builds}}
[]
- Projects will have the <<in queue>> icon once the forced build or the scheduled build is triggered. This means that the project is either in the prepare build
- queue or in the build queue.
+ Projects will have the <<in queue>> icon once the forced build or a scheduled build is triggered. This means that the project is either in the <<prepare build
+ queue>> or in the <<build queue>>.
[../../images/inqueue.gif]
Modified: continuum/trunk/continuum-docs/src/site/apt/user_guides/building_project/schedule_build.apt
URL: http://svn.apache.org/viewvc/continuum/trunk/continuum-docs/src/site/apt/user_guides/building_project/schedule_build.apt?rev=899465&r1=899464&r2=899465&view=diff
==============================================================================
--- continuum/trunk/continuum-docs/src/site/apt/user_guides/building_project/schedule_build.apt (original)
+++ continuum/trunk/continuum-docs/src/site/apt/user_guides/building_project/schedule_build.apt Thu Jan 14 23:24:16 2010
@@ -8,25 +8,25 @@
Scheduling Project Build
Schedules determine the project's time interval to build.
-
+
When scheduled builds are triggered, there is no dependency ordering between project groups
and the following happens:
-
+
* Projects are updated from the SCM.
- These are queued under the Prepare Build Queues section in <<Queues>> page.
-
+ These are queued under the <<Prepare Build Queues>> section in <<Queues>> page.
+
* Builds of the projects are executed.
- These are queued under the Build Queues in <<Queues>> page.
-
+ These are queued under the <<Build Queues>> in <<Queues>> page.
+
[]
-
+
If there are duplicates of a project in <<another project group>> (duplicates would mean
another instance of a project with the same groupId, artifactId, and version),
both projects are built.
-
+
However, if there are duplicates of a project in the <<same project group>>, only one (1)
of the projects is built.
-
+
To configure a scheduled build:
[[1]] Create a schedule. You can refer to {{{../../administrator_guides/schedules.html} Managing Schedules}} section.
@@ -37,5 +37,5 @@
[../../images/schedule_build.png] Scheduling build
[]
-
+
To view the results of the build, refer to {{{build_results.html}Build Results Management}}.
Modified: continuum/trunk/continuum-docs/src/site/apt/user_guides/cancelling_build/cancelProjectBuild.apt
URL: http://svn.apache.org/viewvc/continuum/trunk/continuum-docs/src/site/apt/user_guides/cancelling_build/cancelProjectBuild.apt?rev=899465&r1=899464&r2=899465&view=diff
==============================================================================
--- continuum/trunk/continuum-docs/src/site/apt/user_guides/cancelling_build/cancelProjectBuild.apt (original)
+++ continuum/trunk/continuum-docs/src/site/apt/user_guides/cancelling_build/cancelProjectBuild.apt Thu Jan 14 23:24:16 2010
@@ -10,6 +10,6 @@
This will cancel the build of the selected project.
- To cancel build for project, click the Cancel Button of the project on the Project Group Summary page or on the Queues page.
+ To cancel the build for project, click the <<Cancel>> button of the project on the <<Project Group Summary>> page or on the <<Queues>> page.
[../../images/cancelbuild.gif] Cancel Button
Modified: continuum/trunk/continuum-docs/src/site/apt/user_guides/managing_builddef/builddefGroup.apt
URL: http://svn.apache.org/viewvc/continuum/trunk/continuum-docs/src/site/apt/user_guides/managing_builddef/builddefGroup.apt?rev=899465&r1=899464&r2=899465&view=diff
==============================================================================
--- continuum/trunk/continuum-docs/src/site/apt/user_guides/managing_builddef/builddefGroup.apt (original)
+++ continuum/trunk/continuum-docs/src/site/apt/user_guides/managing_builddef/builddefGroup.apt Thu Jan 14 23:24:16 2010
@@ -12,35 +12,35 @@
[../../images/buildDefGroup.png] Project Group Build Definitions
- To add build defintion to your project group:
-
+ To add a build defintion to your project group:
+
[[1]] Under the <<Build Definitions>> tab in the <<Project Information>> screen, click <<Add>>.
-
+
[[2]] Supply the values for the necessary fields.
* Enter your <<POM filename>>, which is very likely the same as previous builds, <<<pom.xml>>>.
-
+
* In the <<Goals>> text box, enter your new goals. For example, <<<clean site deploy>>> or <<<release:branch>>>.
* You may have arguments for Maven, such as <<<--batch-mode --non-recursive>>>.
- Add your arguments in the Arguments text box or leave it empty.
+ Add your arguments in the <<Arguments>> text box or leave it empty.
- * Check <<Build Fresh>> to do a fresh checkout from CVS before the build process.
+ * Check <<Build Fresh>> to do a fresh checkout from SCM before the build process.
Check <<Always Build>> if you want to execute the goal every time you build the project.
If you want this build definition to be your default for building your project,
check the <<Is it default?>> check box.
-
+
* Select your build schedule from the pull-down menu. There will only be the <<<DEFAULT_SCHEDULE>>>
if you have not defined any others.
-
- * Select from the pull-down menu the <<Build Environment>> for the build goal.
-
+
+ * Select from the pull-down menu the <<Build Environment>> for the build definition.
+
* Select the <<Type>> from the pull-down menu.
-
+
* You can supply a short description of the build definition (<<Definition>>).
-
+
[]
[../../images/add_goal.png]
-
+
[[3]] Click <<Save>>.
\ No newline at end of file
Modified: continuum/trunk/continuum-docs/src/site/apt/user_guides/managing_builddef/builddefProject.apt
URL: http://svn.apache.org/viewvc/continuum/trunk/continuum-docs/src/site/apt/user_guides/managing_builddef/builddefProject.apt?rev=899465&r1=899464&r2=899465&view=diff
==============================================================================
--- continuum/trunk/continuum-docs/src/site/apt/user_guides/managing_builddef/builddefProject.apt (original)
+++ continuum/trunk/continuum-docs/src/site/apt/user_guides/managing_builddef/builddefProject.apt Thu Jan 14 23:24:16 2010
@@ -8,41 +8,41 @@
Project Build Definition
- The project level build definition is executed to a specific project where the build definition is defined.
+ The project level build definition is executed for a specific project where the build definition is defined.
[../../images/buildDefProject.png] Project Build Definitions
- To add build defintion to your project:
-
+ To add a build defintion to your project:
+
[[1]] Select a project within the group.
-
+
[[2]] Under the <<Build Definitions>> section in the <<Project Information>> screen, click <<Add>>.
-
+
[[3]] Supply the values for the necessary fields.
* Enter your <<POM filename>>, which is very likely the same as previous builds, <<<pom.xml>>>.
-
+
* In the <<Goals>> text box, enter your new goals. For example, <<<clean site deploy>>> or <<<release:branch>>>.
* You may have arguments for Maven, such as <<<--batch-mode --non-recursive>>>.
- Add your arguments in the Arguments text box or leave it empty.
+ Add your arguments in the <<Arguments>> text box or leave it empty.
- * Check <<Build Fresh>> to do a fresh checkout from CVS before the build process.
+ * Check <<Build Fresh>> to do a fresh checkout from SCM before the build process.
Check <<Always Build>> if you want to execute the goal every time you build the project.
If you want this build definition to be your default for building your project,
check the <<Is it default?>> check box.
-
+
* Select your build schedule from the pull-down menu. There will only be the <<<DEFAULT_SCHEDULE>>>
if you have not defined any others.
-
- * Select from the pull-down menu the <<Build Environment>> for the build goal.
-
+
+ * Select from the pull-down menu the <<Build Environment>> for the build definition.
+
* Select the <<Type>> from the pull-down menu.
-
+
* You can supply a short description of the build definition (<<Definition>>).
-
+
[]
[../../images/add_goal.png]
-
+
[[4]] Click <<Save>>.
\ No newline at end of file
Modified: continuum/trunk/continuum-docs/src/site/apt/user_guides/managing_builddef/index.apt
URL: http://svn.apache.org/viewvc/continuum/trunk/continuum-docs/src/site/apt/user_guides/managing_builddef/index.apt?rev=899465&r1=899464&r2=899465&view=diff
==============================================================================
--- continuum/trunk/continuum-docs/src/site/apt/user_guides/managing_builddef/index.apt (original)
+++ continuum/trunk/continuum-docs/src/site/apt/user_guides/managing_builddef/index.apt Thu Jan 14 23:24:16 2010
@@ -10,11 +10,10 @@
Managing Build Definitions
Each project or project group must have at least one attached build definition in order to build.
-
+
Depending on the project, you can define different values which will be used in order to build your project.
-
- Continuum includes some default build definitions which can be changed in the <<{{{../../administrator_guides/builddefTemplate.html}Build Definition Templates screen}}>>.
-
+
+ Continuum includes some default build definitions which can be changed in the <<{{{../../administrator_guides/builddefTemplate.html}Build Definition Templates}}>> screen.
+
You can add or edit build definitions at the <<{{{builddefGroup.html}Project Group level}}>> or at the <<{{{builddefProject.html}Project level}}>>.
-
-
\ No newline at end of file
+
Modified: continuum/trunk/continuum-docs/src/site/apt/user_guides/managing_project/addProject.apt
URL: http://svn.apache.org/viewvc/continuum/trunk/continuum-docs/src/site/apt/user_guides/managing_project/addProject.apt?rev=899465&r1=899464&r2=899465&view=diff
==============================================================================
--- continuum/trunk/continuum-docs/src/site/apt/user_guides/managing_project/addProject.apt (original)
+++ continuum/trunk/continuum-docs/src/site/apt/user_guides/managing_project/addProject.apt Thu Jan 14 23:24:16 2010
@@ -13,76 +13,84 @@
* {Maven 2 project}
- From the menu, choose the 'Maven 2.0.x Project' entry
-
-[../../images/add-m2-project-menu.png] Add a maven2 project
-
- The pom.xml file must be available through one of the following protocols: http, https, or ftp
- (The file protocol is also supported but is disabled by default for security and must be enabled manually).
-
- Or it can be uploaded from a local file (Note this doesn't support multi module projects).
-
-[../../images/add-m2-project.png] Add a maven2 project
+ From the menu, choose the <<Maven 2.0.x Project>> entry
+
+[../../images/add-m2-project-menu.png] Add a Maven 2 project
+
+ The <<<pom.xml>>> file must be available through one of the following protocols: http, https, or ftp.
+
+ <<Note:>> The file protocol is also supported but is disabled by default for security and must be enabled manually.
+
+~~ TODO: Explain how to enable the file protocol
+
+ The <<<pom.xml>>> can also be uploaded from a local file.
+
+ <<Note:>> This doesn't support multi module projects.
+
+[../../images/add-m2-project.png] Add a Maven 2 project
You can supply a username and password if the POM URL requires authentication. This information will be stored in the database in plain text and reused later for scm checkouts and updates.
- If your SCM stores credentials like CVS or SVN and you want to use the SCM Credentials cache, check the "Use SCM Credentials Cache" field.
+ If your SCM stores credentials like CVS or SVN and you want to use the SCM Credentials cache, check the <<Use SCM Credentials Cache>> field.
~~ TODO: If 'use cached credentials' is checked, then the credentials should NOT be stored in the database. Need to see whether that's actually true before documenting it.
- You can define the group you want to use or "Defined by POM" in this case project.name will be use as Project Group.
+ You can define the group you want to use or <<Defined by POM>> in this case <<<project.name>>> will be used as <<Project Group>>.
You cannot add a duplicate project (duplicates would mean another instance of a project with the same groupId, artifactId, and version) in the same Project Group.
- By default, Continuum adds each sub-module POM as an individual Continuum Project. If you want to add only the root POM without sub-modules, check the "load only root as recursive build" field.
+ By default, Continuum adds each sub-module POM as an individual Continuum Project. If you want to add only the root POM without sub-modules, check the <<load only root as recursive build>> field.
- You can choose a Build Definition Template which will be applied to your project. If you choose a Build Definition
- Template, the build definitions from the template will be added in addition to any build definitions that are defined
+ You can choose a <<Build Definition Template>> which will be applied to your project. If you choose a <<Build Definition
+ Template>>, the build definitions from the template will be added in addition to any build definitions that are defined
at the project group level.
-
+
When adding projects whose parent project is building on another server,
make sure that the <<<settings.xml>>> with the necessary repositories exists in <<<[USER_HOME]/.m2/>>> directory.
Continuum uses <<<[USER_HOME]/.m2/settings.xml>>> and not the one found in <<<[M2_HOME]/conf/>>>.
* {Maven 1 project}
-
- From the menu, choose the 'Maven 1.x Project' entry
-
-[../../images/add-m1-project-menu.png] Add a maven1 project
-
- The project.xml file must be available through one of the following format : http, https and ftp
- (file protocol is off by default for security and must enabled manually).
-
- Or it can be uploaded (Note this doesn't support multi modules project).
+
+ From the menu, choose the <<Maven 1.x Project>> entry
+
+[../../images/add-m1-project-menu.png] Add a Maven 1 project
+
+ The <<<project.xml>>> file must be available through one of the following format : http, https and ftp.
+
+ <<Note:>> The file protocol is off by default for security and must enabled manually.
+
+ The <<<project.xml>>> can also be uploaded from a local file.
+
+ <<Note:>> This doesn't support multi modules project.
The project you're adding can't use a parent.
-
-[../../images/add-m1-project.png] Add a maven1 project
+
+[../../images/add-m1-project.png] Add a Maven 1 project
You can define username/password if the POM URL require an authentication.
- If your SCM store credentials like CVS or SVN and you want to use the SCM Credentials cache, check the "Use SCM Credentials Cache" field.
+ If your SCM store credentials like CVS or SVN and you want to use the SCM Credentials cache, check the <<Use SCM Credentials Cache>> field.
- You can define the group you want to use or "Defined by POM." In this case project.name will be used as the Project Group.
-
- You cannot add a duplicate project (duplicates would mean another instance of a project with the same groupId, artifactId, and version) in the same Project Group.
+ You can define the group you want to use or <<Defined by POM>>. In this case <<<project.name>>> will be used as the <<Project Group>>.
+
+ You cannot add a duplicate project (duplicates would mean another instance of a project with the same groupId, artifactId, and version) in the same <<Project Group>>.
- You can choose a Build Definition Template which will be applied to your project.
+ You can choose a <<Build Definition Template>> which will be applied to your project.
* {ANT Project}
- From the menu, choose the 'Ant Project' entry
-
-[../../images/add-ant-project-menu.png] Add a Ant project
+ From the menu, choose the <<Ant Project>> entry
+
+[../../images/add-ant-project-menu.png] Add an Ant project
TO WRITE
-[../../images/add-ant-project.png] Add a Ant project
+[../../images/add-ant-project.png] Add an Ant project
* {Shell Project}
- From the menu, choose the 'Shell Project' entry
-
+ From the menu, choose the <<Shell Project>> entry
+
[../../images/add-shell-project-menu.png] Add a shell project
TO WRITE
@@ -91,7 +99,7 @@
* {Add a project from the Project Group}
- From the Project Group, you can add a project without using the menu. With this operation, the Project Group will be set to the current group.
+ From the <<Project Group>>, you can add a project without using the menu. With this operation, the <<Project Group>> will be set to the current group.
[../../images/add-project-from-group.png] Add a project from a project group
@@ -119,4 +127,4 @@
+----------------------------+
This configuration won't work with each ClearCase installation because each ClearCase configuration is different, so we recommend reading the
- {{{http://maven.apache.org/scm/clearcase.html}ClearCase page}} on the Maven-SCM site.
+ {{{http://maven.apache.org/scm/clearcase.html}ClearCase page}} on the Maven SCM site.
Modified: continuum/trunk/continuum-docs/src/site/apt/user_guides/managing_project/editProject.apt
URL: http://svn.apache.org/viewvc/continuum/trunk/continuum-docs/src/site/apt/user_guides/managing_project/editProject.apt?rev=899465&r1=899464&r2=899465&view=diff
==============================================================================
--- continuum/trunk/continuum-docs/src/site/apt/user_guides/managing_project/editProject.apt (original)
+++ continuum/trunk/continuum-docs/src/site/apt/user_guides/managing_project/editProject.apt Thu Jan 14 23:24:16 2010
@@ -13,12 +13,12 @@
* {Project View}
- When you edit a project from the Group Summary page, you will see basic information.
+ When you edit a project from the <<Group Summary>> page, you will see basic information.
The first part of the page contains information regarding:
* project name
- * project version
+ * project version
* project scm url
@@ -30,16 +30,16 @@
[../../images/project-view-top.png] Project View Top
- With the <<<'Edit'>>> button, you can change some project informations like the scm url if your project was moved.
- With the <<<'Build Now'>>> button, you build the project manually with the default build definition.
+ With the <<Edit>> button, you can change some project information like the SCM URL if your project was moved.
+ With the <<Build Now>> button, you build the project manually with the default build definition.
- Second part contains information regarding:
+ The second part contains information regarding:
* project notifiers
* project dependencies
- * project developpers
+ * project developers
[]
@@ -47,9 +47,9 @@
* {Build Results}
- You can view all project's Build Results with the link Builds
- You will see all build results summary : start/end Time, result.
- It's possible to delete some build results with checkboxes
+ You can view all project's <<Build Results>> with the link <<Builds>>.
+ You will see all build results summary: start/end time, result.
+ It's possible to delete some build results with checkboxes.
[../../images/build-results.png] Build Results
@@ -57,7 +57,7 @@
* {Build Result}
- Editing a build result will display :
+ Editing a build result will display:
* scm changes (author and file path)
@@ -70,7 +70,3 @@
[]
[../../images/build-result.png] Build Result
-
-
-
-
Modified: continuum/trunk/continuum-docs/src/site/apt/user_guides/managing_project/removeProject.apt
URL: http://svn.apache.org/viewvc/continuum/trunk/continuum-docs/src/site/apt/user_guides/managing_project/removeProject.apt?rev=899465&r1=899464&r2=899465&view=diff
==============================================================================
--- continuum/trunk/continuum-docs/src/site/apt/user_guides/managing_project/removeProject.apt (original)
+++ continuum/trunk/continuum-docs/src/site/apt/user_guides/managing_project/removeProject.apt Thu Jan 14 23:24:16 2010
@@ -8,8 +8,8 @@
Remove a Project
- To remove a project, go to the Project Group Summary and click the <<delete>> icon.
+ To remove a project, go to the <<Project Group Summary>> and click the <<delete>> icon.
[../../images/delete.gif] Delete icon
- You can also use the <<<'Delete group'>>> button in the Project Group Summary to remove the whole project group.
+ You can also use the <<Delete group>> button in the <<Project Group Summary>> to remove the whole project group.
Modified: continuum/trunk/continuum-docs/src/site/apt/user_guides/notification/index.apt
URL: http://svn.apache.org/viewvc/continuum/trunk/continuum-docs/src/site/apt/user_guides/notification/index.apt?rev=899465&r1=899464&r2=899465&view=diff
==============================================================================
--- continuum/trunk/continuum-docs/src/site/apt/user_guides/notification/index.apt (original)
+++ continuum/trunk/continuum-docs/src/site/apt/user_guides/notification/index.apt Thu Jan 14 23:24:16 2010
@@ -8,10 +8,10 @@
Managing Notification
- Notifiers can be attached to a Maven project by adding them to the pom in the {{{http://maven.apache.org/pom.html#Continuous_Integration_Management}ciManagement section}}.
-
+ Notifiers can be attached to a Maven project by adding them to the POM in the {{{http://maven.apache.org/pom.html#Continuous_Integration_Management}ciManagement section}}.
+
+-------------------------------+
-
+
<ciManagement>
<system>continuum</system>
<url>http://127.0.0.1:8080/continuum</url>
@@ -27,32 +27,32 @@
</configuration>
</notifier>
</notifiers>
- </ciManagement>
-
-+-------------------------------+
-
- Or they can be added to a Project Group with the Notifiers link:
-
-[../../images/notifiers-link-project-group.png] Notifiers Link
-
- Or to a project with the Add button on the Edit Project page:
-
-[../../images/notifiers-button-project.png] Notifier Button
+ </ciManagement>
+
++-------------------------------+
+
+ Or they can be added to a <<Project Group>> with the <<Notifiers>> link:
+
+[../../images/notifiers-link-project-group.png] Notifiers Link
+
+ Or added to a project with the <<Add>> button on the <<Edit Project>> page:
+
+[../../images/notifiers-button-project.png] Notifier Button
- Here you select between Notifier implementations provided with Continuum:
+ Here you select between the Notifier implementations provided with Continuum:
[../../images/notifiers-type-choice.png] Notifier Type Choice
You have the following choices:
-
+
* {{{mail.html}Mail}}
-
+
* {{{irc.html}IRC}}
-
+
* {{{jabber.html}Jabber}}
-
+
* {{{msn.html}MSN}}
-
+
* {{{wagon.html}Wagon}}
-
-
+
+
Modified: continuum/trunk/continuum-docs/src/site/apt/user_guides/notification/irc.apt
URL: http://svn.apache.org/viewvc/continuum/trunk/continuum-docs/src/site/apt/user_guides/notification/irc.apt?rev=899465&r1=899464&r2=899465&view=diff
==============================================================================
--- continuum/trunk/continuum-docs/src/site/apt/user_guides/notification/irc.apt (original)
+++ continuum/trunk/continuum-docs/src/site/apt/user_guides/notification/irc.apt Thu Jan 14 23:24:16 2010
@@ -1,5 +1,5 @@
------
- Irc Notification
+ IRC Notification
------
Olivier Lamy
------
@@ -8,33 +8,33 @@
IRC Notification
- [[1]] Under Notifiers from the Project Information page, click Add.
-
- [[2]] On the Add Notifier form select IRC from the pull-down menu and click Submit.
-
+ [[1]] Under <<Notifiers>> from the <<Project Information>> page, click <<Add>>.
+
+ [[2]] On the <<Add Notifier>> form select <<IRC>> from the pull-down menu and click <<Submit>>.
+
[[3]] On the next page, fill out the form with the following information:
-
+
* IRC Host
-
+
* IRC Port
-
+
* IRC Channel
-
+
* Nick Name
-
+
* Alternate Nick Name
-
+
* User Name
-
+
* Full Name
-
+
* Password which can be left blank if you did not specify one in your IRC account
-
+
[]
-
+
[../../images/notifier-irc-add.png] Add IRC Notifier
-
- [[4]] Select the Send on ... options you want.
-
- [[5]] Click Save. The IRC notifier you just added will be listed under Notifiers on the Project
- Information page along with the other notifiers you may have set up prior to this.
+
+ [[4]] Select the <<Send on ...>> options you want.
+
+ [[5]] Click <<Save>>. The IRC notifier you just added will be listed under <<Notifiers>> on the <<Project
+ Information>> page along with the other notifiers you may have set up prior to this.
Modified: continuum/trunk/continuum-docs/src/site/apt/user_guides/notification/jabber.apt
URL: http://svn.apache.org/viewvc/continuum/trunk/continuum-docs/src/site/apt/user_guides/notification/jabber.apt?rev=899465&r1=899464&r2=899465&view=diff
==============================================================================
--- continuum/trunk/continuum-docs/src/site/apt/user_guides/notification/jabber.apt (original)
+++ continuum/trunk/continuum-docs/src/site/apt/user_guides/notification/jabber.apt Thu Jan 14 23:24:16 2010
@@ -8,32 +8,32 @@
Jabber Notification
- [[1]] Under Notifiers from the Project Information page, click Add.
-
- [[2]] Select Jabber from the pull-down menu and click Submit.
-
- [[3]] On the Add/Edit Jabber Notifier page, fill out the form with the following:
-
+ [[1]] Under <<Notifiers>> from the <<Project Information>> page, click <<Add>>.
+
+ [[2]] Select <<Jabber>> from the pull-down menu and click Submit.
+
+ [[3]] On the <<Add/Edit Jabber Notifier>> page, fill out the form with the following:
+
* Jabber Host
-
+
* Jabber Port is typically 5222
-
+
* Jabber Login
-
+
* Jabber Password
-
+
* Jabber Domain Name is the fully qualified domain name of your Jabber login
-
+
* Jabber Recipient Address
-
+
[]
-
+
[../../images/notifier-jabber-add.png] Add Jabber Notifier
-
+
The Jabber login and Jabber recipient address must be different. The Jabber
recipient must also be added in the contact list of the sender (at least for Google talk).
-
- [[4]] Select the Send on ... options you want.
-
- [[5]] Click Save. The Jabber notifier you just added will be listed under Notifiers on the Project
- Information page along with the other notifiers you may have set up prior to this.
\ No newline at end of file
+
+ [[4]] Select the <<Send on ...>> options you want.
+
+ [[5]] Click <<Save>>. The Jabber notifier you just added will be listed under <<Notifiers>> on the <<Project
+ Information>> page along with the other notifiers you may have set up prior to this.
Modified: continuum/trunk/continuum-docs/src/site/apt/user_guides/notification/mail.apt
URL: http://svn.apache.org/viewvc/continuum/trunk/continuum-docs/src/site/apt/user_guides/notification/mail.apt?rev=899465&r1=899464&r2=899465&view=diff
==============================================================================
--- continuum/trunk/continuum-docs/src/site/apt/user_guides/notification/mail.apt (original)
+++ continuum/trunk/continuum-docs/src/site/apt/user_guides/notification/mail.apt Thu Jan 14 23:24:16 2010
@@ -8,11 +8,11 @@
Mail Notification
- If you are using Maven 2, email notifiers configured in pom.xml will be automatically added, and you may
+ If you are using Maven 2, email notifiers configured in <<<pom.xml>>> will be automatically added, and you may
have as many as you need.
-
+
+-------------------------------+
-
+
<ciManagement>
<system>continuum</system>
<notifiers>
@@ -24,23 +24,23 @@
</configuration>
</notifier>
</notifiers>
- </ciManagement>
-
-+-------------------------------+
+ </ciManagement>
+
++-------------------------------+
Or can you can manually add mail notifiers at the project group or individual project level.
-
- On the <<Add Notifier>> form select <<Mail>> from the pull-down menu and click Submit.
-
-[../../images/notifier-mail-add.png] Add Email Notifier
+
+ On the <<Add Notifier>> form select <<Mail>> from the pull-down menu and click <<Submit>>.
+
+[../../images/notifier-mail-add.png] Add Email Notifier
You must either provide a single email address, or select to notify the latest committers or project
developers.
~~ TODO: Does notifying an email address in addition to the latest committers also work?
- In addition you may select one or more "Send on..." options.
+ In addition you may select one or more <<Send on...>> options.
~~ TODO: What is "Send on Warning"? We only have three build states: error, failure, success
-
+
Then, click <<Save>>.
Modified: continuum/trunk/continuum-docs/src/site/apt/user_guides/notification/msn.apt
URL: http://svn.apache.org/viewvc/continuum/trunk/continuum-docs/src/site/apt/user_guides/notification/msn.apt?rev=899465&r1=899464&r2=899465&view=diff
==============================================================================
--- continuum/trunk/continuum-docs/src/site/apt/user_guides/notification/msn.apt (original)
+++ continuum/trunk/continuum-docs/src/site/apt/user_guides/notification/msn.apt Thu Jan 14 23:24:16 2010
@@ -8,23 +8,23 @@
MSN Notification
- [[1]] Under Notifiers from the Project Information page, click Add.
-
- [[2]] On the Add Notifier form select, MSN from the pull-down menu and click Submit.
-
+ [[1]] Under <<Notifiers>> from the <<Project Information>> page, click <<Add>>.
+
+ [[2]] On the <<Add Notifier>> form select <<MSN>> from the pull-down menu and click <<Submit>>.
+
[[3]] On the next page, fill out the form with the following:
-
+
* MSN Login
-
+
* MSN Password
-
+
* MSN Recipient Address
-
+
[]
-
+
[../../images/notifier-msn-add.png] Add MSN Notifier
-
- [[4]] Select the Send on ... options you want.
-
- [[5]] Click Save. The MSN notifier you just added will be listed under Notifiers on the Project
- Information page along with the other notifiers you may have set up prior to this.
\ No newline at end of file
+
+ [[4]] Select the <<Send on ...>> options you want.
+
+ [[5]] Click <<Save>>. The MSN notifier you just added will be listed under <<Notifiers>> on the <<Project
+ Information>> page along with the other notifiers you may have set up prior to this.
Modified: continuum/trunk/continuum-docs/src/site/apt/user_guides/notification/wagon.apt
URL: http://svn.apache.org/viewvc/continuum/trunk/continuum-docs/src/site/apt/user_guides/notification/wagon.apt?rev=899465&r1=899464&r2=899465&view=diff
==============================================================================
--- continuum/trunk/continuum-docs/src/site/apt/user_guides/notification/wagon.apt (original)
+++ continuum/trunk/continuum-docs/src/site/apt/user_guides/notification/wagon.apt Thu Jan 14 23:24:16 2010
@@ -1,5 +1,5 @@
------
- Jabber Notification
+ Wagon Notification
------
Olivier Lamy
------
@@ -8,16 +8,16 @@
Wagon Notification
- [[1]] Under Notifiers from the Project Information page, click Add.
-
- [[2]] On the Add Notifier form select Wagon from the pull-down menu and click Submit.
-
+ [[1]] Under <<Notifiers>> from the <<Project Information>> page, click <<Add>>.
+
+ [[2]] On the <<Add Notifier>> form select <<Wagon>> from the pull-down menu and click <<Submit>>.
+
[[3]] On the next page, enter the Project Site URL.
-
+
It must be a Wagon URL like the URL used in <<<distributionManagement>>>. For the Webdav protocol,
- you can use <<<dav:[http_url]>>> or <<<file:///path_to_the_directory>>> if you want to copy it locally
+ you can use <<<dav:[http_url]>>>, or <<<file:///path_to_the_directory>>> if you want to copy it locally
with the file protocol.
-
+
[[4]] Enter the ServerId. This should match the value of the <<<\<id\>>>> in the server configuration found in
<<<settings.xml>>>. Sample configuration follows:
@@ -30,23 +30,23 @@
+------+
Using the server configuration in <<<[user_home]/.m2/settings.xml>>> is a workaround
- for user authentication using the wagon notifier.
+ for user authentication using the Wagon notifier.
The <<<\<username\>>>> and <<<\<password\>>>> should be set to the user account that has the <<Site
Producer>> and <<Site Observer>> roles.
-
+
[../../images/notifier-wagon-add.png] Add Wagon Notifier
-
- [[5]] Select the Send on ... options you want.
-
- [[6]] Click Save. The Wagon notifier you just added will be listed under Notifiers on the Project
- Information page along with the other notifiers you may have set up prior to this.
-
+
+ [[5]] Select the <<Send on ...>> options you want.
+
+ [[6]] Click <<Save>>. The Wagon notifier you just added will be listed under <<Notifiers>> on the <<Project
+ Information>> page along with the other notifiers you may have set up prior to this.
+
[]
-
- The file protocol will create <<<buildresult.txt>>> file locally in the location specified in the
- Wagon Notifier configuration. If you used the Webdav protocol, a <<<buildresult.txt>>> file will
+
+ The file protocol will create a <<<buildresult.txt>>> file locally in the location specified in the
+ Wagon Notifier configuration. If you use the Webdav protocol, a <<<buildresult.txt>>> file will
be copied to your disk, relative to where you told it to be placed when you set up the Wagon
notifier.
-
- You can also view the <<<buildresult.txt>>> file from a browser at the Project Site URL you specified.
\ No newline at end of file
+
+ You can also view the <<<buildresult.txt>>> file from a browser at the Project Site URL you specified.
Modified: continuum/trunk/continuum-docs/src/site/apt/user_guides/release/index.apt
URL: http://svn.apache.org/viewvc/continuum/trunk/continuum-docs/src/site/apt/user_guides/release/index.apt?rev=899465&r1=899464&r2=899465&view=diff
==============================================================================
--- continuum/trunk/continuum-docs/src/site/apt/user_guides/release/index.apt (original)
+++ continuum/trunk/continuum-docs/src/site/apt/user_guides/release/index.apt Thu Jan 14 23:24:16 2010
@@ -9,33 +9,33 @@
[[1]] First, it prepares your project for release by doing the following:
* Checks that your project is in a "releasable" state.
-
+
* Updates the POMs for the new development version.
-
+
* Runs a test build.
-
+
* Generates a tag for the release.
-
- * Generates the artifact to be deployed, such as a jar file.
-
+
+ * Generates the artifact to be deployed, such as a JAR file.
+
* Generates the site and deploys it.
-
- * Commits the new POMs to the new development version. It will do the commit to the SCM
+
+ * Commits the new POMs with the new development version. It will do the commit to the SCM
connection URL you specify (explained later).
-
+
[]
-
+
[[2]] Then the release management system performs the release by checking out a clean copy
of the tagged release and deploying the artifacts and site.
-
+
[]
-
+
* Modifying POM for Release
- The source code control system you use must be specified in your POM file in an <<<scm>>> entry
+ The source code control system you use must be specified in your POM file in an <<<\<scm\>>>> entry
similar to the one shown here:
-
-+----------------------------------------------------------------------------------+
+
++----------------------------------------------------------------------------------+
<scm>
<connection>
scm:svn:http://svn.apache.org/repos/asf/maven/components/trunk
@@ -46,26 +46,26 @@
<url>http://svn.apache.org/viewcvs.cgi/maven/components/trunk</url>
</scm>
+---------------------------------------------------------------------------------+
-
- To determine what to enter for your connection URL (the "<<< \<connection\> >>>" tag) go to the link
+
+ To determine what to enter for your connection URL (the <<<\<connection\>>>> tag) go to the link
{{http://maven.apache.org/scm/scms-overview.html}} for a list of supported SCMs and click on your
source code control system to see the appropriate syntax for your particular software.
-
+
In general the format for an SCM URL is:
<<< scm:<scm_provider><delimiter><provider_specific_part> >>>
-
- In the example above, the <<<scm_provider>>> is "<<<svn>>>" (Subversion). The <<<delimiter>>> is a colon.
- And the rest of the line is the "<<<provider_specific_part>>>".
-
+
+ In the example above, the <<<scm_provider>>> is <<<svn>>> (Subversion). The <<<delimiter>>> is a colon.
+ And the rest of the line is the <<<provider_specific_part>>>.
+
It is important to prepare the release just before performing the release. The reason these
processes have been separated into two steps is to allow the user to confirm that everything has been
set correctly before the actual release. If between the prepare and performing of the release there is
a change to the SCM tree, an error will occur causing the prepare process to restart.
-
+
[]
* Releasing projects in a distributed build
Release will happen in the Build Agent where the last build of project occurred.
- To view on-going releases from different build agents, click the <<<Releases>>> button under the Distributed Builds menu.
+ To view on-going releases from different build agents, click the <<Releases>> button under the <<Distributed Builds>> menu.
Modified: continuum/trunk/continuum-docs/src/site/apt/user_guides/release/perform.apt
URL: http://svn.apache.org/viewvc/continuum/trunk/continuum-docs/src/site/apt/user_guides/release/perform.apt?rev=899465&r1=899464&r2=899465&view=diff
==============================================================================
--- continuum/trunk/continuum-docs/src/site/apt/user_guides/release/perform.apt (original)
+++ continuum/trunk/continuum-docs/src/site/apt/user_guides/release/perform.apt Thu Jan 14 23:24:16 2010
@@ -4,13 +4,13 @@
Perform Release
- Choose "Perform Release" and the version number
+ Choose <<Perform Release>> and the version number
[../../images/release-choose-perform-goal.png]
Fill in the form and click <<Submit>>
-
- To specify a different Maven goal to execute during the release, fill in the <<<Maven Arguments>>> field with another goal.
+
+ To specify a different Maven goal to execute during the release, fill in the <<Maven Arguments>> field with another goal.
By default, the goal for this field is <<<clean deploy>>>.
[../../images/release-perform-parameters.png]
Modified: continuum/trunk/continuum-docs/src/site/apt/user_guides/release/prepare.apt
URL: http://svn.apache.org/viewvc/continuum/trunk/continuum-docs/src/site/apt/user_guides/release/prepare.apt?rev=899465&r1=899464&r2=899465&view=diff
==============================================================================
--- continuum/trunk/continuum-docs/src/site/apt/user_guides/release/prepare.apt (original)
+++ continuum/trunk/continuum-docs/src/site/apt/user_guides/release/prepare.apt Thu Jan 14 23:24:16 2010
@@ -4,31 +4,31 @@
Prepare for Release
- Navigate to the Project Group Summary and click the Release button or icon.
+ Navigate to the <<Project Group Summary>> and click the <<Release>> button or icon.
[../../images/release-project-group-summary.png] Release
- Choose "Prepare project for release" and click "Submit"
+ Choose <<Prepare project for release>> and click <<Submit>>.
[../../images/release-choose-prepare-goal.png] Release
- Complete the form, providing the scm tag name, etc.
+ Complete the form, providing the SCM tag name, etc.
- Check the 'Use edit mode' checkbox if you are using a SCM system that requires you to obtain a lock before editing.
+ Check the <<Use edit mode>> checkbox if you are using an SCM system that requires you to obtain a lock before editing.
- Click Submit.
+ Click <<Submit>>.
[../../images/release-prepare-parameters.png] Release Prepare parameters
- Wait for the process to complete, then click Done.
-
- <<WARNING>> Hitting the <<<Rollback>>> button does not roll back or delete the SCM tag created during the '<<<scm-tag>>>' phase.
+ Wait for the process to complete, then click <<Done>>.
+
+ <<Note:>> Hitting the <<Rollback>> button does not roll back or delete the SCM tag created during the <<<scm-tag>>> phase.
So when re-doing the release prepare of the same version, make sure that the tag does not exist in SVN, if so,
the tag should be manually deleted.
[../../images/release-prepare-executing.png]
- You will be returned to this page to make another selection
+ You will be returned to this page to make another selection.
[../../images/release-choose-perform-goal.png]
Modified: continuum/trunk/continuum-docs/src/site/apt/user_guides/release/release_results.apt
URL: http://svn.apache.org/viewvc/continuum/trunk/continuum-docs/src/site/apt/user_guides/release/release_results.apt?rev=899465&r1=899464&r2=899465&view=diff
==============================================================================
--- continuum/trunk/continuum-docs/src/site/apt/user_guides/release/release_results.apt (original)
+++ continuum/trunk/continuum-docs/src/site/apt/user_guides/release/release_results.apt Thu Jan 14 23:24:16 2010
@@ -7,8 +7,10 @@
Release Results Management
- <<Release Results>> tab from the <<Project Information>> page displays all the release results of a
- project when executing release goals prepare and perform.
+ The <<Release Results>> tab from the <<Project Information>> page displays all the release results of a
+ project when executing the release goals prepare and perform.
+
+~~TODO What does the last part of the above mean?
[../../images/release_result-1.png] Release Results page
Modified: continuum/trunk/continuum-docs/src/site/apt/user_guides/viewing_queues/index.apt
URL: http://svn.apache.org/viewvc/continuum/trunk/continuum-docs/src/site/apt/user_guides/viewing_queues/index.apt?rev=899465&r1=899464&r2=899465&view=diff
==============================================================================
--- continuum/trunk/continuum-docs/src/site/apt/user_guides/viewing_queues/index.apt (original)
+++ continuum/trunk/continuum-docs/src/site/apt/user_guides/viewing_queues/index.apt Thu Jan 14 23:24:16 2010
@@ -8,10 +8,10 @@
Viewing Queues
- Click the <<Queues>> link under the <<Administration>> section
+ Click the <<Queues>> link under the <<Administration>> section.
[../../images/queues.png] Queues
- You can only view the current checkout, current prepare build, current build, checkout queues, prepare build queues and build queues.
-
-[../../images/queues-view.png] Queues View
+ You can only view the current checkout, current prepare build, current build, checkout queues, prepare build queues and build queues.
+
+[../../images/queues-view.png] Queues View