Author: objectiser Date: 2010-07-13 07:28:54 -0400 (Tue, 13 Jul 2010) New Revision: 858 Modified: branches/RiftSaw-2.1.x/docs/docbook/gettingstartedguide/src/main/module/installation.xml trunk/docs/docbook/gettingstartedguide/src/main/module/installation.xml Log: Updates to installation instructions. Modified: branches/RiftSaw-2.1.x/docs/docbook/gettingstartedguide/src/main/module/installation.xml =================================================================== --- branches/RiftSaw-2.1.x/docs/docbook/gettingstartedguide/src/main/module/installation.xml 2010-07-12 13:44:14 UTC (rev 857) +++ branches/RiftSaw-2.1.x/docs/docbook/gettingstartedguide/src/main/module/installation.xml 2010-07-13 11:28:54 UTC (rev 858) @@ -26,8 +26,8 @@ service stack to version 3.2.2.GA, as described in the following 'Upgrade web service for JBoss AS' section.</listitem> <listitem>JBossESB (version 4.8.GA or higher), should download the <emphasis role="bold">jbossesb-4.8.GA.zip</emphasis>, available from <ulink url="http://www.jboss.org/jbossesb">http://www.jboss.org/jbo...;. - This is only required to run the ESB/BPEL example.</listitem> - <listitem>RiftSaw (version 2.0 or higher), available from + This is only required to run the ESB/BPEL examples.</listitem> + <listitem>RiftSaw, available from <ulink url="http://www.jboss.org/riftsaw">http://www.jboss.org/rift... <listitem> Ant, available from <ulink url="http://ant.apache.org/">http://ant.apache.org</ulink... @@ -90,10 +90,17 @@ the JBossAS and JBossESB location settings. </listitem> <listitem> - From the install folder, run: <command>ant deploy -Ddatabase=... -Dws.stack=... -Dws.version=...</command> to deploy - RiftSaw to JBossAS, specifying a database and mandating the upgrade of the web service stack for JBossAS. + <para> + From the install folder, run: + </para> + <para> + <command>ant deploy -Ddatabase=... -Dws.stack=... -Dws.version=...</command> + </para> + <para> + to deploy RiftSaw to JBossAS, specifying a database and mandating the upgrade of the web service stack for JBossAS. The list of available databases, and how they should be configured, is explained in the next sub-section; the list of options for update of the web service stack is discussed in the one following it. + </para> <note> <para> Please note that RiftSaw should not be deployed while JBoss AS is running. @@ -114,9 +121,17 @@ <para> <itemizedlist> <listitem> - From the install folder, run: <command>ant undeploy -Ddatabase=....</command> to remove + <para> + From the install folder, run: + </para> + <para> + <command>ant undeploy -Ddatabase=....</command> + </para> + <para> + to remove RiftSaw from JBossAS. The database option should specify the same value used during installation of RiftSaw. + </para> </listitem> </itemizedlist> </para> @@ -125,10 +140,13 @@ <para> <tip> - In the Hsql database environment, if you install the RiftSaw, we will copy the h2 library into JBoss AS server. - But when you undeploy the RiftSaw, we won't delete it. The reason for doing this is because the JBoss ESB or jBPM will use the h2 database also, - if we remove the h2 database in the undeployment process, we might cause JBoss ESB or jBPM start failed. - So if you want to remove the h2 database, please go to the $JBossAS/server/${config} (like default)/lib, and then remove it manually. + When deploying riftsaw with the <emphasis>hsql</emphasis> database option, + the installation script will copy the h2 library into JBoss AS server. + However, when riftsaw is undeployed, this library will not be removed. + This is because JBoss ESB and jBPM also use the h2 database, and therefore + removing the library may inadvertantly impact those projects. + If you wish to remove the h2 library, then please go to the + <filename>$JBossAS/server/${config}/lib</filename> folder and remove it manually. </tip> </para> Modified: trunk/docs/docbook/gettingstartedguide/src/main/module/installation.xml =================================================================== --- trunk/docs/docbook/gettingstartedguide/src/main/module/installation.xml 2010-07-12 13:44:14 UTC (rev 857) +++ trunk/docs/docbook/gettingstartedguide/src/main/module/installation.xml 2010-07-13 11:28:54 UTC (rev 858) @@ -26,8 +26,8 @@ service stack to version 3.2.2.GA, as described in the following 'Upgrade web service for JBoss AS' section.</listitem> <listitem>JBossESB (version 4.8.GA or higher), should download the <emphasis role="bold">jbossesb-4.8.GA.zip</emphasis>, available from <ulink url="http://www.jboss.org/jbossesb">http://www.jboss.org/jbo...;. - This is only required to run the ESB/BPEL example.</listitem> - <listitem>RiftSaw (version 2.0 or higher), available from + This is only required to run the ESB/BPEL examples.</listitem> + <listitem>RiftSaw, available from <ulink url="http://www.jboss.org/riftsaw">http://www.jboss.org/rift... <listitem> Ant, available from <ulink url="http://ant.apache.org/">http://ant.apache.org</ulink... @@ -90,10 +90,17 @@ the JBossAS and JBossESB location settings. </listitem> <listitem> - From the install folder, run: <command>ant deploy -Ddatabase=... -Dws.stack=... -Dws.version=...</command> to deploy - RiftSaw to JBossAS, specifying a database and mandating the upgrade of the web service stack for JBossAS. + <para> + From the install folder, run: + </para> + <para> + <command>ant deploy -Ddatabase=... -Dws.stack=... -Dws.version=...</command> + </para> + <para> + to deploy RiftSaw to JBossAS, specifying a database and mandating the upgrade of the web service stack for JBossAS. The list of available databases, and how they should be configured, is explained in the next sub-section; the list of options for update of the web service stack is discussed in the one following it. + </para> <note> <para> Please note that RiftSaw should not be deployed while JBoss AS is running. @@ -114,9 +121,17 @@ <para> <itemizedlist> <listitem> - From the install folder, run: <command>ant undeploy -Ddatabase=....</command> to remove + <para> + From the install folder, run: + </para> + <para> + <command>ant undeploy -Ddatabase=....</command> + </para> + <para> + to remove RiftSaw from JBossAS. The database option should specify the same value used during installation of RiftSaw. + </para> </listitem> </itemizedlist> </para> @@ -125,10 +140,13 @@ <para> <tip> - In the Hsql database environment, if you install the RiftSaw, we will copy the h2 library into JBoss AS server. - But when you undeploy the RiftSaw, we won't delete it. The reason for doing this is because the JBoss ESB or jBPM will use the h2 database also, - if we remove the h2 database in the undeployment process, we might cause JBoss ESB or jBPM start failed. - So if you want to remove the h2 database, please go to the $JBossAS/server/${config} (like default)/lib, and then remove it manually. + When deploying riftsaw with the <emphasis>hsql</emphasis> database option, + the installation script will copy the h2 library into JBoss AS server. + However, when riftsaw is undeployed, this library will not be removed. + This is because JBoss ESB and jBPM also use the h2 database, and therefore + removing the library may inadvertantly impact those projects. + If you wish to remove the h2 library, then please go to the + <filename>$JBossAS/server/${config}/lib</filename> folder and remove it manually. </tip> </para>