continuum-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From tryg...@apache.org
Subject svn commit: r171099 - in /maven/continuum/trunk/continuum-site/src/site: ./ apt/ apt/dev/ apt/developer-info/ apt/releases/ fml/ xdoc/ xdoc/dev/
Date Fri, 20 May 2005 11:09:03 GMT
Author: trygvis
Date: Fri May 20 04:09:02 2005
New Revision: 171099

URL: http://svn.apache.org/viewcvs?rev=171099&view=rev
Log:
o Site cleanup. Converted most content to APT.

Added:
    maven/continuum/trunk/continuum-site/src/site/apt/configuration.apt
    maven/continuum/trunk/continuum-site/src/site/apt/dev/
    maven/continuum/trunk/continuum-site/src/site/apt/dev/building.apt
    maven/continuum/trunk/continuum-site/src/site/apt/download.apt
    maven/continuum/trunk/continuum-site/src/site/apt/getting-started.apt
    maven/continuum/trunk/continuum-site/src/site/apt/planned-features.apt
    maven/continuum/trunk/continuum-site/src/site/fml/
    maven/continuum/trunk/continuum-site/src/site/fml/about.fml
      - copied unchanged from r170910, maven/continuum/trunk/continuum-site/src/site/xdoc/about.fml
Removed:
    maven/continuum/trunk/continuum-site/src/site/apt/developer-info/
    maven/continuum/trunk/continuum-site/src/site/apt/faq.apt
    maven/continuum/trunk/continuum-site/src/site/apt/index.apt
    maven/continuum/trunk/continuum-site/src/site/apt/releases/
    maven/continuum/trunk/continuum-site/src/site/xdoc/about.fml
    maven/continuum/trunk/continuum-site/src/site/xdoc/configuration.xml
    maven/continuum/trunk/continuum-site/src/site/xdoc/dev/
    maven/continuum/trunk/continuum-site/src/site/xdoc/download.xml
    maven/continuum/trunk/continuum-site/src/site/xdoc/getting-started.xml
    maven/continuum/trunk/continuum-site/src/site/xdoc/index.xml
    maven/continuum/trunk/continuum-site/src/site/xdoc/navigation.xml
    maven/continuum/trunk/continuum-site/src/site/xdoc/planned-features.xml
Modified:
    maven/continuum/trunk/continuum-site/src/site/site.xml

Added: maven/continuum/trunk/continuum-site/src/site/apt/configuration.apt
URL: http://svn.apache.org/viewcvs/maven/continuum/trunk/continuum-site/src/site/apt/configuration.apt?rev=171099&view=auto
==============================================================================
--- maven/continuum/trunk/continuum-site/src/site/apt/configuration.apt (added)
+++ maven/continuum/trunk/continuum-site/src/site/apt/configuration.apt Fri May 20 04:09:02
2005
@@ -0,0 +1,60 @@
+ ------
+ Configuring Continuum
+ ------
+ Trygve Laugstøl
+ ------
+ Fri May 20 2005
+
+Configuring Continuum
+
+ The configuration file for Continuum is inside the Plexus runtime under
+ <<<apps/continuum/conf/application.xml>>>. <NOTE>: You have to start
and stop the application at least once before
+ configuring Continuum. This is required because the application container has to unpack
the application.
+
+* Mail Notification
+
+ There are three components used by the mail notification system in Continuum:
+
+ * The Mail notifier itself. There are three configurable properties:
+
+  * <<<from-mailbox>>> and <<<from-name>>>: The mailbox
and name that will be set as the <<<From>>> header for
+    all mails sent. It is important to ensure that the mailbox is a real account as most
SMTP servers will verify
+    that the mailbox actually exists before accepting the mail. If the from mailbox is empty
or not specified the
+    nag email address for the project will be used.
+
+  * <<<timestamp-format>>>: This is the timestamp format used for the dates
in email messages.
+
+ * The recipient source. This is the component that decides who should receive the email.
The only thing that
+   can be configured here is a address that will be used as the recipient for all email sent.
This configuration
+   is mostly useful for people who want to make sure all email is sent to a specific account
during testing or
+   development.
+
+ * The mail sender is the component that will send the email to the SMTP server. The two
properties that can be
+   configured are:
+
+  * <<<smtp-host>>>: The SMTP host. Make sure that this host will accept
email.
+
+  * <<<smtp-port>>>: The port to use on the SMTP host.
+
+* Alarm Trigger
+
+ The alarm trigger will trigger a build of all the projects on a timed interval.
+
+ * <<<interval>>>: The number of seconds between each round of scheduling.
+
+ * <<<delay>>>: The number of seconds to wait before starting the first
round of scheduling post startup.
+
+* Jetty Configuration
+
+ Jetty is configured in a special way as it's a service, not a component. The
+ only thing that should be changed in the Jetty configuration is the port and
+ that is done by changing the <<<port>>> tag in the <<<services>>>
section.
+
+* Socket Listeners
+
+ There are two services listening on sockets that can be configured:
+
+ * <<<url-registrar-server>>>: This registrar will read POM URLs for the
Maven 1.x and 2.x project builders.
+
+ * <<<simple-socket-trigger-server>>>: This registrar will read project
IDs off the wire and schedule a build for that project.
+

