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:32:04 UTC

svn commit: r899470 - in /continuum/branches/continuum-1.3.x/continuum-docs/src/site/apt: installation/ user_guides/building_project/ user_guides/managing_project/

Author: dennisl
Date: Thu Jan 14 23:32:04 2010
New Revision: 899470

URL: http://svn.apache.org/viewvc?rev=899470&view=rev
Log:
Improve the documentation:
- Use upper case where it's appropriate

Modified:
    continuum/branches/continuum-1.3.x/continuum-docs/src/site/apt/installation/build-agent.apt
    continuum/branches/continuum-1.3.x/continuum-docs/src/site/apt/installation/geronimo.apt
    continuum/branches/continuum-1.3.x/continuum-docs/src/site/apt/installation/glassfish.apt
    continuum/branches/continuum-1.3.x/continuum-docs/src/site/apt/installation/jboss.apt
    continuum/branches/continuum-1.3.x/continuum-docs/src/site/apt/installation/jetty.apt
    continuum/branches/continuum-1.3.x/continuum-docs/src/site/apt/installation/standalone.apt
    continuum/branches/continuum-1.3.x/continuum-docs/src/site/apt/installation/tomcat.apt
    continuum/branches/continuum-1.3.x/continuum-docs/src/site/apt/installation/upgrade.apt
    continuum/branches/continuum-1.3.x/continuum-docs/src/site/apt/user_guides/building_project/index.apt
    continuum/branches/continuum-1.3.x/continuum-docs/src/site/apt/user_guides/managing_project/addProject.apt
    continuum/branches/continuum-1.3.x/continuum-docs/src/site/apt/user_guides/managing_project/editProject.apt

Modified: continuum/branches/continuum-1.3.x/continuum-docs/src/site/apt/installation/build-agent.apt
URL: http://svn.apache.org/viewvc/continuum/branches/continuum-1.3.x/continuum-docs/src/site/apt/installation/build-agent.apt?rev=899470&r1=899469&r2=899470&view=diff
==============================================================================
--- continuum/branches/continuum-1.3.x/continuum-docs/src/site/apt/installation/build-agent.apt (original)
+++ continuum/branches/continuum-1.3.x/continuum-docs/src/site/apt/installation/build-agent.apt Thu Jan 14 23:32:04 2010
@@ -51,7 +51,7 @@
 
     * <<<workingDirectory>>> - similar to the working directory of Continuum
 
-    * <<<continuumServerUrl>>> - the url pointing to the XML-RPC context of the Master Build Agent
+    * <<<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.
 

Modified: continuum/branches/continuum-1.3.x/continuum-docs/src/site/apt/installation/geronimo.apt
URL: http://svn.apache.org/viewvc/continuum/branches/continuum-1.3.x/continuum-docs/src/site/apt/installation/geronimo.apt?rev=899470&r1=899469&r2=899470&view=diff
==============================================================================
--- continuum/branches/continuum-1.3.x/continuum-docs/src/site/apt/installation/geronimo.apt (original)
+++ continuum/branches/continuum-1.3.x/continuum-docs/src/site/apt/installation/geronimo.apt Thu Jan 14 23:32:04 2010
@@ -79,13 +79,13 @@
 
     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.
