continuum-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From eveni...@apache.org
Subject svn commit: r385627 - in /maven/continuum/trunk/continuum-site/src/site: apt/guides/getting-started/index.apt apt/guides/mini/guide-configuration.apt apt/guides/mini/guide-linux-boot.apt apt/upgrade.apt fml/about.fml fml/faqs.fml
Date Mon, 13 Mar 2006 19:29:05 GMT
Author: evenisse
Date: Mon Mar 13 11:29:03 2006
New Revision: 385627

URL: http://svn.apache.org/viewcvs?rev=385627&view=rev
Log:
[CONTINUUM-506] Fix typos and formatting in site docs and add faq entry about changing ports
Submitted by Dennis Lundberg

Modified:
    maven/continuum/trunk/continuum-site/src/site/apt/guides/getting-started/index.apt
    maven/continuum/trunk/continuum-site/src/site/apt/guides/mini/guide-configuration.apt
    maven/continuum/trunk/continuum-site/src/site/apt/guides/mini/guide-linux-boot.apt
    maven/continuum/trunk/continuum-site/src/site/apt/upgrade.apt
    maven/continuum/trunk/continuum-site/src/site/fml/about.fml
    maven/continuum/trunk/continuum-site/src/site/fml/faqs.fml

Modified: maven/continuum/trunk/continuum-site/src/site/apt/guides/getting-started/index.apt
URL: http://svn.apache.org/viewcvs/maven/continuum/trunk/continuum-site/src/site/apt/guides/getting-started/index.apt?rev=385627&r1=385626&r2=385627&view=diff
==============================================================================
--- maven/continuum/trunk/continuum-site/src/site/apt/guides/getting-started/index.apt (original)
+++ maven/continuum/trunk/continuum-site/src/site/apt/guides/getting-started/index.apt Mon
Mar 13 11:29:03 2006
@@ -37,8 +37,8 @@
 
  If there is a <<<<modules>>>> element inside the POM continuum will
try to
  download the child projects by adding the module name to the end of the url.
- This makes it very easy to add a entire project to Continuum if you list all
- the child projects insode the POM.
+ This makes it very easy to add an entire project to Continuum if you list all
+ the child projects inside the POM.
 
  If you are using ViewCVS you can add your project with a url like this:
 
@@ -63,7 +63,7 @@
 
  []
 
- The notifiers is configured inside the <<<<ciManagement>>>> section
of the POM
+ The notifiers are configured inside the <<<<ciManagement>>>> section
of the POM
  like this:
 
 +--+
@@ -107,10 +107,10 @@
 
 * Adding Maven 1 Projects
 
- Adding a Maven 1 it pretty much like adding a Maven 2 project, pass it an URL
+ Adding a Maven 1 project is pretty much like adding a Maven 2 project, pass 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
+ There 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

Modified: maven/continuum/trunk/continuum-site/src/site/apt/guides/mini/guide-configuration.apt
URL: http://svn.apache.org/viewcvs/maven/continuum/trunk/continuum-site/src/site/apt/guides/mini/guide-configuration.apt?rev=385627&r1=385626&r2=385627&view=diff
==============================================================================
--- maven/continuum/trunk/continuum-site/src/site/apt/guides/mini/guide-configuration.apt
(original)
+++ maven/continuum/trunk/continuum-site/src/site/apt/guides/mini/guide-configuration.apt
Mon Mar 13 11:29:03 2006
@@ -22,20 +22,20 @@
   * <<<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
+    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
+ * The <<<RecipientSource>>> is the component that decides who should receive
+   the email. The only thing that can be configured here is an 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
+ * The <<<MailSender>>> 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.
@@ -78,7 +78,7 @@
  This is a example configuration on how to configure Jetty with one normal HTTP
  listener and one proxy HTTP listener. With this configuration Jetty will
  listen on two ports; 8080 and 8090. Continuum can be used from either
- http://localhost:8080 or http://www.company.com/continuum. Note that the
+ <<<http://localhost:8080/continuum>>> or <<<http://www.company.com/continuum>>>.
Note that the
  proxying listener will make Continuum write out URLs with the configured proxy
  host and port.
 
@@ -107,9 +107,9 @@
 </service>
 +----+
 
-** Example Apache Configuration
+** Example Apache httpd Configuration
  
