Author: olamy
Date: Thu Dec 6 21:09:18 2012
New Revision: 1418085
URL: http://svn.apache.org/viewvc?rev=1418085&view=rev
Log:
[MTOMCAT-192] Website text cleanup
Submitted by Glen Mazza.
Modified:
tomcat/maven-plugin/trunk/src/site/apt/archetype.apt.vm
tomcat/maven-plugin/trunk/src/site/apt/container-goals.apt
tomcat/maven-plugin/trunk/src/site/apt/context-goals.apt
tomcat/maven-plugin/trunk/src/site/apt/executable-war-jar.apt.vm
tomcat/maven-plugin/trunk/src/site/apt/how-to-contribute.apt.vm
tomcat/maven-plugin/trunk/src/site/apt/index.apt.vm
tomcat/maven-plugin/trunk/src/site/apt/run-mojo-features.apt.vm
Modified: tomcat/maven-plugin/trunk/src/site/apt/archetype.apt.vm
URL:
http://svn.apache.org/viewvc/tomcat/maven-plugin/trunk/src/site/apt/archetype.apt.vm?rev=1418085&r1=1418084&r2=1418085&view=diff
==============================================================================
--- tomcat/maven-plugin/trunk/src/site/apt/archetype.apt.vm (original)
+++ tomcat/maven-plugin/trunk/src/site/apt/archetype.apt.vm Thu Dec 6 21:09:18
2012
@@ -118,14 +118,6 @@ java -jar basic-webapp-exec-1.0-SNAPSHOT
+------------------
+ And go to http://localhost:9191 with a browser.
- And hit your browser to http://localhost:9191.
-
- So you have a tomcat7 running our fabulous application and without
installing nothing !
-
-
-
-
-
-
-
+ So you now have a Tomcat 7 instance running this fabulous application
without needing to install anything!
Modified: tomcat/maven-plugin/trunk/src/site/apt/container-goals.apt
URL:
http://svn.apache.org/viewvc/tomcat/maven-plugin/trunk/src/site/apt/container-goals.apt?rev=1418085&r1=1418084&r2=1418085&view=diff
==============================================================================
--- tomcat/maven-plugin/trunk/src/site/apt/container-goals.apt (original)
+++ tomcat/maven-plugin/trunk/src/site/apt/container-goals.apt Thu Dec 6
21:09:18 2012
@@ -69,7 +69,7 @@ mvn tomcat6:info
mvn tomcat6:resources
+--
- Alternatively, to only list JNDI resources of a specific type you can type:
+ Alternatively, to list only JNDI resources of a specific type you can type:
+--
mvn -Dmaven.tomcat.type=my.class.name tomcat6:resources
Modified: tomcat/maven-plugin/trunk/src/site/apt/context-goals.apt
URL:
http://svn.apache.org/viewvc/tomcat/maven-plugin/trunk/src/site/apt/context-goals.apt?rev=1418085&r1=1418084&r2=1418085&view=diff
==============================================================================
--- tomcat/maven-plugin/trunk/src/site/apt/context-goals.apt (original)
+++ tomcat/maven-plugin/trunk/src/site/apt/context-goals.apt Thu Dec 6
21:09:18 2012
@@ -29,8 +29,8 @@
Context Goals
- The plugin provides goals to perform various tasks upon your project's context
- once deployed within Tomcat:
+ This plugin provides goals that perform various tasks on your project's
context
+ once deployed on Tomcat:
* {{{#Redeploying a WAR project}Redeploying a WAR project}}
Modified: tomcat/maven-plugin/trunk/src/site/apt/executable-war-jar.apt.vm
URL:
http://svn.apache.org/viewvc/tomcat/maven-plugin/trunk/src/site/apt/executable-war-jar.apt.vm?rev=1418085&r1=1418084&r2=1418085&view=diff
==============================================================================
--- tomcat/maven-plugin/trunk/src/site/apt/executable-war-jar.apt.vm (original)
+++ tomcat/maven-plugin/trunk/src/site/apt/executable-war-jar.apt.vm Thu Dec 6
21:09:18 2012
@@ -28,13 +28,13 @@
Build an Executable War/Jar
- Since version 2.0 you can now build an executable war/jar with an embedded
Apache Tomcat7.
+ Starting with Version 2.0 of the plugin you can build an executable war/jar
with an embedded Apache Tomcat7.
This is only supported with the tomcat7 plugin.
- <<Note>> Your project must have packaging pom or war.
+ <<Note>> Your project must have a packaging value of <<<pom>>> or <<<war>>>.
-* Additional Artifact to your war module
+* Artifact to add to your war module:
+--
<project>
@@ -58,7 +58,7 @@ Build an Executable War/Jar
<phase>package</phase>
<configuration>
<path>foo</path>
- <!-- optional only if you want to use a preconfigured server.xml
file -->
+ <!-- optional, needed only if you want to use a preconfigured
server.xml file -->
<serverXml>src/main/tomcatconf/server.xml</serverXml>
<!-- optional values which can be configurable -->
<attachArtifactClassifier>default value is exec-war but you can
customize</attachArtifactClassifier>
@@ -75,7 +75,7 @@ Build an Executable War/Jar
</project>
+--
-* Additional Artifact to your pom module
+* Artifact to add to your pom module:
+--
<project>
@@ -113,9 +113,9 @@ Build an Executable War/Jar
<contextPath>/</contextPath>
</warRunDependency>
</warRunDependencies>
- <!-- naming is disable by default so use true to enable it -->
+ <!-- naming is disabled by default so use true to enable it -->
<enableNaming>true</enableNaming>
- <!-- extra dependencies to add jdbc driver mail jars -->
+ <!-- extra dependencies to add jdbc driver, mail jars, etc. -->
<extraDependencies>
<extraDependency>
<groupId>org.apache.derby</groupId>
@@ -142,7 +142,7 @@ Build an Executable War/Jar
* Generated executable jar/war
- You will be able to execute the generated jar which contains an embedded
tomcat container
+ With the above configuration you can execute the generated jar due to its
embedded Tomcat container
+------
java -jar yourjar
Modified: tomcat/maven-plugin/trunk/src/site/apt/how-to-contribute.apt.vm
URL:
http://svn.apache.org/viewvc/tomcat/maven-plugin/trunk/src/site/apt/how-to-contribute.apt.vm?rev=1418085&r1=1418084&r2=1418085&view=diff
==============================================================================
--- tomcat/maven-plugin/trunk/src/site/apt/how-to-contribute.apt.vm (original)
+++ tomcat/maven-plugin/trunk/src/site/apt/how-to-contribute.apt.vm Thu Dec 6
21:09:18 2012
@@ -28,7 +28,7 @@
How To Contribute
- All contributions are welcome !! (new features, patches, documentation etc..)
+ All contributions are welcome!! (new features, patches, documentation etc..)
* Get the sources from scm
@@ -43,18 +43,11 @@ How To Contribute
[]
- Then you can use git svn, simple configuration using the existing script :
+ Then you can use git svn, simple configuration using the existing script:
+----------------
sh ./init-git-svn.sh
+----------------
- You must then create a jira issue see {{{./issue-tracking.html}Issue
Tracking}} and attach a patch (pull request accepted too)
-
-
-
-
-
-
-
+ You must then create a JIRA issue see {{{./issue-tracking.html}Issue
Tracking}} and attach a patch (pull request accepted too)
Modified: tomcat/maven-plugin/trunk/src/site/apt/index.apt.vm
URL:
http://svn.apache.org/viewvc/tomcat/maven-plugin/trunk/src/site/apt/index.apt.vm?rev=1418085&r1=1418084&r2=1418085&view=diff
==============================================================================
--- tomcat/maven-plugin/trunk/src/site/apt/index.apt.vm (original)
+++ tomcat/maven-plugin/trunk/src/site/apt/index.apt.vm Thu Dec 6 21:09:18 2012
@@ -30,7 +30,7 @@ Apache Tomcat Maven Plugin
This is the new home for the Tomcat Maven Plugin (previously hosted at
Codehaus).
- The version ${project.version} have the following new features:
+ Version ${project.version} has the following new features:
* Apache Tomcat7 support
@@ -42,8 +42,8 @@ Apache Tomcat Maven Plugin
The Tomcat Maven Plugin provides goals to manipulate WAR projects within the
{{{http://tomcat.apache.org/}Apache Tomcat}} servlet container.
- Or to run your war project in an embeded Apache Tomcat. The run goal give
you the opportunity to develop quickly your application without any
- huge install to do manually. More details and features:
{{{./run-mojo-features.html}see documentation}}.
+ Or to run your war project with an embedded Apache Tomcat. The run goals
give you the opportunity to quickly develop your application without needing
+ to install a standalone Tomcat instance. More details and features:
{{{./run-mojo-features.html}see documentation}}.
* groupId and Mojo name change
@@ -90,11 +90,10 @@ Apache Tomcat Maven Plugin
[]
-* Know limitations
+* Known limitations
- Some goals are not yet available in tomcat7 mojo. Those
{{{./container-goals.html}container goals}} are available with
+ Some goals are not yet available with the tomcat7 mojo. Those
{{{./container-goals.html}container goals}} are available with
the tomcat6 mojo, you only need to update the manager url in your pom.
Use <<<http://localhost:8080/manager/text>>> rather than the default tomcat6
url.
-
Modified: tomcat/maven-plugin/trunk/src/site/apt/run-mojo-features.apt.vm
URL:
http://svn.apache.org/viewvc/tomcat/maven-plugin/trunk/src/site/apt/run-mojo-features.apt.vm?rev=1418085&r1=1418084&r2=1418085&view=diff
==============================================================================
--- tomcat/maven-plugin/trunk/src/site/apt/run-mojo-features.apt.vm (original)
+++ tomcat/maven-plugin/trunk/src/site/apt/run-mojo-features.apt.vm Thu Dec 6
21:09:18 2012
@@ -26,20 +26,20 @@
~~ NOTE: For help with the syntax of this file, see:
~~ http://maven.apache.org/doxia/references/apt-format.html
-Run Mojo: run your Maven war project quickly !
+Run Mojo: run your Maven war project quickly!
- When developping a war project, you usually build your war and deploy it to
an installed Tomcat instance.
- This is time and resources consuming and take time to install locally the
instance.
+ When developing a war project, you usually build your war and deploy it to
an installed Tomcat instance.
+ This is time and resources consuming and also requires a local Tomcat
instance.
- The run mojo give you the opportunity to save that by simply running your
war inside an embeded Tomcat instance in your Maven build.
+ The run mojo gives you the opportunity to avoid those efforts by simply
running your war inside an embedded Tomcat instance in your Maven build.
- <<<NOTE>>> If you have a multi module Maven projects and use Maven3, you
don't need to install all modules before use the run goal,
- just use tomcat6/7:run from the root module and the plugin will auto detect
build output directory from various modules and replace
+ <<<NOTE>>> If you have a multi module Maven project and use Maven3, you
don't need to install all modules before using the run goal,
+ just use tomcat6/7:run from the root module and the plugin will auto detect
the build output directory from various modules and replace
dependencies with those directories in the webapp classloader.
-* Run an embeded Tomcat
+* Running an embedded Tomcat
- Configure your pom with the plugin version (for other mojo parameters see
each mojo documentation details).
+ Configure your pom with the plugin version (for other mojo parameters see
each mojo's documentation).
And use: mvn tomcat6/7:run
@@ -56,9 +56,9 @@ Run Mojo: run your Maven war project qui
<port>9090</port>
<!-- application path always starts with /-->
<path>/</path>
- <!-- optionnal path to a context file -->
+ <!-- optional path to a context file -->
<contextFile>${tomcatContextXml}</contextFile>
- <!-- optionnal system propoerties you want to add -->
+ <!-- optional system propoerties you want to add -->
<systemProperties>
<appserver.base>${project.build.directory}/appserver-base</appserver.base>
<appserver.home>${project.build.directory}/appserver-home</appserver.home>
@@ -67,12 +67,12 @@ Run Mojo: run your Maven war project qui
</systemProperties>
<!-- if you want to use test dependencies rather than only runtime -->
<useTestClasspath>false</useTestClasspath>
- <!-- optionnal if you want to add some extra directories in the class
loader -->
+ <!-- optional if you want to add some extra directories into the
classloader -->
<additionalClasspathDirs>
<additionalClasspathDir></additionalClasspathDir>
</additionalClasspathDirs>
</configuration>
- <!-- if you need some extra dependencies only for running the embeded
tomcat add them in the plugin dependencies -->
+ <!-- For any extra dependencies needed when running embedded Tomcat (not
WAR dependencies) add them below -->
<dependencies>
<dependency>
<groupId>org.apache.derby</groupId>
@@ -93,19 +93,19 @@ Run Mojo: run your Maven war project qui
+---------------------
pom.xml (top level pom with packaging pom)
- my-api/pom.xml (api project with packaging jar)
- my-api-impl/pom.xml (api implementation project with packaging jar)
+ my-api/pom.xml (API project with packaging jar)
+ my-api-impl/pom.xml (API implementation project with packaging jar)
my-webapp/pom.xml (webapp project with packaging war)
+---------------------
- With a such structure, from the top level directory use mvn tomcat6/7:run
-pl :my-webapp -am.
+ With the structure given above, from the top level directory use mvn
tomcat6/7:run -pl :my-webapp -am.
* Use it with selenium mojo
- You can use the mojo, to start your application in a Tomcat instance and run
you selenium test against this instance.
+ You can use this mojo to start your application in a Tomcat instance and run
your selenium test against this instance.
- The following configuration will start an emdeded tomcat in
pre-integration-test and stop it in post-integration-test.
+ The following configuration will start an embedded Tomcat in the
pre-integration-test and stop it in the post-integration-test.
+---------------------
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscr...@tomcat.apache.org
For additional commands, e-mail: dev-h...@tomcat.apache.org