+    <<<commons-lang 2.2>>> is required by Continuum and must be installed in the Geronimo repository.
 
     <<<org.jaxen.>>> needs to be added as a <<<\<filter\>>>> in the <<<\<hidden-classes\>>>> section because of {{{https://issues.apache.org/jira/browse/GERONIMO-3894}GERONIMO-3894}}
 
 * {Install Continuum}
 
-    To Install Continuum, you'll need the Continuum war and the deployment plan.
+    To Install Continuum, you'll need the Continuum WAR and the deployment plan.
 
     Look at {{{http://cwiki.apache.org/GMOxDOC20/installing-and-removing-applications.html}Installing and removing applications}} in Geronimo.
 

Modified: continuum/branches/continuum-1.3.x/continuum-docs/src/site/apt/installation/glassfish.apt
URL: http://svn.apache.org/viewvc/continuum/branches/continuum-1.3.x/continuum-docs/src/site/apt/installation/glassfish.apt?rev=899470&r1=899469&r2=899470&view=diff
==============================================================================
--- continuum/branches/continuum-1.3.x/continuum-docs/src/site/apt/installation/glassfish.apt (original)
+++ continuum/branches/continuum-1.3.x/continuum-docs/src/site/apt/installation/glassfish.apt Thu Jan 14 23:32:04 2010
@@ -25,7 +25,7 @@
 
 * {Install Continuum}
 
-    To Install Continuum, you'll need the Continuum war.
+    To Install Continuum, you'll need the Continuum WAR.
 
     Look at {{{https://glassfish.dev.java.net/downloads/quickstart/index.html#ProcedureTo_Deploy_From_the_Admin}Procedure To Deploy From the Admin Console}} in GlassFish.
 

Modified: continuum/branches/continuum-1.3.x/continuum-docs/src/site/apt/installation/jboss.apt
URL: http://svn.apache.org/viewvc/continuum/branches/continuum-1.3.x/continuum-docs/src/site/apt/installation/jboss.apt?rev=899470&r1=899469&r2=899470&view=diff
==============================================================================
--- continuum/branches/continuum-1.3.x/continuum-docs/src/site/apt/installation/jboss.apt (original)
+++ continuum/branches/continuum-1.3.x/continuum-docs/src/site/apt/installation/jboss.apt Thu Jan 14 23:32:04 2010
@@ -86,9 +86,9 @@
 
 * {Install Continuum}
 
-    To Install Continuum, you'll need the Continuum war.
+    To Install Continuum, you'll need the Continuum WAR.
 
-    Extract the Continuum war into <<<$JBOSS_HOME/server/default/deploy/continuum.war>>>
+    Extract the Continuum WAR into <<<$JBOSS_HOME/server/default/deploy/continuum.war>>>
 
 * {Continuum Configuration}
 

Modified: continuum/branches/continuum-1.3.x/continuum-docs/src/site/apt/installation/jetty.apt
URL: http://svn.apache.org/viewvc/continuum/branches/continuum-1.3.x/continuum-docs/src/site/apt/installation/jetty.apt?rev=899470&r1=899469&r2=899470&view=diff
==============================================================================
--- continuum/branches/continuum-1.3.x/continuum-docs/src/site/apt/installation/jetty.apt (original)
+++ continuum/branches/continuum-1.3.x/continuum-docs/src/site/apt/installation/jetty.apt Thu Jan 14 23:32:04 2010
@@ -20,7 +20,7 @@
 
     * Create a JDBC resource named <<<jdbc/users>>>
 
-    For derby you can copy the following configuration in your <<<$JETTY_HOME/etc/jetty.xml>>>
+    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}}
     and {{{https://svn.apache.org/repos/asf/continuum/trunk/continuum-webapp/src/jetty-env-mysql.xml}MySQL}}
@@ -73,7 +73,7 @@
 
 * {Mail Configuration}
 
-    The following xml can be used for the jetty mail configuration:
+    The following xml can be used for the Jetty mail configuration:
 
 +-------------------------------------+
     <!-- =========================================================== -->
@@ -100,9 +100,9 @@
 
 * {Install Continuum}
 
-    To Install Continuum, you'll need the Continuum war.
+    To Install Continuum, you'll need the Continuum WAR.
 
-    Copy or extract the Continuum war into $JETTY_HOME/webapps-plus/
+    Copy or extract the Continuum WAR into $JETTY_HOME/webapps-plus/
 
 * {Start Jetty}
 

Modified: continuum/branches/continuum-1.3.x/continuum-docs/src/site/apt/installation/standalone.apt
URL: http://svn.apache.org/viewvc/continuum/branches/continuum-1.3.x/continuum-docs/src/site/apt/installation/standalone.apt?rev=899470&r1=899469&r2=899470&view=diff
==============================================================================
--- continuum/branches/continuum-1.3.x/continuum-docs/src/site/apt/installation/standalone.apt (original)
+++ continuum/branches/continuum-1.3.x/continuum-docs/src/site/apt/installation/standalone.apt Thu Jan 14 23:32:04 2010
@@ -54,7 +54,7 @@
 * {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
-    startup script to add Continuum to the linux boot process. All you need to do, as root, is:
+    startup script to add Continuum to the Linux boot process. All you need to do, as root, is:
 
 ** {Basic script in /etc/init.d}
 
@@ -152,7 +152,7 @@
 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'"
+echo "To start Continuum now, run 'service continuum start'"
 
 ------------------
 

Modified: continuum/branches/continuum-1.3.x/continuum-docs/src/site/apt/installation/tomcat.apt
URL: http://svn.apache.org/viewvc/continuum/branches/continuum-1.3.x/continuum-docs/src/site/apt/installation/tomcat.apt?rev=899470&r1=899469&r2=899470&view=diff
==============================================================================
--- continuum/branches/continuum-1.3.x/continuum-docs/src/site/apt/installation/tomcat.apt (original)
+++ continuum/branches/continuum-1.3.x/continuum-docs/src/site/apt/installation/tomcat.apt Thu Jan 14 23:32:04 2010
@@ -74,7 +74,7 @@
 
     For the record, we personally put them in the <<<$CATALINA_HOME/common/lib/>>> directory.
 
-    Direct download links for these jar files.
+    Direct download links for these JAR files.
 
     * JavaMail 1.4 - {{{http://repo1.maven.org/maven2/javax/mail/mail/1.4/mail-1.4.jar}mail-1.4.jar}}
 
@@ -92,7 +92,7 @@
 
     We put them into the <<<$CATALINA_HOME/common/lib/>>> directory.
 
-    Direct download links for these jar files:
+    Direct download links for these JAR files:
 
     * {{{http://repo1.maven.org/maven2/org/apache/derby/derby/10.1.3.1/derby-10.1.3.1.jar}derby-10.1.3.1.jar}}
 
@@ -106,7 +106,7 @@
 
     The format typically expected is <<<\-Dappserver.base=\<SOMEWHERE\>>>>
 
-    You can utilize the <<<$CATALINA_HOME/bin/setenv.sh>>> script to set this value in a tomcat specific way.
+    You can utilize the <<<$CATALINA_HOME/bin/setenv.sh>>> script to set this value in a Tomcat specific way.
 
 ------------------------------------------
 #!/bin/bash
@@ -197,7 +197,7 @@
 
     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.)
+    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.)
 
 ------------------------------------------
 <Context path="/continuum"

Modified: continuum/branches/continuum-1.3.x/continuum-docs/src/site/apt/installation/upgrade.apt
URL: http://svn.apache.org/viewvc/continuum/branches/continuum-1.3.x/continuum-docs/src/site/apt/installation/upgrade.apt?rev=899470&r1=899469&r2=899470&view=diff
==============================================================================
--- continuum/branches/continuum-1.3.x/continuum-docs/src/site/apt/installation/upgrade.apt (original)
+++ continuum/branches/continuum-1.3.x/continuum-docs/src/site/apt/installation/upgrade.apt Thu Jan 14 23:32:04 2010
@@ -29,7 +29,7 @@
 
     The builds database has had model changes, and will need to be exported and imported.
 
-    First, download the Data Management tools you will need.  The tool is a standalone jar that you can download from the central repo.
+    First, download the Data Management tools you will need.  The tool is a standalone JAR that you can download from the central repo.
 
     You will need to download two versions of the tool, one for the export out of the old version and one for the import into the new version:
 

Modified: continuum/branches/continuum-1.3.x/continuum-docs/src/site/apt/user_guides/building_project/index.apt
URL: http://svn.apache.org/viewvc/continuum/branches/continuum-1.3.x/continuum-docs/src/site/apt/user_guides/building_project/index.apt?rev=899470&r1=899469&r2=899470&view=diff
==============================================================================
--- continuum/branches/continuum-1.3.x/continuum-docs/src/site/apt/user_guides/building_project/index.apt (original)
+++ continuum/branches/continuum-1.3.x/continuum-docs/src/site/apt/user_guides/building_project/index.apt Thu Jan 14 23:32:04 2010
@@ -8,7 +8,7 @@
 
 Building Projects
 
-    For Ant and maven builds the following system properties will be added via -D command line:
+    For Ant and Maven builds the following system properties will be added via -D command line:
 
     * <<<continuum.project.group.name>>>
 

Modified: continuum/branches/continuum-1.3.x/continuum-docs/src/site/apt/user_guides/managing_project/addProject.apt
URL: http://svn.apache.org/viewvc/continuum/branches/continuum-1.3.x/continuum-docs/src/site/apt/user_guides/managing_project/addProject.apt?rev=899470&r1=899469&r2=899470&view=diff
==============================================================================
--- continuum/branches/continuum-1.3.x/continuum-docs/src/site/apt/user_guides/managing_project/addProject.apt (original)
+++ continuum/branches/continuum-1.3.x/continuum-docs/src/site/apt/user_guides/managing_project/addProject.apt Thu Jan 14 23:32:04 2010
@@ -29,7 +29,7 @@
 
 [../../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.
+  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.
 
@@ -103,7 +103,7 @@
 
 [../../images/add-project-from-group.png] Add a project from a project group
 
-* {Scm hints}
+* {SCM hints}
 
 ** {ClearCase}
 

Modified: continuum/branches/continuum-1.3.x/continuum-docs/src/site/apt/user_guides/managing_project/editProject.apt
URL: http://svn.apache.org/viewvc/continuum/branches/continuum-1.3.x/continuum-docs/src/site/apt/user_guides/managing_project/editProject.apt?rev=899470&r1=899469&r2=899470&view=diff
==============================================================================
--- continuum/branches/continuum-1.3.x/continuum-docs/src/site/apt/user_guides/managing_project/editProject.apt (original)
+++ continuum/branches/continuum-1.3.x/continuum-docs/src/site/apt/user_guides/managing_project/editProject.apt Thu Jan 14 23:32:04 2010
@@ -20,7 +20,7 @@
 
   * project version
 
-  * project scm url
+  * project SCM URL
 
   * project Last Build Date
 
@@ -59,9 +59,9 @@
 
   Editing a build result will display:
 
-  * scm changes (author and file path)
+  * SCM changes (author and file path)
 
-  * project dependencies (project recorded in this continuum instance)
+  * project dependencies (project recorded in this Continuum instance)
 
   * detail of the build definition used