- This is a example configuration on how to configure Apache to work as a front
+ This is a example configuration on how to configure Apache httpd to work as a front
  end to Continuum. Make sure <<<mod_proxy>>> is installed and loaded and
that
  Jetty is configured with a proxy HTTP listener on the proxy port.
 

Modified: 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=385627&r1=385626&r2=385627&view=diff
==============================================================================
--- maven/continuum/trunk/continuum-site/src/site/apt/guides/mini/guide-linux-boot.apt (original)
+++ maven/continuum/trunk/continuum-site/src/site/apt/guides/mini/guide-linux-boot.apt Mon
Mar 13 11:29:03 2006
@@ -9,32 +9,32 @@
 
 * 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
+ This document explains how to setup Continuum to start automatically (when the machine boots)
+ on linux. This is a procedure quite typical 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.
+ and all procedures (typically with some slight modification on directories paths) should
apply.
 
 * Prerequisites
 
- * Download continuum from {{{../../download.html}here}}.
+ * Download Continuum from {{{../../download.html}here}}.
  
- * extract the archive in <<</usr/local>>>
+ * Extract the archive in <<</usr/local>>>
 
-* Configuring continuum in init
+* 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.
+ 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-[VERSION]/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
+ 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:
 
@@ -42,7 +42,7 @@
 update-rc.d -n continuum defaults 80
 +--+
 
- If just copypasted this command, you will see something like this:
+ If you run this command, you will see something like this:
 
 +--+
  Adding system startup for /etc/init.d/continuum ...
@@ -55,6 +55,6 @@
    /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. 
+ What you see is the symlinks that would be created. The above command didn't do anything
+ because of the <<<-n>>> switch, remove it to get the real links created.

 

Modified: maven/continuum/trunk/continuum-site/src/site/apt/upgrade.apt
URL: http://svn.apache.org/viewcvs/maven/continuum/trunk/continuum-site/src/site/apt/upgrade.apt?rev=385627&r1=385626&r2=385627&view=diff
==============================================================================
--- maven/continuum/trunk/continuum-site/src/site/apt/upgrade.apt (original)
+++ maven/continuum/trunk/continuum-site/src/site/apt/upgrade.apt Mon Mar 13 11:29:03 2006
@@ -13,7 +13,7 @@
 
 * 1.0.1 to 1.0.2
 
-  Since there is no changes in database schema, the migration steps are mainly to replace
Continuum 1.0.2's database 
+  Since there are no changes in the database schema, the migration steps are mainly to replace
Continuum 1.0.2's database 
   with Continuum 1.0.1's database.  Here are detailed instructions:
   
   * Shutdown your Continuum 1.0.1.  
@@ -23,19 +23,19 @@
   * Initialize your Continuum 1.0.2 by starting it from command line, wait for it to complete
the initialization,
     and then shut it down.
     
-  * Replace Continuum 1.0.2's apps/continuum/conf/application.xml with Continuum 1.0.1's
apps/continuum/conf/application.xml.
-    Edit application.xml to replace any reference of 1.0.1 to become to 1.0.2.
+  * Replace Continuum 1.0.2's <<<apps/continuum/conf/application.xml>>>
with Continuum 1.0.1's <<<apps/continuum/conf/application.xml>>>.
+    Edit application.xml and replace any reference of 1.0.1 with 1.0.2.
     
-  * Replace Continuum 1.0.2's apps/continuum/database with Continuum 1.0.1's apps/continuum/database.
+  * Replace Continuum 1.0.2's <<<apps/continuum/database>>> with Continuum
1.0.1's <<<apps/continuum/database>>>.
   
   * Start your Continuum 1.0.2. 
   
   * Login and change "Working Directory" and "Build Output Directory" if needed. If you use
default values for these directories,
-    you only need to copy them from apps/continuum/.
+    you only need to copy them from <<<apps/continuum/>>>.
   
   []
   
-  If you have Continuum running as UNIX daemon or Windows NT service, make sure to modify
the configuration 
+  If you have Continuum running as UNIX daemon or Windows NT service, make sure you modify
the configuration 
   to point to new Continuum.
   
-  
\ No newline at end of file
+  

