taylor 2004/04/21 22:29:19
Modified: tutorial/xdocs developing.xml
Log:
finalizing tutorial docs
Revision Changes Path
1.4 +16 -21 jakarta-jetspeed/tutorial/xdocs/developing.xml
Index: developing.xml
===================================================================
RCS file: /home/cvs/jakarta-jetspeed/tutorial/xdocs/developing.xml,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- developing.xml 9 Apr 2004 05:42:48 -0000 1.3
+++ developing.xml 22 Apr 2004 05:29:19 -0000 1.4
@@ -137,7 +137,7 @@
</tr>
<tr>
<td>
-tutorial-n [1-9] jetspeed:war
+tutorial-n [1-12] deploy
</td>
<td>
Configure the distribution for the nth tutorial examples.
@@ -147,16 +147,17 @@
</code>
<hr/>
<p>
+Note that for the jetspeed:deploy, jetspeed:hotdeploy, jetspeed:war goals, with the
tutorial you
+can type short cuts: deploy, hotdeploy, war.
+The hotdeploy goal will be more useful in your own project and is not necessary in
the step by step tutorial.
To build the examples for a specific tutorial example, type:
</p>
<source>
-maven -Dtutorial=[n] jetspeed:war (where n = the number of the tutorial)<br/>
-maven jetspeed:deploy (first time, and then)<br/>
-maven jetspeed:hotdeploy<br/>
+maven -Dtutorial=[n] jetspeed:deploy (where n = the number of the tutorial)<br/>
</source>
<p>
-The tutorials must be run in order.
-If you want to deploy tutorial-5, you must first run tutorial-1 thru tutorial-4.
+The tutorials can be run in any order.
+If you want to deploy tutorial-5, you don't have to run 1-4, 5 will automatically
include 1-4.
</p>
<p>
Thats it. You are now ready to start up the JPortal web application.
@@ -175,7 +176,7 @@
Password = turbine<br/>
</p>
<p>
-NOTE: you should shutdown Catalina before invoking the deploy target.
+NOTE: you should shutdown Catalina before invoking the deploy goal.
</p>
</section>
<section name="Development Cycle">
@@ -197,24 +198,18 @@
<hr/>
</p>
<p>
-To configure the distribution to match the given tutorial,
+During the tutorial, we recommend using the jetspeed:deploy goal.
+<b>NOTE: make sure to shutdown Tomcat or Catalina before running the
jetspeed:deploy goal.</b>
+To configure, build the war, and deploy the distribution to match the given
tutorial,
where [n] is the number of the tutorial from this document:
</p>
<p>
<hr/>
-<code>maven -Dtutorial=[n]</code>
-<hr/>
-</p>
-<p>
-To deploy the tutorial to Tomcat application server, type:
-</p>
-<p>
-<hr/>
-<code>maven jetspeed:deploy</code>
+<code>maven -Dtutorial=[n] deploy</code>
<hr/>
</p>
<p>
-The deploy goal is dependent on the jetspeed:war target.
+The deploy goal is dependent on the jetspeed:war goal.
After building the war file, it automatically deploys the war file into the
application server of your choice.
For this tutorial, Jakarta Tomcat 4 or 5 is required.
NOTE: you should shutdown Catalina before invoking the deploy goal.
@@ -225,8 +220,8 @@
<p>
The <b>jetspeed:hotdeploy</b> goal is a quicker version of deploy.
It only deploys classes and configuration files that are newer than the files in
the deployed web application.
-Requires that deploy target is ran once, since it will not expand the entire
application to the web application directory.
-This target is used most often in the everyday development routine.
+Requires that deploy goal is ran once, since it will not expand the entire
application to the web application directory.
+This goal is used most often in the everyday development routine. For the tutorial
we do not use it.
If you change any Java files, you will may have to recycle your application server
to load the new class files.
</p>
<p>
@@ -242,7 +237,7 @@
No changes are made to the Jetspeed distribution.
When you point your browser at <a
href='http://localhost:8080/jportal/portal'>http://localhost:8080/jportal/portal</a>,
you will see the default Jetspeed portal.
-This target is useful if you want to restart the tutorials from the beginning.
+This goal is useful if you want to restart the tutorials from the beginning.
</p>
<p>
Jetspeed 2.0 will support the Java Standard Portlet API, which defines a standard
deployment descriptor and portlet archive for deploying portlets to portlet
containers. Version 1.x of Jetspeed does not support the standard, thus a custom
deployment procedure is necessary.
---------------------------------------------------------------------
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]
