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

Author: timfox Date: 2009-08-21 13:09:53 -0400 (Fri, 21 Aug 2009) New Revision: 7875 Modified: trunk/docs/quickstart-guide/en/about.xml trunk/docs/quickstart-guide/en/download.xml trunk/docs/quickstart-guide/en/examples.xml trunk/docs/quickstart-guide/en/installation.xml trunk/docs/quickstart-guide/en/introduction.xml trunk/docs/quickstart-guide/en/notice.xml Log: more tweaks to docs Modified: trunk/docs/quickstart-guide/en/about.xml =================================================================== --- trunk/docs/quickstart-guide/en/about.xml 2009-08-21 16:59:00 UTC (rev 7874) +++ trunk/docs/quickstart-guide/en/about.xml 2009-08-21 17:09:53 UTC (rev 7875) @@ -20,21 +20,43 @@ <chapter id="about"> <title>About HornetQ</title> - <para>The goal of HornetQ is simple and uncompromising: to bring unrivaled levels of - performance and reliability to messaging, and to be the fastest, best featured, and most - scalable multi-protocol messaging system.</para> - <para>Why use HornetQ? Here are a few of the reasons:</para> + <para>What is HornetQ?</para> <itemizedlist> <listitem> - <para>100% open source software.</para> + <para>HornetQ is an open source project to build a multi-protocol, embeddable, high + performance, clustered, asynchronous messaging system.</para> </listitem> <listitem> - <para>Written in Java. Runs on any platform with a J2SE 5.0 JDK, that's everything from - Windows desktops to IBM mainframes.</para> + <para>HornetQ is an example of Message Oriented Middleware (MoM) For a description of + MoMs and other messaging concepts please see the <xref linkend="messaging-concepts" + />.</para> </listitem> <listitem> + <para>HornetQ is Red Hat's flagship Java messaging system.</para> + </listitem> + <listitem> + <para>For answers to more questions about what HornetQ is and isn't please visit + the <ulink url="http://www.jboss.org/community/wiki/HornetQGeneralFAQs">... wiki + page</ulink>.</para> + </listitem> + </itemizedlist> + <para>Why use HornetQ? Here are just a few of the reasons:</para> + <itemizedlist> + <listitem> + <para>100% open source software. HornetQ is licenced using the Apache Software License v + 2.0 to minimise barriers to adoption.</para> + </listitem> + <listitem> + <para>HornetQ is designed with usability in mind.</para> + </listitem> + <listitem> + <para>Written in Java. Runs on any platform with a Java 5+ runtime, that's everything + from Windows desktops to IBM mainframes.</para> + </listitem> + <listitem> <para>Superb performance. Our class beating high performance journal provides persistent - messaging performance at rates normally seen for non persistent messaging.</para> + messaging performance at rates normally seen for non persistent messaging, our non + persistent messaging performance rocks the boat too.</para> </listitem> <listitem> <para>Full feature set. All the features you'd expect in any serious messaging system, @@ -42,13 +64,13 @@ </listitem> <listitem> <para>Elegant POJO based design with minimal third party dependencies. Run HornetQ - stand-alone, run it in integrated in your favourite Java EE Application - Server or IoC container, or run it embedded inside your own product.</para> + stand-alone, run it in integrated in your favourite JEE application server, or run + it embedded inside your own product.</para> </listitem> <listitem> - <para>Seamless high availability. We provide server replication and completely - transparent client failover so you don't have to worry about coding your client - specially for an HA environment.</para> + <para>Seamless high availability. We provide a HA solution with automatic client + failover so you can guarantee zero message loss or duplication in event of server + failure.</para> </listitem> <listitem> <para>Hugely flexible clustering. Create clusters of servers that know how to load @@ -56,5 +78,10 @@ connections to form a global network. Configure routing of messages in a highly flexible way.</para> </listitem> + <listitem> + <para>For a full list of features, please see the <ulink + url="http://www.jboss.org/community/wiki/HornetQFeatures">fe... wiki + page</ulink> .</para> + </listitem> </itemizedlist> </chapter> \ No newline at end of file Modified: trunk/docs/quickstart-guide/en/download.xml =================================================================== --- trunk/docs/quickstart-guide/en/download.xml 2009-08-21 16:59:00 UTC (rev 7874) +++ trunk/docs/quickstart-guide/en/download.xml 2009-08-21 17:09:53 UTC (rev 7875) @@ -1,5 +1,4 @@ <?xml version="1.0" encoding="UTF-8"?> - <!-- ============================================================================= --> <!-- Copyright © 2009 Red Hat, Inc. and others. --> <!-- --> @@ -17,28 +16,55 @@ <!-- and agrees not to assert, Section 4d of CC-BY-SA to the fullest extent --> <!-- permitted by applicable law. --> <!-- ============================================================================= --> - <chapter id="download"> <title>Download</title> - <para>The official HornetQ project page is <ulink - url="http://hornetq.org/">http://hornetq.org/</ulink>.... - + <para>The official HornetQ project page is <ulink url="http://hornetq.org/" + >http://hornetq.org/</ulink>.</para> <section id="download.software"> - <title>Software Download</title> - <para>The software can be download from the Download page:<ulink - url="http://hornetq.org/downloads.html/">http://hornetq.org/... + <title>Software Download</title> + <para>The software can be download from the Download page:<ulink + url="http://hornetq.org/downloads.html/" + >http://hornetq.org/downloads.html</ulink></para> </section> - <section id="download.svn"> <title>Project Information</title> - <para>If you have any user questions please use our <ulink - url="http://n2.nabble.com/hornetq-users-f3404100.html">user - forum</ulink></para> - <para>If you have development related questions, please use our <ulink - url="http://n2.nabble.com/hornetq-dev-f3404069.html">develop... - forum</ulink></para> - <para>Pop in and chat to us in our <ulink url="irc://irc.freenode.net:6667/hornetq">IRC channel</ulink></para> - <para>HornetQ Subversion trunk is <ulink url="http://anonsvn.jboss.org/repos/hornetq/trunk">http://an... - <para>All release tags are available from <ulink url="http://anonsvn.jboss.org/repos/hornetq/tags">http://ano... + <para> + <itemizedlist> + <listitem> + <para>Please take a look at our project <ulink + url="http://www.jboss.org/community/wiki/HornetQ">wiki</u... + </listitem> + <listitem> + <para>If you have any user questions please use our <ulink + url="http://www.jboss.org/index.html?module=bb&amp;op=viewforum&... + forum</ulink></para> + </listitem> + <listitem> + <para>If you have development related questions, please use our <ulink + url="http://www.jboss.org/index.html?module=bb&amp;op=viewforum&... + >developer forum</ulink></para> + </listitem> + <listitem> + <para>Pop in and chat to us in our <ulink url="irc://irc.freenode.net:6667/hornetq" + >IRC channel</ulink></para> + </listitem> + <listitem> + <para>Our project <ulink url="http://hornetq.blogspot.com/">blog</ulink></pa... + </listitem> + <listitem> + <para>Follow us on <ulink url="http://twitter.com/hornetq">twitter</ulink></p... + </listitem> + <listitem> + <para>HornetQ Subversion trunk is <ulink + url="http://anonsvn.jboss.org/repos/hornetq/trunk" + >http://anonsvn.jboss.org/repos/hornetq/trunk</ulink></para> + </listitem> + <listitem> + <para>All release tags are availble from <ulink + url="http://anonsvn.jboss.org/repos/hornetq/tags" + >http://anonsvn.jboss.org/repos/hornetq/tags</ulink></para> + </listitem> + </itemizedlist> + </para> </section> -</chapter> \ No newline at end of file +</chapter> Modified: trunk/docs/quickstart-guide/en/examples.xml =================================================================== --- trunk/docs/quickstart-guide/en/examples.xml 2009-08-21 16:59:00 UTC (rev 7874) +++ trunk/docs/quickstart-guide/en/examples.xml 2009-08-21 17:09:53 UTC (rev 7875) @@ -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="examples"> <title>Running the Examples</title> <para>In the directory <literal>examples</literal> there are 2 sets of examples, these are </para> @@ -116,8 +114,8 @@ BUILD SUCCESSFUL Total time: 13 seconds </programlisting> - <para>Congratulations! You have successfully run your first HornetQ example. Try some - of the others.</para> + <para>Congratulations! You have successfully run your first HornetQ example. Try some of the + others.</para> </section> <section id="examples.messaging"> <title>The Java EE Examples</title> @@ -127,7 +125,7 @@ <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 running.</para> - <para>Like the other Java EE examples the MDB example is a J2EE Application which first needs + <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 <literal>JBOSS_HOME</literal> environment property to the location of the JBoss Application Server, in a Linux shell this would be something like:</para> Modified: trunk/docs/quickstart-guide/en/installation.xml =================================================================== --- trunk/docs/quickstart-guide/en/installation.xml 2009-08-21 16:59:00 UTC (rev 7874) +++ trunk/docs/quickstart-guide/en/installation.xml 2009-08-21 17:09:53 UTC (rev 7875) @@ -1,5 +1,4 @@ <?xml version="1.0" encoding="UTF-8"?> - <!-- ============================================================================= --> <!-- Copyright © 2009 Red Hat, Inc. and others. --> <!-- --> @@ -17,21 +16,20 @@ <!-- and agrees not to assert, Section 4d of CC-BY-SA to the fullest extent --> <!-- permitted by applicable law. --> <!-- ============================================================================= --> - <chapter id="installation"> <title>Installation</title> <para>This section describes how to install HornetQ. </para> <section id="installation.prerequisites"> <title>Prerequisites</title> <note> - <para>HornetQ only runs on Java 5 or later. We highly recommend to use Java - 6.</para> + <para>HornetQ only runs on Java 5 or later. We highly recommend to use Java 6.</para> </note> - <para>By default, HornetQ server is run with 1GB of memory. If your computer has less - memory, modify the value in <literal>bin/run.sh</literal> accordingly.</para> - <para>For persistence, HornetQ uses its own fast journal file, 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> + <para>By default, HornetQ server is run with 1GiB of memory. If your computer has less memory, + or you want to run it with more available RAM, modify the value in <literal + >bin/run.sh</literal> accordingly.</para> + <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> <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:</para> <para>Using yum, (e.g. on Fedora or Red Hat Enterprise Linux):</para> @@ -69,9 +67,9 @@ Messaging</para> </listitem> <listitem> - <para><literal>config</literal> -- configuration files needed to configure HornetQ. This contains configurations to run HornetQ either in stand-alone - or inside JBoss AS 5. Please refer to the reference guide for details on - configuration. </para> + <para><literal>config</literal> -- configuration files needed to configure HornetQ. This + contains configurations to run HornetQ either in stand-alone or inside JBoss AS 5. + Please refer to the reference guide for details on configuration. </para> </listitem> <listitem> <para><literal>docs</literal> -- guides and javadocs for HornetQ </para> @@ -87,16 +85,16 @@ <para><literal>licenses</literal> -- licenses for HornetQ </para> </listitem> <listitem> - <para><literal>schemas</literal> -- XML Schemas used to validate HornetQ - configuration files</para> + <para><literal>schemas</literal> -- XML Schemas used to validate HornetQ configuration + files</para> </listitem> </itemizedlist> </section> <section id="installation.jboss"> <title>HornetQ In JBoss AS 5</title> - <para>HornetQ can 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> + <para>HornetQ can 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> <para>To create AS 5 profiles:</para> <orderedlist> <listitem> @@ -115,12 +113,12 @@ <itemizedlist> <listitem> <para><literal>default-with-hornetq</literal> -- it corresponds to AS 5 <literal - >default</literal> profile with HornetQ as its JMS provider. In this - profile, HornetQ is <emphasis>non-clustered</emphasis></para> + >default</literal> profile with HornetQ as its JMS provider. In this profile, + HornetQ is <emphasis>non-clustered</emphasis></para> </listitem> <listitem> - <para><literal>all-with-hornetq</literal> -- it corresponds to AS 5 <literal>all</literal> - profile with HornetQ as its JMS provider. In this profile, HornetQ + <para><literal>all-with-hornetq</literal> -- it corresponds to AS 5 <literal + >all</literal> profile with HornetQ as its JMS provider. In this profile, HornetQ is <emphasis>clustered</emphasis></para> </listitem> </itemizedlist> Modified: trunk/docs/quickstart-guide/en/introduction.xml =================================================================== --- trunk/docs/quickstart-guide/en/introduction.xml 2009-08-21 16:59:00 UTC (rev 7874) +++ trunk/docs/quickstart-guide/en/introduction.xml 2009-08-21 17:09:53 UTC (rev 7875) @@ -1,5 +1,4 @@ <?xml version="1.0" encoding="UTF-8"?> - <!-- ============================================================================= --> <!-- Copyright © 2009 Red Hat, Inc. and others. --> <!-- --> @@ -17,12 +16,12 @@ <!-- and agrees not to assert, Section 4d of CC-BY-SA to the fullest extent --> <!-- permitted by applicable law. --> <!-- ============================================================================= --> - <chapter id="introduction"> <title>Getting Started</title> - <para>This short guide explains how to download, install and quickly get started with HornetQ.</para> + <para>This short guide explains how to download, install and quickly get started with + HornetQ.</para> <para>After downloading and installing we highly recommend you run the examples to get - acquainted with HornetQ. We ship with over 50 examples demonstrating most of the + acquainted with HornetQ. We ship with over 65 examples demonstrating most of the features.</para> <para>This guide is not intended to be a replacement for the user manual. The user manual goes into much more depth, so please consult that for further information.</para> Modified: trunk/docs/quickstart-guide/en/notice.xml =================================================================== --- trunk/docs/quickstart-guide/en/notice.xml 2009-08-21 16:59:00 UTC (rev 7874) +++ trunk/docs/quickstart-guide/en/notice.xml 2009-08-21 17:09:53 UTC (rev 7875) @@ -19,8 +19,6 @@ <chapter id="notice"> <title>Legal Notice</title> - <graphic fileref="images/hornetQ_logo_600px.png" /> - <para>Copyright © 2009 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>