Modified: maven/continuum/trunk/continuum-site/src/site/fml/about.fml
URL: http://svn.apache.org/viewcvs/maven/continuum/trunk/continuum-site/src/site/fml/about.fml?rev=385627&r1=385626&r2=385627&view=diff
==============================================================================
--- maven/continuum/trunk/continuum-site/src/site/fml/about.fml (original)
+++ maven/continuum/trunk/continuum-site/src/site/fml/about.fml Mon Mar 13 11:29:03 2006
@@ -60,7 +60,7 @@
           in the <i>Channel</i> box).
         </p>
         <p>
-          Please remember that is is a preview release, so please be patient with features
that are not yet implemented,
+          Please remember that it is a preview release, so please be patient with features
that are not yet implemented,
           and be prepared to do some research and to help out yourself wherever possible.
         </p>
       </answer>
@@ -93,18 +93,28 @@
         </p>
         <p>
           To checkout the continuum-site project from the ASF Subversion repository, download
the Subversion client for
-          your platform and run: <code>svn co http://svn.apache.org/repos/asf/maven/continuum/trunk/continuum-site</code>
+          your platform and run:
+          <source>
+svn co http://svn.apache.org/repos/asf/maven/continuum/trunk/continuum-site
+          </source>
         </p>
         <p>
           To build the continuum-site project you will need to use Maven 2.  You can download
Maven 2 from the <a 
           href="http://maven.apache.org/maven2/download.html">Downloads page on the Maven
2 project site</a>.  Once you
           have installed Maven 2 and added it to your <code>PATH</code>, you
can build the Continuum project site by
-          executing the <code>site:site</code> goal with the following command:
<code>m2 site:site</code>.
+          executing the <code>site:site</code> goal with the following command:
+          <source>
+mvn site:site
+          </source>
           After executing the <code>site:site</code> goal, the Continuum site
will be stored in the
           <code>target/site</code> directory.
         </p>
         <p>
-          Once you have updated the documentation, generate a patch by running <code>svn
diff > site-patch.txt</code>.  Create a
+          Once you have updated the documentation, generate a patch by running
+          <source><![CDATA[
+svn diff > site-patch.txt
+          ]]></source>
+          Create a
           new issue in the Continuum JIRA project, and attach your patch to this issue. 
Before submitting the patch, make sure
           to build the Continuum site locally and proofread for any typos.
         </p>

Modified: maven/continuum/trunk/continuum-site/src/site/fml/faqs.fml
URL: http://svn.apache.org/viewcvs/maven/continuum/trunk/continuum-site/src/site/fml/faqs.fml?rev=385627&r1=385626&r2=385627&view=diff
==============================================================================
--- maven/continuum/trunk/continuum-site/src/site/fml/faqs.fml (original)
+++ maven/continuum/trunk/continuum-site/src/site/fml/faqs.fml Mon Mar 13 11:29:03 2006
@@ -6,7 +6,7 @@
         <p>
           If you want to add a project that extends an other, you must add the parent project.
           When you add a project with sub-projects, Continuum will add all sub-projects,
so you
-          need to provide an URL instead to uploading a POM so that Continuum can find all
sub-projects.
+          need to provide a URL instead of uploading a POM so that Continuum can find all
sub-projects.
         </p>
       </answer>
     </faq>
@@ -14,9 +14,9 @@
       <question>How can I add my maven 2 project with modules?</question>
       <answer>
         <p>
-          If your project has modules, you need to provide an URL instead of uploading a
POM.
+          If your project has modules, you need to provide a URL instead of uploading a POM.
           When you add a project with modules, Continuum will add all sub-projects, and this
-          only works by submitting an URL.
+          only works by submitting a URL.
         </p>
       </answer>
     </faq>
@@ -27,21 +27,24 @@
           Continuum uses the command line return code for detecting a successful or failed
execution.
         </p>
         <p>
-          If you use maven or ant, you need to add at the end of maven.bat and ant.bat, the
following line :
+          If you use maven or ant, you need to add the following line at the end of <code>maven.bat</code>
and <code>ant.bat</code> :
         </p>
         <source>
-if "%MAVEN_TERMINATE_CMD%" == "on" exit %ERROR_CODE%
+if "%MAVEN_TERMINATE_CMD%" == "on" exit %ERRORLEVEL%
         </source>
         <p>