Added: maven/continuum/trunk/continuum-site/src/site/apt/dev/building.apt
URL: http://svn.apache.org/viewcvs/maven/continuum/trunk/continuum-site/src/site/apt/dev/building.apt?rev=171099&view=auto
==============================================================================
--- maven/continuum/trunk/continuum-site/src/site/apt/dev/building.apt (added)
+++ maven/continuum/trunk/continuum-site/src/site/apt/dev/building.apt Fri May 20 04:09:02
2005
@@ -0,0 +1,53 @@
+ ------
+ Building Continuum
+ ------
+ Trygve Laugstøl
+ ------
+ Fri May 20 2005
+
+Getting the sources
+
+ To get the sources from the Subversion repository use this SVN url:
+ <<<http://svn.apache.org/repos/asf/maven/continuum/tags/continuum-alpha-1>>>
+
+ If you are using the <<<svn>>> command line Subversion client you can
check out the sources with this command:
+
++--+
+$ svn co http://svn.apache.org/repos/asf/maven/continuum/tags/continuum-alpha-1/ continuum
++--+
+
+ All the Continuum Alpha 1 sources will be in a directory called <<<continuum>>>.
+
+ For more information on how to check out the sources see the information pages from Apache
+ {{{http://apache.org/dev/version-control.html}here}}.
+
+Building Continuum
+
+ <<NOTE:>> Continuum requires Maven 2 alpha 2 to build.
+
+ Continuum consists of 6 Maven 2 projects:
+
+ [continuum-model] is the object model that continuum uses.
+
+ [continuum-core] is Continuum's core. It contains all the code for checking out and building
the projects. It also
+                  contains the mail notifier and socket listeners.
+
+ [continuum-web] is the web interface for Continuum. It contains the form definitions used
in the web application
+                 and internationalization strings.
+
+ [continuum-xmlrpc] is the XML-RPC interface. It contains a single component that maps the
XML-RPC method calls
+                    to the core components.
+
+ [continuum-plexus-application] is a special project that mainly contains the configuration
files for Plexus when
+                                running Continuum as a Plexus application.
+
+ [continuum-core-it] is a integration tests written in Python. It uses the XML-RPC interface
to communicate with
+                     the Continuum instance.
+
+ []
+
+ The easiest way to build the entire Continuum project is to use the shell script from the
root of the check out like this:
+ 
++--+
+$ sh build.sh</source>
++--+

Added: maven/continuum/trunk/continuum-site/src/site/apt/download.apt
URL: http://svn.apache.org/viewcvs/maven/continuum/trunk/continuum-site/src/site/apt/download.apt?rev=171099&view=auto
==============================================================================
--- maven/continuum/trunk/continuum-site/src/site/apt/download.apt (added)
+++ maven/continuum/trunk/continuum-site/src/site/apt/download.apt Fri May 20 04:09:02 2005
@@ -0,0 +1,40 @@
+ ------
+ Download
+ ------
+ Trygve Laugstøl
+ ------
+ Fri May 20 2005
+
+Download Continuum 1.0 Technology Preview
+
+ Continuum is distributed in several formats for your convenience.
+
+ You will be prompted for a mirror - please be patient, as it may take 24 hours to reach
all mirrors.
+
+ * {{{http://www.apache.org/dyn/closer.cgi/maven/binaries/continuum-1.0-alpha-1-bin.tar.bz2}.tar.bz2}}
archive
+   ({{{http://www.apache.org/dist/maven/binaries/continuum-1.0-alpha-1-bin.tar.bz2.md5}checksum}}/{{{http://www.apache.org/dist/maven/binaries/continuum-1.0-alpha-1-bin.tar.bz2.asc}PGP}})
+
+ * {{{http://www.apache.org/dyn/closer.cgi/maven/binaries/continuum-1.0-alpha-1-bin.tar.gz}.tar.gz}}
archive
+   ({{{http://www.apache.org/dist/maven/binaries/continuum-1.0-alpha-1-bin.tar.gz.md5}checksum}}/{{{http://www.apache.org/dist/maven/binaries/continuum-1.0-alpha-1-bin.tar.gz.asc}PGP}})
+
+ * {{{http://www.apache.org/dyn/closer.cgi/maven/binaries/continuum-1.0-alpha-1-bin.zip}.zip}}
archive
+   ({{{http://www.apache.org/dist/maven/binaries/continuum-1.0-alpha-1-bin.zip.md5}checksum}}/{{{http://www.apache.org/dist/maven/binaries/continuum-1.0-alpha-1-bin.zip.asc}PGP}})
+
+ []
+
+ Continuum 1.0 is distributed under the {{{http://maven.apache.org/license.html}Apache License,
version 2.0}}.
+
+System Requirements
+
+*--*--*
+| JDK              | 1.4 or above |
+*--*--*
+| Memory           | No minimum requirement |
+*--*--*
+| Disk Space       | The Continuum application is in itself less than 10MB but might possibly
use more disk space when it's checking out and building sources.|
+*--*--*
+| Operating System | No minimum requirement. Tested on Windows XP, Debian, Fedora Core and
Mac OS X. |
+*--*--*
+
+ After downloading Continuum see the {{{getting-started.html}Getting Started}} document for
instructions on how
+ to install and start Continuum.

Added: maven/continuum/trunk/continuum-site/src/site/apt/getting-started.apt
URL: http://svn.apache.org/viewcvs/maven/continuum/trunk/continuum-site/src/site/apt/getting-started.apt?rev=171099&view=auto
==============================================================================
--- maven/continuum/trunk/continuum-site/src/site/apt/getting-started.apt (added)
+++ maven/continuum/trunk/continuum-site/src/site/apt/getting-started.apt Fri May 20 04:09:02
2005
@@ -0,0 +1,64 @@
+ ------
+ Getting Started
+ ------
+ Trygve Laugstøl
+ ------
+ Fri May 20 2005
+
+Installing Continuum
+
+ After you have downloaded and unpacked the bundle execute <<<bin/plexus.sh>>>
if you are on a UNIX platform or
+ <<<bin/plexus.bat>>> if you are using Windows.
+
+ When Continuum is running you can access it with your browser on {{http://localhost:8080}}
or by using the
+ XML-RPC interface on port 8000.
+
+Adding Projects to Continuum
+
+ 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 {{{planned-features.html#Asynchronous_checkouts}planned}}.
+
+* Adding Maven2 Projects
+
+ 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.
+
+* Adding Maven1 Projects
+
+ 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.
+
+ 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 <<<maven.xml>>>
to build all of
+ the projects. In subsequent versions of Continuum we will deal with Maven 1.x projects in
a cleaner way.
+
+* Adding Ant Projects
+
+ When adding Ant projects you have to specify the project's name, SCM URL, nag email address,
version and the
+ targets to execute.
+
+ <NOTE:> The SCM URL is a Maven SCM convention. Here's an example of what an SCM URL
looks like:
+ <<<scm:svn:http://svn.apache.org/repos/asf/maven/continuum/trunk>>>
+
+* Adding Shell Projects
+
+ When adding shell projects you have to specify the project's name, SCM URL, nag email address,
version and the
+ shell script to execute. The working directory of the project will be prepended to the scripts
path.
+
+ <NOTE:> The SCM URL is a Maven SCM convention. Here's an example of what an SCM URL
looks like:
+ <<<scm:svn:http://svn.apache.org/repos/asf/maven/continuum/trunk>>>
+
+Building Projects
+
+* Using the Web Interface
+
+ 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.
+
+* Using the XML-RPC Interface
+
+ By using the <<<continuum_cli.py>>> Python script you can remotely control
Continuum. Start the script by executing
+ <<<python continuum_cli.py>>> and write <<<help>>> to
list all available commands.
+
+ There is also a reusable Python library called <<<continuum.py>>> that
can be used to integrate remote control
+ over Continuum into other Python applications.

Added: maven/continuum/trunk/continuum-site/src/site/apt/planned-features.apt
URL: http://svn.apache.org/viewcvs/maven/continuum/trunk/continuum-site/src/site/apt/planned-features.apt?rev=171099&view=auto
==============================================================================
--- maven/continuum/trunk/continuum-site/src/site/apt/planned-features.apt (added)
+++ maven/continuum/trunk/continuum-site/src/site/apt/planned-features.apt Fri May 20 04:09:02
2005
@@ -0,0 +1,51 @@
+ ------
+ Planned Features
+ ------
+ Trygve Laugstøl
+ ------
+ Fri May 20 2005
+
+Planned Features for Continuum
+
+ If you would like to see support for a particular feature that is not listed here please
enter them in
+ {{{issue-tracking.html}JIRA}} or send a mail to the {{{mail-lists.html}mailing lists}}.
+
+* Notification
+
+ Support for notification through these mechanisms is planned:
+
+ * {{{http://jira.codehaus.org/browse/CONTINUUM-5}Jabber}}
+
+ * {{{http://jira.codehaus.org/browse/CONTINUUM-33}IRC}}
+
+* SCM Support
+
+ Continuum is using the Maven SCM library for checking out and getting updates from the SCM
the project is stored
+ in. Continuum currently only supports CVS and Subversion but support for these SCM is planned:
+
+ * ClearCase
+
+ * Perforce
+
+ * StarTeam
+
+ * Visual Source Safe
+
+* Build Scheduling
+
+ Currently it only supports builds on a regular interval and Continuum definitely needs better
build scheduling. There
+ are two major ways to do this:
+
+ [Push] something is triggering a build by telling Continuum to do so. Continuum already
supports this through
+        the socket listener that is listening for build IDs to build and through the XML-RPC
server.
+
+ [Pull] Continuum is looking for changes and schedules a build when something has changed.
This is useful for several
+        reasons: less resources used by useless builds and it's easier to use because there
is no need to configure
+        your SCM to push events to Continuum.
+
+* Asynchronous checkouts
+
+ 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 
+ {{{http://jira.codehaus.org/browse/CONTINUUM-60}JIRA issue}}.

Modified: maven/continuum/trunk/continuum-site/src/site/site.xml
URL: http://svn.apache.org/viewcvs/maven/continuum/trunk/continuum-site/src/site/site.xml?rev=171099&r1=171098&r2=171099&view=diff
==============================================================================
--- maven/continuum/trunk/continuum-site/src/site/site.xml (original)
+++ maven/continuum/trunk/continuum-site/src/site/site.xml Fri May 20 04:09:02 2005
@@ -1,31 +1,29 @@
-<?xml version="1.0" encoding="ISO-8859-1"?>
-<project name="Maven">
+<project name="Apache Maven Continuum">
   <bannerLeft>
-    <name>Continuum</name>
-    <href>http://continuum.codehaus.org</href>
+    <name>Apache Maven</name>
+    <href>http://maven.apache.org</href>
   </bannerLeft>
   <bannerRight>
-    <name>http://codehaus.org/codehaus-small.png</name>
-    <href>http://www.codehaus.org</href>
+    <name>Apache Maven Continuum</name>
+    <href>http://maven.apache.org/continuum</href>
   </bannerRight>
   <body>
     <links>
-      <item name="Continuum" href="http://continuum.codehaus.org"/>
-      <item name="The Codehaus" href="http://www.codehaus.org"/>
+      <item name="Maven 1" href="http://maven.apache.org"/>
+      <item name="Maven 2" href="http://maven.apache.org/maven2"/>
     </links>
-    <menu name="Quick Links">
-      <item name="FAQ" href="faq.html"/>
-      <item name="Latest Release" href="/releases/1-0-alpha-1/index.html"/>
+    <menu name="Continuum">
+      <item name="Introduction" href="index.html"/>
+      <item name="Download" href="download.html"/>
+      <item name="General Information" href="about.html"/>
+      <item name="Planned Features" href="planned-features.html"/>
     </menu>
-    <menu name="Overview">
-      <item name="Home" href="/index.html"/>
-      <item name="APT Test" href="/apt-test.html"/>
+    <menu name="User's Guide">
+      <item name="Getting Started" href="getting-started.html"/>
+      <item name="Configuration" href="configuration.html"/>
     </menu>
-    <menu name="Developer Info">
-      <item name="Bugtracker" href="http://jira.codehaus.org/browse/CONTINUUM"/>
-      <item name="Mailing Lists" href="/developer-info/mailing-lists.html"/>
-      <item name="Building" href="/developer-info/building.html"/>
-      <item name="The Team" href="/developer-info/team.html"/>
+    <menu name="Developer's Guide">
+      <item name="Building" href="dev/building.html"/>
     </menu>
   </body>
 </project>



Mime
View raw message