9:33 a.m.
Author: objectiser
Date: 2008-11-10 10:33:53 -0500 (Mon, 10 Nov 2008)
New Revision: 428
Added:
cdl/trunk/docs/docbook/gettingstartedguide/src/main/module/installation.xml
cdl/trunk/docs/docbook/userguide/src/main/module/overview.xml
Removed:
cdl/trunk/docs/docbook/userguide/src/main/module/installation.xml
Modified:
cdl/trunk/distribution/src/main/release/README.txt
cdl/trunk/docs/docbook/gettingstartedguide/src/main/master.xml
cdl/trunk/docs/docbook/userguide/src/main/master.xml
Log:
Moved the installation chapter from User Guide to Getting Started Guide.
Modified: cdl/trunk/distribution/src/main/release/README.txt
===================================================================
--- cdl/trunk/distribution/src/main/release/README.txt 2008-11-10 15:12:38 UTC (rev 427)
+++ cdl/trunk/distribution/src/main/release/README.txt 2008-11-10 15:33:53 UTC (rev 428)
@@ -1,13 +1,14 @@
Overlord CDL README
===================
-Please refer to the Installation section, within the User Guide in the docs folder,
-which explains how to install the Overlord CDL governance capabilities into the
+Please refer to the Installation section, within the Getting Started Guide in the docs
+folder, which explains how to install the Overlord CDL governance capabilities into the
JBossESB environment.
+If you are new to SOA Governance using CDL, then please refer to the Getting Started
+Guide in the docs folder. Otherwise more detailed information can be found in the
+User Guide within the docs folder.
+
The Samples Guide in the docs folder explains how to run some examples demonstrating
the CDL based Governance capabilities.
-If you are new to SOA Governance using CDL, then please refer to the Getting Started
-Guide in the docs folder.
-
Modified: cdl/trunk/docs/docbook/gettingstartedguide/src/main/master.xml
===================================================================
--- cdl/trunk/docs/docbook/gettingstartedguide/src/main/master.xml 2008-11-10 15:12:38 UTC
(rev 427)
+++ cdl/trunk/docs/docbook/gettingstartedguide/src/main/master.xml 2008-11-10 15:33:53 UTC
(rev 428)
@@ -11,6 +11,7 @@
</bookinfo>
<toc/>
+ <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
href="module/installation.xml"/>
<xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
href="module/soagwithcdl.xml"/>
<xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
href="module/conversation-validation-with-cdl.xml"/>
<xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
href="module/conversation-aware-esb.xml"/>
Added: cdl/trunk/docs/docbook/gettingstartedguide/src/main/module/installation.xml
===================================================================
--- cdl/trunk/docs/docbook/gettingstartedguide/src/main/module/installation.xml
(rev 0)
+++ cdl/trunk/docs/docbook/gettingstartedguide/src/main/module/installation.xml 2008-11-10
15:33:53 UTC (rev 428)
@@ -0,0 +1,115 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
+]>
+<chapter id="installation">
+ <title>Installation</title>
+
+ <section>
+ <title> Overview </title>
+ <para>
+ This section describes the installation procedure for the Overlord CDL based
governance capabilities. These capabilities are:
+ </para>
+ <itemizedlist>
+ <listitem> Conversation aware ESB Actions with conformance checking
against a Choreography Description </listitem>
+ <listitem> ESB Service validation against a Choreography Description
</listitem>
+ </itemizedlist>
+ </section>
+
+ <section>
+ <title>Prerequisites</title>
+ <orderedlist>
+ <listitem>JBossAS (version 4.2.2.GA or higher), available from <ulink
url="http://www.jboss.org/jbossas">http://www.jboss.org/jbos...
+ <listitem>JBossESB (version 4.4.GA or higher), should download the
<emphasis role="bold">jbossesb-4.4.GA.zip</emphasis>, available from
<ulink
url="http://www.jboss.org/jbossesb">http://www.jboss.org/jbo...
+ <listitem>Overlord CDL (version 1.0-SNAPSHOT or higher)
</listitem>
+ <listitem>
+ pi4soa (version 2.0.0 or higher), available from <ulink
url="http://pi4soa.wiki.sourceforge.net/download">http://pi4...
+ <note>
+ <para>
+ It is recommended that a pre-packaged version is used, which includes all of
the necessary Eclipse related plugins.
+ However the plugins can be installed separately into an existing Eclipse
environment by following the instructions on the <ulink
url="http://www.pi4soa.org">http://www.pi4soa.org</ulink> download
wiki.
+ </para>
+ </note>
+ </listitem>
+ <listitem>
+ Ant, available from <ulink
url="http://ant.apache.org/">http://ant.apache.org</ulink...
+ </listitem>
+ </orderedlist>
+ </section>
+
+ <section>
+ <title>Installation Instructions</title>
+ <orderedlist>
+ <listitem>
+ Install JBossAS
+ <para> Unpack the JBossAS installation into the required location.
</para>
+ </listitem>
+ <listitem>
+ Install JBossESB
+ <para> Unpack the JBossESB installation into a location alongside the
JBossAS installation.
+ Then follow the instructions in the JBossESB installation
(install/readme.txt), to deploy JBossESB into the JBossAS environment.
+ </para>
+ </listitem>
+
+ <listitem>
+ Install the Overlord CDL distribution
+ <para>
+ Unpack the Overlord CDL distribution into a location alongside the JBossAS
installation.
+ </para>
+ <para>
+ <itemizedlist>
+ <listitem>
+ Edit the <emphasis
role="bold">install/deployment.properties</emphasis> file to update the
JBossAS and JBossESB location settings.
+ </listitem>
+ <listitem>
+ From the install folder, run: <command> ant deploy</command>to
deploy both the Overlord CDL conversational ESB actions and service validation
capabilities.
+ Or <command>ant deploy-overlord-cdl-runtime</command> to deploy just
the conversational ESB actions support, or <command>ant
deploy-overlord-cdl-validator</command> to deploy just the service validation
capability.
+ </listitem>
+ </itemizedlist>
+ </para>
+ </listitem>
+
+ <listitem>
+ Install pi4soa
+ <para>
+ Unpack the pi4soa pre-packaged Eclipse version into a location alongside the
JBossAS installation, or install the relevant plugins (as described on the pi4soa wiki)
into an existing Eclipse environment.
+ </para>
+ <para>
+ If just the service validation capabilities are being used, then no further
configuration of the Eclipse environment is necessary.
+ However if the conversational ESB actions, with conformance checking against a
Choreography Description, will be used, then the following additional steps will be
required:
+ </para>
+ <para>
+ <itemizedlist>
+ <listitem>
+ Start the Eclipse environment
+ </listitem>
+ <listitem>
+ Select the “Help - > Software Updates...” menu item
+ </listitem>
+ <listitem>
+ From the <emphasis role="bold"> Available
Software</emphasis> tab, press the “Add Site...” button
+ </listitem>
+ <listitem>
+ Press the <emphasis role="bold">“Local”</emphasis> button,
browse to locate the <emphasis role="bold">tools</emphasis> folder
in the Overlord CDL distribution,
+ and then press the OK button. This will cause the local Eclipse update site,
bundled with the Overlord CDL distribution, to be add to the <emphasis
role="bold"> Available Software </emphasis> tab.
+ </listitem>
+ <listitem>
+ Select the root node of the newly added local update site, and then press the
<emphasis role="bold">“Install”</emphasis> button and follow the
instructions to install the plugins.
+
+ <note>
+ <para>
+ An eclipse issue occasionally causes the nodes under the checked root node
+ to become unchecked, resulting in the software update manager indicating
+ that no plugins need to be installed. If this happens, simply uncheck the
+ root node, and then re-check the root node and press the
+ <emphasis role="bold">“Install”</emphasis> button again.
+ </para>
+ </note>
+ </listitem>
+ </itemizedlist>
+ </para>
+ </listitem>
+
+ </orderedlist>
+ </section>
+
+</chapter>
Modified: cdl/trunk/docs/docbook/userguide/src/main/master.xml
===================================================================
--- cdl/trunk/docs/docbook/userguide/src/main/master.xml 2008-11-10 15:12:38 UTC (rev
427)
+++ cdl/trunk/docs/docbook/userguide/src/main/master.xml 2008-11-10 15:33:53 UTC (rev
428)
@@ -11,7 +11,7 @@
</bookinfo>
<toc/>
- <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
href="module/installation.xml"/>
+ <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
href="module/overview.xml"/>
<xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
href="module/conversation-validation-with-cdl.xml"/>
<xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
href="module/conversation-aware-esb.xml"/>
Deleted: cdl/trunk/docs/docbook/userguide/src/main/module/installation.xml
===================================================================
--- cdl/trunk/docs/docbook/userguide/src/main/module/installation.xml 2008-11-10 15:12:38
UTC (rev 427)
+++ cdl/trunk/docs/docbook/userguide/src/main/module/installation.xml 2008-11-10 15:33:53
UTC (rev 428)
@@ -1,115 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
-]>
-<chapter id="installation">
- <title>Installation</title>
-
- <section>
- <title> Overview </title>
- <para>
- This section describes the installation procedure for the Overlord CDL based
governance capabilities. These capabilities are:
- </para>
- <itemizedlist>
- <listitem> Conversation aware ESB Actions with conformance checking
against a Choreography Description </listitem>
- <listitem> ESB Service validation against a Choreography Description
</listitem>
- </itemizedlist>
- </section>
-
- <section>
- <title>Prerequisites</title>
- <orderedlist>
- <listitem>JBossAS (version 4.2.2.GA or higher), available from <ulink
url="http://www.jboss.org/jbossas">http://www.jboss.org/jbos...
- <listitem>JBossESB (version 4.4.GA or higher), should download the
<emphasis role="bold">jbossesb-4.4.GA.zip</emphasis>, available from
<ulink
url="http://www.jboss.org/jbossesb">http://www.jboss.org/jbo...
- <listitem>Overlord CDL (version 1.0-SNAPSHOT or higher)
</listitem>
- <listitem>
- pi4soa (version 2.0.0 or higher), available from <ulink
url="http://pi4soa.wiki.sourceforge.net/download">http://pi4...
- <note>
- <para>
- It is recommended that a pre-packaged version is used, which includes all of
the necessary Eclipse related plugins.
- However the plugins can be installed separately into an existing Eclipse
environment by following the instructions on the <ulink
url="http://www.pi4soa.org">http://www.pi4soa.org</ulink> download
wiki.
- </para>
- </note>
- </listitem>
- <listitem>
- Ant, available from <ulink
url="http://ant.apache.org/">http://ant.apache.org</ulink...
- </listitem>
- </orderedlist>
- </section>
-
- <section>
- <title>Installation Instructions</title>
- <orderedlist>
- <listitem>
- Install JBossAS
- <para> Unpack the JBossAS installation into the required location.
</para>
- </listitem>
- <listitem>
- Install JBossESB
- <para> Unpack the JBossESB installation into a location alongside the
JBossAS installation.
- Then follow the instructions in the JBossESB installation
(install/readme.txt), to deploy JBossESB into the JBossAS environment.
- </para>
- </listitem>
-
- <listitem>
- Install the Overlord CDL distribution
- <para>
- Unpack the Overlord CDL distribution into a location alongside the JBossAS
installation.
- </para>
- <para>
- <itemizedlist>
- <listitem>
- Edit the <emphasis
role="bold">install/deployment.properties</emphasis> file to update the
JBossAS and JBossESB location settings.
- </listitem>
- <listitem>
- From the install folder, run: <command> ant deploy</command>to
deploy both the Overlord CDL conversational ESB actions and service validation
capabilities.
- Or <command>ant deploy-overlord-cdl-runtime</command> to deploy just
the conversational ESB actions support, or <command>ant
deploy-overlord-cdl-validator</command> to deploy just the service validation
capability.
- </listitem>
- </itemizedlist>
- </para>
- </listitem>
-
- <listitem>
- Install pi4soa
- <para>
- Unpack the pi4soa pre-packaged Eclipse version into a location alongside the
JBossAS installation, or install the relevant plugins (as described on the pi4soa wiki)
into an existing Eclipse environment.
- </para>
- <para>
- If just the service validation capabilities are being used, then no further
configuration of the Eclipse environment is necessary.
- However if the conversational ESB actions, with conformance checking against a
Choreography Description, will be used, then the following additional steps will be
required:
- </para>
- <para>
- <itemizedlist>
- <listitem>
- Start the Eclipse environment
- </listitem>
- <listitem>
- Select the “Help - > Software Updates...” menu item
- </listitem>
- <listitem>
- From the <emphasis role="bold"> Available
Software</emphasis> tab, press the “Add Site...” button
- </listitem>
- <listitem>
- Press the <emphasis role="bold">“Local”</emphasis> button,
browse to locate the <emphasis role="bold">tools</emphasis> folder
in the Overlord CDL distribution,
- and then press the OK button. This will cause the local Eclipse update site,
bundled with the Overlord CDL distribution, to be add to the <emphasis
role="bold"> Available Software </emphasis> tab.
- </listitem>
- <listitem>
- Select the root node of the newly added local update site, and then press the
<emphasis role="bold">“Install”</emphasis> button and follow the
instructions to install the plugins.
-
- <note>
- <para>
- An eclipse issue occasionally causes the nodes under the checked root node
- to become unchecked, resulting in the software update manager indicating
- that no plugins need to be installed. If this happens, simply uncheck the
- root node, and then re-check the root node and press the
- <emphasis role="bold">“Install”</emphasis> button again.
- </para>
- </note>
- </listitem>
- </itemizedlist>
- </para>
- </listitem>
-
- </orderedlist>
- </section>
-
-</chapter>
Added: cdl/trunk/docs/docbook/userguide/src/main/module/overview.xml
===================================================================
--- cdl/trunk/docs/docbook/userguide/src/main/module/overview.xml
(rev 0)
+++ cdl/trunk/docs/docbook/userguide/src/main/module/overview.xml 2008-11-10 15:33:53 UTC
(rev 428)
@@ -0,0 +1,8 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
+]>
+<chapter id="overview">
+ <title>Overview</title>
+
+
+</chapter>