-        If your bat file contains at the end an exit /B, this line must be copy before it.
-        You must add too, at the begin of $CONTINUUM/bin/win32/run.bat, the following lines
if you run Continuum from command line :
+        If your bat file contains an <code>exit /B</code> at the end, this line
must be inserted before it.
+        </p>
+        <p>
+        <b>This part is for Continuum &lt; 1.0.2</b>
+        You must also add the following lines at the begin of <code>$CONTINUUM/bin/win32/run.bat</code>,
if you run Continuum from the command line :
         </p>
         <source>
 @echo off
 set MAVEN_TERMINATE_CMD=on
         </source>
         <p>
-        or this line in wrapper.conf, if you run Continuum as a service (works too with command
line) :
+        or this line in <code>wrapper.conf</code>, if you run Continuum as a
service (works with command line too) :
         </p>
         <source>
 set.MAVEN_TERMINATE_CMD=on
@@ -55,13 +58,13 @@
       <question>Can i use file protocol in Add Project view?</question>
       <answer>
         <p>
-          File protocol is disabled by default for security reasons. You can allow it in
$CONTINUUM_HOME/apps/continuum/conf/application.xml
+          File protocol is disabled by default for security reasons. You can allow it in
<code>$CONTINUUM_HOME/apps/continuum/conf/application.xml</code>
         </p>
         <p>
           Uncomment the following line :
         </p>
         <source><![CDATA[
-          <allowedScheme implementation="java.lang.String">file</allowedScheme>
+<allowedScheme implementation="java.lang.String">file</allowedScheme>
         ]]></source>
       </answer>
     </faq>
@@ -70,14 +73,14 @@
       <answer>
         <p>
         You're probably running the CVSNT client, or another application based on it, like
TortoiseCVS. CVSNT stores passwords in the registry,
-        rather than the ~/.cvspass file. You'll need to issue the following command manually
(but only once), with the appropriate information filled in:
+        rather than the <code>~/.cvspass</code> file. You'll need to issue the
following command manually (but only once), with the appropriate information filled in:
         </p>
         <source>
 cvs -d :pserver:account@cvsserver:2401:/rootfolder login
         </source>
         <p>
         Also, note that the login will only be saved for the particular user who typed it.
If you're running Continuum as a service, double-check the user
-        it is running as, and make sure that you run cvs login as that user.
+        it is running as, and make sure that you run <code>cvs login</code> as
that user.
         </p>
       </answer>
     </faq>
@@ -94,7 +97,7 @@
       </answer>
     </faq>
     <faq id="builds-keep-failing-because-continuum-cant-checkout-sources">
-      <question>Why Continuum builds keep failing with password is required even if
I'm using anonymous or no password in CVS?</question>
+      <question>Why does Continuum builds keep failing with password is required even
if I'm using anonymous or no password in CVS?</question>
       <answer>
         <p>
           If you keep getting this build error on your projects:
@@ -125,6 +128,46 @@
         </p>
       </answer>
     </faq>
-
+    <faq id="How-can-I-run-continuum-on-a-different-port">
+      <question>How can I run Continuum on a different port? I already have application
X running on port 8000/8080.</question>
+      <answer>
+        <p>
+          Continuum uses two ports. Port 8000 is used for XML-RPC calls and port 8080 is
used by the instance of Jetty that supplies the web interface for Continuum.
+        </p>
+        <p>
+          If you have another application already running on port 8000/8080, you will get
an exception when you start Continuum.
+          If you want to change the port that Continuum uses you should edit the file <code>apps/continuum/conf/application.xml</code>.
+          Find the following section in that file:
+        </p>
+        <source><![CDATA[
+<application>
+  ...
+  <services>
+    <service>
+      <id>jetty</id>
+      <configuration>
+        <webapps>
+          <webapp>
+            <file>${plexus.home}/lib/continuum-web-1.0.2.jar</file>
+            <context>/continuum</context>
+            <extraction-path>${plexus.home}/webapp</extraction-path>
+            <listeners>
+              <http-listener>
+                <port>8080</port>	
+  ...
+    <service>
+      <id>xml-rpc</id>
+      <configuration>
+        <xmlrpc>
+          <port>8000</port>
+  ...
+        ]]></source>
+        <p>
+          Change the appropriate <code>&lt;port&gt;</code> elements to
the port numbers you want for jetty and xml-rpc.
+          You need to restart Continuum for the changes to take effect.
+        </p>
+      </answer>
+    </faq>
+  
   </part>
 </faqs>



Mime
View raw message