[hornetq-commits] JBoss hornetq SVN: r8761 - trunk/docs/quickstart-guide/en.

Author: timfox Date: 2010-01-07 06:21:04 -0500 (Thu, 07 Jan 2010) New Revision: 8761 Modified: trunk/docs/quickstart-guide/en/about.xml trunk/docs/quickstart-guide/en/examples.xml trunk/docs/quickstart-guide/en/installation.xml trunk/docs/quickstart-guide/en/notice.xml trunk/docs/quickstart-guide/en/running.xml Log: edits to quick start guide Modified: trunk/docs/quickstart-guide/en/about.xml =================================================================== --- trunk/docs/quickstart-guide/en/about.xml 2010-01-07 09:59:41 UTC (rev 8760) +++ trunk/docs/quickstart-guide/en/about.xml 2010-01-07 11:21:04 UTC (rev 8761) @@ -23,11 +23,11 @@ <para>What is HornetQ?</para> <itemizedlist> <listitem> - <para>HornetQ is an open source project to build a multi-protocol, embeddable, high + <para>HornetQ is an open source project to build a multi-protocol, embeddable, very high performance, clustered, asynchronous messaging system.</para> </listitem> <listitem> - <para>For answers to more questions about what HornetQ is and isn't please visit + <para>For answers to more questions about what HornetQ is and what it isn't please visit the <ulink url="http://www.jboss.org/community/wiki/HornetQGeneralFAQs">... wiki page</ulink>.</para> </listitem> @@ -46,7 +46,7 @@ from Windows desktops to IBM mainframes.</para> </listitem> <listitem> - <para>Superb performance. Our class beating high performance journal provides persistent + <para>Amazing performance. Our class beating high performance journal provides persistent messaging performance at rates normally seen for non persistent messaging, our non persistent messaging performance rocks the boat too.</para> </listitem> @@ -55,9 +55,9 @@ and others you won't find anywhere else.</para> </listitem> <listitem> - <para>Elegant POJO based design with minimal third party dependencies. Run HornetQ + <para>Elegant, clean-cut design with minimal third party dependencies. Run HornetQ stand-alone, run it in integrated in your favourite JEE application server, or run - it embedded inside your own product.</para> + it embedded inside your own product. It's up to you.</para> </listitem> <listitem> <para>Seamless high availability. We provide a HA solution with automatic client Modified: trunk/docs/quickstart-guide/en/examples.xml =================================================================== --- trunk/docs/quickstart-guide/en/examples.xml 2010-01-07 09:59:41 UTC (rev 8760) +++ trunk/docs/quickstart-guide/en/examples.xml 2010-01-07 11:21:04 UTC (rev 8761) @@ -21,14 +21,14 @@ <para>In the directory <literal>examples</literal> there are 2 sets of examples, these are </para> <itemizedlist> <listitem> - <para>JMS Examples - these demonstrate functionality by sending and consuming JMS + <para>JMS Examples - these demonstrate functionality while sending and consumng JMS messages.</para> </listitem> <listitem> <para>Java EE Examples - these demonstrate application server integration, e.g. MDBs, EJBs, Servlets, etc.</para> </listitem> - </itemizedlist> + </itemizedlist> <section id="examples.jms"> <title>The JMS examples</title> <para>The JMS Examples all follow the same format. Each examples is contained in its own @@ -55,7 +55,8 @@ user manual.</para> <para>Firstly open a Shell or a Command prompt and navigate to the <literal - <para>Type the command <literal>./build.sh</literal> (or <literal>build.bat</literal> if you are running on Windows), and you should see the following output:</para> + <para>Type the command <literal>./build.sh</literal> (or <literal>build.bat</literal> if you + are running on Windows), and you should see the following output:</para> <programlisting>Buildfile: build.xml run: @@ -117,11 +118,11 @@ </section> <section id="examples.messaging"> <title>The Java EE Examples</title> - <para>The Java EE Examples are examples that require an Application Server to run. They - include MDB, Servlet, EJB examples etc. For this you will need The JBoss Application Server + <para>The Java EE Examples are examples that require a JEE application server to run. They + include MDB, Servlet, EJB examples etc. For this you will need the JBoss Application Server installed. How to do this is explained in the previous chapters.</para> <para>We'll use the MDB example for the purposes of this guide. For the other examples refer - to the user guide. Before going any further ensure that the Jboss Application Server is + to the user guide. Before going any further ensure that the JBoss Application Server is running.</para> <para>Like the other Java EE examples the MDB example is a JEE Application which first needs deploying in the JBoss Application Server. The first thing we need to do is set the Modified: trunk/docs/quickstart-guide/en/installation.xml =================================================================== --- trunk/docs/quickstart-guide/en/installation.xml 2010-01-07 09:59:41 UTC (rev 8760) +++ trunk/docs/quickstart-guide/en/installation.xml 2010-01-07 11:21:04 UTC (rev 8761) @@ -29,7 +29,7 @@ <para>For persistence, HornetQ uses its own fast journal, which you can configure to use libaio (which is the default when running on Linux) or Java NIO. In order to use the libaio - module on Linux, it's required to install libaio.</para> + module on Linux, you'll need to install libaio, if it's not already installed.</para> <para>If you're not running on Linux then you don't need to worry about this.</para> <para>You can install libaio using the following steps as the root user:</para> <para>Using yum, (e.g. on Fedora or Red Hat Enterprise Linux):</para> @@ -43,26 +43,31 @@ it should be possible to <link linkend="running.standalone">run straight out of the box</link>, the following describes the directory structure: </para> <programlisting> - |-- bin - |-- config - | |-- jboss-as - | `-- stand-alone - |-- docs - | |-- api - | |-- quickstart-guide - | `-- user-manual - |-- examples - | |-- core - | |-- javaee - | `-- jms - |-- lib - |-- licenses - `-- schemas + |___ bin + | + |___ config + | |___ jboss-as + | ` |___ stand-alone + | + |___ docs + | |___ api + | |___ quickstart-guide + | |___ user-manual + | + |___ examples + | |___ core + | |___ javaee + | |___ jms + | + |___ lib + | + |___ licenses + | + |___ schemas </programlisting> <itemizedlist> <listitem> - <para><literal>bin</literal> -- binaries and scripts needed to run JBoss - Messaging</para> + <para><literal>bin</literal> -- binaries and scripts needed to run HornetQ.</para> </listitem> <listitem> <para><literal>config</literal> -- configuration files needed to configure HornetQ. This @@ -91,8 +96,9 @@ <section id="installation.jboss.as5"> <title>HornetQ In JBoss Application Server 5.x</title> <para>HornetQ can also be deployed in <ulink url="http://www.jboss.org/jbossas/">JBoss AS - 5</ulink>. It is not shipped by default with the application server and you need to - create new AS 5 profiles to run AS 5 with HornetQ.</para> + 5</ulink>. It is not currently shipped by default with the application server (it is + scheduled to be shipped as default JMS provider in JBoss Application Server 6.0), so you + will need to create new AS 5 profiles to run AS 5 with HornetQ.</para> <para>To create AS 5 profiles:</para> <orderedlist> <listitem> @@ -120,16 +126,13 @@ is <emphasis>clustered</emphasis></para> </listitem> </itemizedlist> - <para>You can then start JBoss AS 5 using one of these profiles:</para> + <para>You can then start JBoss AS 5 using one of these profiles, e.g. :</para> <programlisting>$JBOSS_HOME/bin/run.sh -c default-with-hornetq</programlisting> </section> <section id="installation.jboss.as4"> <title>HornetQ In JBoss Application Server 4.x</title> - <note> - <para>HornetQ can be deployed on AS 4 but isn't recommended</para> - </note> - <para>As in AS 4, it is not shipped by default with the application server and you need to - create new AS 4 profiles to run AS 4 with HornetQ.</para> + <para>As in AS 4, it is not shipped by default with the application server, so you will need + to create new AS 4 profiles to run AS 4 with HornetQ.</para> <para>To create AS 4 profiles:</para> <orderedlist> <listitem> Modified: trunk/docs/quickstart-guide/en/notice.xml =================================================================== --- trunk/docs/quickstart-guide/en/notice.xml 2010-01-07 09:59:41 UTC (rev 8760) +++ trunk/docs/quickstart-guide/en/notice.xml 2010-01-07 11:21:04 UTC (rev 8761) @@ -19,7 +19,7 @@ <chapter id="notice"> <title>Legal Notice</title> - <para>Copyright © 2009 Red Hat, Inc. and others.</para> + <para>Copyright © 2010 Red Hat, Inc. and others.</para> <para>The text of and illustrations in this document are licensed by Red Hat under a Creative Commons Attribution–Share Alike 3.0 Unported license ("CC-BY-SA").</para> <para>An explanation of CC-BY-SA is available at Modified: trunk/docs/quickstart-guide/en/running.xml =================================================================== --- trunk/docs/quickstart-guide/en/running.xml 2010-01-07 09:59:41 UTC (rev 8760) +++ trunk/docs/quickstart-guide/en/running.xml 2010-01-07 11:21:04 UTC (rev 8761) @@ -1,5 +1,4 @@ <?xml version="1.0" encoding="UTF-8"?> - <!-- ============================================================================= --> <!-- Copyright © 2009 Red Hat, Inc. and others. --> <!-- --> @@ -17,7 +16,6 @@ <!-- and agrees not to assert, Section 4d of CC-BY-SA to the fullest extent --> <!-- permitted by applicable law. --> <!-- ============================================================================= --> - <chapter id="running"> <title>Starting The Server</title> <section id="running.standalone"> @@ -31,40 +29,39 @@ 15:05:54,108 INFO @main [HornetQBootstrapServer] Starting HornetQ server ... 15:06:02,566 INFO @main [HornetQServerImpl] HornetQ Server version - 2.0.0.BETA5 (buzz-buzz, 107) started + 2.0.0.CR3 (yellowjacket, 111) started </programlisting> - <para>HornetQ is now running. If any errors are displayed or if the server was not - started properly, please refer to the troubleshooting guide for help</para> + <para>HornetQ is now running.</para> <para>Both the run and the stop scripts use the config under <literal by running <literal>./run.sh ../config/stand-alone/clustered</literal> or another config of your choosing. This is the same for the stop script and the windows bat files.</para> </section> <section id="running.jboss.as5"> - <title>HornetQ In JBoss AS 5</title> + <title>HornetQ In JBoss AS 5.x</title> <para>To run HornetQ in JBoss AS 5, you need to create the <link - linkend="installation.jboss.as5">AS 5 profiles for HornetQ</link> first. Then run - JBoss AS 5 with one these profiles. For example, to run JBoss AS 5 with a + linkend="installation.jboss.as5">AS 5 profiles for HornetQ</link> first. Then run JBoss + AS 5 with one these profiles. For example, to run JBoss AS 5 with a <emphasis>non-clustered</emphasis> HornetQ server, got to <literal <programlisting> bin$ ./run.sh -c default-with-hornetq 15:18:35,460 INFO [ServerImpl] Starting JBoss (Microcontainer)... - 15:18:35,462 INFO [ServerImpl] Release ID: JBoss [The Oracle] 5.1.0.CR1 (build: - SVNTag=JBoss_5_1_0_CR1 date=200904091504) + 15:18:35,462 INFO [ServerImpl] Release ID: JBoss (Microcontainer) [5.1.0.GA (build: SVNTag= + JBoss_5_1_0_GA date=200905221053) ... 15:19:30,305 INFO [HornetQServerImpl] HornetQ Server version - 2.0.0.BETA5 (buzz-buzz, 107) started + 2.0.0.CR3 (yellowjacket, 111) started ... - 15:19:43,601 INFO [ServerImpl] JBoss (Microcontainer) [5.1.0.CR1 (build: - SVNTag=JBoss_5_1_0_CR1 date=200904091504)] Started in 1m:8s:121ms + 15:19:43,601 INFO [ServerImpl] JBoss (Microcontainer) [5.1.0.GA (build: SVNTag= + JBoss_5_1_0_GA date=200905221053)]Started in 1m:14s:556ms </programlisting> </section> <section id="running.jboss.as4"> - <title>HornetQ In JBoss AS 5</title> - <para>To run HornetQ in JBoss AS 4 you must follow the same steps described for AS5 without forgetting to create the <link - linkend="installation.jboss.as4">AS 4 profiles for HornetQ</link> first. - </para> + <title>HornetQ In JBoss AS 4.x</title> + <para>To run HornetQ in JBoss AS 4 you must follow the same steps described for AS5 without + forgetting to create the <link linkend="installation.jboss.as4">AS 4 profiles for + HornetQ</link> first. </para> </section> </chapter>