You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@continuum.apache.org by jv...@apache.org on 2005/10/26 05:13:21 UTC
svn commit: r328543 - in /maven/continuum/trunk/continuum-site/src/site:
apt/guides/index.apt apt/guides/mini/guide-linux-boot.apt
apt/guides/mini/guide-soap-api.apt apt/guides/mktoc.sh apt/linux-boot.apt
apt/soap-api.apt site.xml
Author: jvanzyl
Date: Tue Oct 25 20:13:16 2005
New Revision: 328543
URL: http://svn.apache.org/viewcvs?rev=328543&view=rev
Log:
o moving into the same structure as the m2 site
Added:
maven/continuum/trunk/continuum-site/src/site/apt/guides/index.apt (with props)
maven/continuum/trunk/continuum-site/src/site/apt/guides/mini/guide-linux-boot.apt (with props)
maven/continuum/trunk/continuum-site/src/site/apt/guides/mini/guide-soap-api.apt (with props)
maven/continuum/trunk/continuum-site/src/site/apt/guides/mktoc.sh (with props)
Removed:
maven/continuum/trunk/continuum-site/src/site/apt/linux-boot.apt
maven/continuum/trunk/continuum-site/src/site/apt/soap-api.apt
Modified:
maven/continuum/trunk/continuum-site/src/site/site.xml
Added: maven/continuum/trunk/continuum-site/src/site/apt/guides/index.apt
URL: http://svn.apache.org/viewcvs/maven/continuum/trunk/continuum-site/src/site/apt/guides/index.apt?rev=328543&view=auto
==============================================================================
--- maven/continuum/trunk/continuum-site/src/site/apt/guides/index.apt (added)
+++ maven/continuum/trunk/continuum-site/src/site/apt/guides/index.apt Tue Oct 25 20:13:16 2005
@@ -0,0 +1,30 @@
+ ------
+ Summary of Continuum 1.x documentation
+ ------
+ Jason van Zyl
+ ------
+ 12 October 2005
+ ------
+
+Documentation
+
+* Getting Started Guide
+
+ * {{{getting-started/index.html}Getting Started Guide}}
+
+* Mini Guides
+
+ * {{{mini/guide-configuration.html}Guide to Configuring Continuum}}
+
+ * {{{mini/guide-linux-boot.html}Guide to Configuring Continuum to start automatically on Linux}}
+
+ * {{{mini/guide-soap-api.html}Guide to using the SOAP API}}
+
+
+* Introductory Material
+
+
+* Development Guides
+
+ * {{{development/guide-build-continuum.html}Guide to Building Continuum}}
+
Propchange: maven/continuum/trunk/continuum-site/src/site/apt/guides/index.apt
------------------------------------------------------------------------------
svn:eol-style = native
Propchange: maven/continuum/trunk/continuum-site/src/site/apt/guides/index.apt
------------------------------------------------------------------------------
svn:keywords = "Author Date Id Revision"
Added: maven/continuum/trunk/continuum-site/src/site/apt/guides/mini/guide-linux-boot.apt
URL: http://svn.apache.org/viewcvs/maven/continuum/trunk/continuum-site/src/site/apt/guides/mini/guide-linux-boot.apt?rev=328543&view=auto
==============================================================================
--- maven/continuum/trunk/continuum-site/src/site/apt/guides/mini/guide-linux-boot.apt (added)
+++ maven/continuum/trunk/continuum-site/src/site/apt/guides/mini/guide-linux-boot.apt Tue Oct 25 20:13:16 2005
@@ -0,0 +1,60 @@
+ ------
+ Guide to Configuring Continuum to start automatically on Linux
+ ------
+ Miguel Griffa
+ ------
+ Mon Oct 11 2005
+
+Configuring Continuum to start automatically on Linux 2
+
+* Introduction
+
+ This document explains how to setup continuum to start automatically (when the machine boots)
+ in linux. This is a procedure quite tipical for a linux system administrator, the
+ purpose of this document is to help you in case you don't have a linux sysadmin
+ at hand.
+
+ This document is based on Debian GNU/Linux, all concepts should apply to other distributions
+ and all procedures (tipically with some slight modificacion on directories paths) should apply.
+
+* Prerequisites
+
+ * Download continuum from {{{download.html}here}}.
+
+ * extract the archive in <<</usr/local>>>
+
+* Configuring continuum in init
+
+ 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:
+
++--+
+ln -s /usr/local/continuum-1.0-beta-1/bin/linux/run.sh /etc/init.d/continuum
++--+
+
+ At this point you have continuum ready to be symlinked from different runlevels. This might
+ sound a bit esoteric, but it is not, you find very fast these words 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:
+
++--+
+update-rc.d -n continuum defaults 80
++--+
+
+ If just copypasted this command, you will see something like this:
+
++--+
+ Adding system startup for /etc/init.d/continuum ...
+ /etc/rc0.d/K80continuum -> ../init.d/continuum
+ /etc/rc1.d/K80continuum -> ../init.d/continuum
+ /etc/rc6.d/K80continuum -> ../init.d/continuum
+ /etc/rc2.d/S80continuum -> ../init.d/continuum
+ /etc/rc3.d/S80continuum -> ../init.d/continuum
+ /etc/rc4.d/S80continuum -> ../init.d/continuum
+ /etc/rc5.d/S80continuum -> ../init.d/continuum
++--+
+
+ What you see is the symlinks that would be created. The above command didn't do anything that's
+ because the <<<-n>>> switch, remove it to get the real links creted.
+
Propchange: maven/continuum/trunk/continuum-site/src/site/apt/guides/mini/guide-linux-boot.apt
------------------------------------------------------------------------------
svn:eol-style = native
Propchange: maven/continuum/trunk/continuum-site/src/site/apt/guides/mini/guide-linux-boot.apt
------------------------------------------------------------------------------
svn:keywords = "Author Date Id Revision"
Added: maven/continuum/trunk/continuum-site/src/site/apt/guides/mini/guide-soap-api.apt
URL: http://svn.apache.org/viewcvs/maven/continuum/trunk/continuum-site/src/site/apt/guides/mini/guide-soap-api.apt?rev=328543&view=auto
==============================================================================
--- maven/continuum/trunk/continuum-site/src/site/apt/guides/mini/guide-soap-api.apt (added)
+++ maven/continuum/trunk/continuum-site/src/site/apt/guides/mini/guide-soap-api.apt Tue Oct 25 20:13:16 2005
@@ -0,0 +1,101 @@
+ ------
+ Guide to using the SOAP API
+ ------
+ Dan Diephouse
+ ------
+ Fri Jul 8 2005
+
+Getting Started
+
+ Continuum has a SOAP API which makes it easy to add, remove, view and manipulate
+ builds from within your applications. Continuum includes a client to access this
+ API. Alternatively, you may generate a client from favorite SOAP toolkit
+ (such as the toolkits for PERL or .NET) using the WSDL found at
+ {{http://localhost:8080/continuum/services/Continuum?wsdl}}. If you are using a
+ client other than the one mentioned below, the code should be roughly the same.
+
+ The API provides the following operations:
+
+ * addProject
+
+ * getProject
+
+ * remoteProject
+
+ * updateProject
+
+ * checkoutProject
+
+ * removeProject
+
+ * getLatestBuild
+
+ * getCheckOutScmResult
+
+Using the Bundled Java Client
+
+* Creating a Client
+
++--+
+import org.apache.maven.continuum.xfire.ContinuumWebService;
+import org.apache.maven.continuum.xfire.ContinuumClientFactory;
+import org.apache.maven.continuum.xfire.Project;
+import org.apache.maven.continuum.xfire.Build;
+import org.apache.maven.continuum.project.ContinuumProjectState;
+
+...
+
+String url = "http://localhost:8080/continuum/services/Continuum";
+ContinuumWebService continuum = ContinuumClientFactory.createClient( url );
++--+
+
+* Adding A Project
+
++--+
+Project project = new Project();
+project.setType("maven2");
+project.setScmUrl("scm:svn....");
+
+continuum.addProject(project);
++--+
+
+ The project type tells Continuum what type of project to expect. Valid values are
+ "ant", "shell", "maven-1", and "maven2".
+
+* Getting the latest build
+
++--+
+Build build = continuum.getLatestBuild(project.getId());
+
+if ( build.getState() == ContinuumProjectState.OK )
+{
+ doSomething();
+}
+else if ( build.getState() == ContinuumProjectState.FAILED )
+{
+ punishDevelopers();
+}
++--+
+
+Notes for other Toolkits
+
+* Project State
+
+ In one of the above code snippets, you see that we can check the build state.
+ The build state can be one of several values:
+
+*---*------------------------+
+| 1 | New Build |
+*---*------------------------+
+| 2 | Successful Build |
+*---*------------------------+
+| 3 | Failed Build |
+*---*------------------------+
+| 4 | Error building |
+*---*------------------------+
+| 6 | Build in process |
+*---*------------------------+
+| 7 | Checking out from SCM |
+*---*------------------------+
+| 8 | Updating from SCM |
+*---*------------------------+
Propchange: maven/continuum/trunk/continuum-site/src/site/apt/guides/mini/guide-soap-api.apt
------------------------------------------------------------------------------
svn:eol-style = native
Propchange: maven/continuum/trunk/continuum-site/src/site/apt/guides/mini/guide-soap-api.apt
------------------------------------------------------------------------------
svn:keywords = "Author Date Id Revision"
Added: maven/continuum/trunk/continuum-site/src/site/apt/guides/mktoc.sh
URL: http://svn.apache.org/viewcvs/maven/continuum/trunk/continuum-site/src/site/apt/guides/mktoc.sh?rev=328543&view=auto
==============================================================================
--- maven/continuum/trunk/continuum-site/src/site/apt/guides/mktoc.sh (added)
+++ maven/continuum/trunk/continuum-site/src/site/apt/guides/mktoc.sh Tue Oct 25 20:13:16 2005
@@ -0,0 +1,85 @@
+#!/bin/sh
+
+toc=`pwd`/index.apt
+
+find . -name '*~' -exec rm -rf {} \;
+
+#
+# Top matter
+#
+
+echo " ------ " > $toc
+echo " Summary of Continuum 1.x documentation " >> $toc
+echo " ------ " >> $toc
+echo " Jason van Zyl " >> $toc
+echo " ------ " >> $toc
+echo " 12 October 2005 " >> $toc
+echo " ------ " >> $toc
+echo >> $toc
+echo "Documentation" >> $toc
+echo >> $toc
+
+#
+# Getting started guide
+#
+
+echo "* Getting Started Guide" >> $toc
+echo >> $toc
+echo " * {{{getting-started/index.html}Getting Started Guide}}" >> $toc
+
+#
+# Mini Guides
+#
+
+echo >> $toc
+echo "* Mini Guides" >> $toc
+echo >> $toc
+
+(
+ cd mini
+
+ for i in `ls -d guide-*`
+ do
+ if [ -d $i ]
+ then
+ (
+ cd $i
+ title=`grep "^ *Guide" ${i}.apt | sed 's/^ *//'`
+ i=`echo $i | sed 's/\.apt/\.html/'`
+ [ ! -z "$title" ] && echo " * {{{mini/$i/$i.html}$title}}" >> $toc && echo >> $toc
+ )
+ else
+ title=`grep "^ Guide" $i | sed 's/^ *//'`
+ i=`echo $i | sed 's/\.apt/\.html/'`
+ [ ! -z "$title" ] && echo " * {{{mini/$i}$title}}" >> $toc && echo >> $toc
+ fi
+
+ done
+)
+
+#
+# Introductions
+#
+
+echo >> $toc
+echo "* Introductory Material" >> $toc
+echo >> $toc
+
+#
+# Developer Guides
+#
+
+echo >> $toc
+echo "* Development Guides" >> $toc
+echo >> $toc
+
+(
+ cd development
+
+ for i in `ls guide-*.apt`
+ do
+ title=`grep "^ Guide" $i | sed 's/^ *//'`
+ i=`echo $i | sed 's/\.apt/\.html/'`
+ [ ! -z "$title" ] && echo " * {{{development/$i}$title}}" >> $toc && echo >> $toc
+ done
+)
Propchange: maven/continuum/trunk/continuum-site/src/site/apt/guides/mktoc.sh
------------------------------------------------------------------------------
svn:eol-style = native
Propchange: maven/continuum/trunk/continuum-site/src/site/apt/guides/mktoc.sh
------------------------------------------------------------------------------
svn:executable = *
Propchange: maven/continuum/trunk/continuum-site/src/site/apt/guides/mktoc.sh
------------------------------------------------------------------------------
svn:keywords = "Author Date Id Revision"
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=328543&r1=328542&r2=328543&view=diff
==============================================================================
--- maven/continuum/trunk/continuum-site/src/site/site.xml (original)
+++ maven/continuum/trunk/continuum-site/src/site/site.xml Tue Oct 25 20:13:16 2005
@@ -27,16 +27,6 @@
<item name="Documentation" href="/guides/index.html"/>
<item name="General Information" href="about.html"/>
<item name="Planned Features" href="planned-features.html"/>
- </menu>
-
- <menu name="User's Guide">
- <item name="Configuration" href="configuration.html"/>
- <item name="SOAP API" href="soap-api.html"/>
- <item name="Linux Boot Configuration " href="linux-boot.html"/>
- </menu>
-
- <menu name="Developer's Guide">
- <item name="Building" href="dev/building.html"/>
<item name="Change Log" href="change-log.html"/>
</menu>