Revision: 0b1d8255da45
Author: [email protected] <[email protected]>
Date: Wed Jan 2 10:03:19 2013
Log: diameter-sh-client doc review
http://code.google.com/p/jain-slee/source/detail?r=0b1d8255da45&repo=diameter
Modified:
/resources/diameter-sh-client/docs/sources/src/main/resources/en-US/Chapter-Setup.xml
/resources/diameter-sh-client/docs/sources/src/main/resources/en-US/ra-type/Chapter-Resource_Adaptor_Type.xml
/resources/diameter-sh-client/docs/sources/src/main/resources/en-US/ra/Chapter-Resource_Adaptor.xml
=======================================
---
/resources/diameter-sh-client/docs/sources/src/main/resources/en-US/Chapter-Setup.xml
Tue Sep 11 20:38:40 2012
+++
/resources/diameter-sh-client/docs/sources/src/main/resources/en-US/Chapter-Setup.xml
Wed Jan 2 10:03:19 2013
@@ -10,15 +10,22 @@
<section id="preinstall_requirements_and_prerequisites">
<title>Pre-Install Requirements and Prerequisites</title>
- <para>Ensure that the following requirements have been met before
continuing with the install.</para>
+ <para>Ensure that the following requirements have been met before
continuing with the installation.</para>
<section id="hardware_requirements">
<title>Hardware Requirements</title>
- <para>The Resource Adaptor hardware's main concern is RAM memory and
Java Heap size, the more the better. For instance, while the underlying
&THIS.PLATFORM; JAIN SLEE may run with 1GB of RAM, 8GB is needed to achieve
performance higher than 800 new requests per second.</para>
- <para>Of course, memory is only needed to store the Resource Adaptor
state, the faster the CPU more requests per second are supported, yet no
particular CPU is a real requirement to use the RA.</para>
+
+
+<para>
+RAM and Java Heap size are very important with regards to Resource
Adaptor. The more the RAM, the better the performance will be. For
instance, while the underlying Mobicents JAIN SLEE may run with 1GB of RAM,
8GB is needed to achieve performance higher than 800 new requests per
second.</para>
+<para>
+Memory is only needed to store the Resource Adaptor state. Therefore, the
faster the CPU, the more requests per second can be quickly processed. That
said, there is no minimum specified CPU speed required to use the RA.
+</para>
+
+
</section>
<section id="software_prerequisites">
<title>Software Prerequisites</title>
- <para>The RA requires &THIS.PLATFORM; JAIN SLEE properly set and
Mobicents Diameter Multiplexer (<acronym>MUX</acronym>), which includes the
stack, and &THIS.PLATFORM; Diameter Base RA to be properly installed
too.</para>
+ <para>The RA requires &THIS.PLATFORM; JAIN SLEE correctly set and
Mobicents Diameter Multiplexer (<acronym>MUX</acronym>), which includes the
stack, and &THIS.PLATFORM; Diameter Base RA to be properly installed.</para>
</section>
</section>
@@ -32,7 +39,8 @@
<step>
<title>Downloading the source code</title>
<important>
- <para>Git is used to manage Mobicents JAIN SLEE source code.
Instructions for downloading, installing and using Git can be found at
<ulink url="http://git-scm.com/"; /></para>
+<para>Use Git to checkout a specific release source. The Git repository
URL is located at &THIS.SOURCE_CODE_URL;. Choose the desired release
version as can be seen in the following example &THIS.VERSION;.</para>
+
</important>
<para>Use Git to checkout a specific release source, the Git
repository URL is &THIS.SOURCE_CODE_URL; , then switch to the specific
release version, lets consider &THIS.VERSION;.</para>
<programlisting>
@@ -51,7 +59,7 @@
[usr]$ cd resources/&THIS.RA.DIRNAME;
[usr]$ mvn install
</programlisting>
- <para>Once the process finishes you should have the
<literal>deployable-unit</literal> jar file in the
<filename>target</filename> directory, if &THIS.PLATFORM; JAIN SLEE is
installed and environment variable JBOSS_HOME is pointing to its underlying
&JEE.PLATFORM; directory, then the deployable unit jar will also be
deployed in the container.</para>
+ <para>Once the build is completed, you should have the
<literal>deployable-unit</literal> jar file in the
<filename>target</filename> directory, if &THIS.PLATFORM; JAIN SLEE is
installed and environment variable JBOSS_HOME is pointing to its underlying
&JEE.PLATFORM; directory, then the deployable unit jar will also be
deployed in the container.</para>
</step>
</procedure>
</section>
@@ -72,7 +80,11 @@
<programlisting>
[usr]$ ant
</programlisting>
- <para>The script will copy the RA deployable unit jar to the
<literal>default</literal> &THIS.PLATFORM; JAIN SLEE server profile deploy
directory, to deploy to another server profile use the argument
<literal>-Dnode=</literal>.</para>
+
+<para>
+The script will copy the RA deployable unit jar to the
<literal>default</literal> &THIS.PLATFORM; server/default/deploy directory.
To deploy to another server profile, use the argument
<literal>-Dnode=</literal>.
+</para>
+
</section>
<section id="uninstall">
=======================================
---
/resources/diameter-sh-client/docs/sources/src/main/resources/en-US/ra-type/Chapter-Resource_Adaptor_Type.xml
Sun Aug 12 10:49:01 2012
+++
/resources/diameter-sh-client/docs/sources/src/main/resources/en-US/ra-type/Chapter-Resource_Adaptor_Type.xml
Wed Jan 2 10:03:19 2013
@@ -9,7 +9,7 @@
<title>Resource Adaptor Type</title>
- <para>&THIS.RA; Resource Adaptor Type is defined by Mobicents team as
part of effort to standardize RA Types.</para>
+ <para>&THIS.RA; Resource Adaptor Type is defined by Mobicents team as
part of the effort to standardize RA Types.</para>
<xi:include
xmlns:xi="http://www.w3.org/2001/XInclude";
=======================================
---
/resources/diameter-sh-client/docs/sources/src/main/resources/en-US/ra/Chapter-Resource_Adaptor.xml
Sun Aug 12 10:49:01 2012
+++
/resources/diameter-sh-client/docs/sources/src/main/resources/en-US/ra/Chapter-Resource_Adaptor.xml
Wed Jan 2 10:03:19 2013
@@ -9,7 +9,7 @@
<title>Resource Adaptor Implementation</title>
- <para>This <acronym>RA</acronym> uses the &THIS.PLATFORM; Diameter Stack,
an improvement over <ulink url="http://jdiameter.dev.java.net";>jDiameter
Stack</ulink>. The stack is the result of the work done by &THIS.PLATFORM;
Diameter and jDiameter development teams, and source code is provided in
all releases.</para>
+ <para>This <acronym>RA</acronym> uses the &THIS.PLATFORM; Diameter Stack
which is an improvement over <ulink
url="http://jdiameter.dev.java.net";>jDiameter Stack</ulink>. The stack is
the result of the work done by the &THIS.PLATFORM; Diameter and the
jDiameter development teams. The source code is provided in all
releases.</para>
<xi:include
xmlns:xi="http://www.w3.org/2001/XInclude";
