activemq-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From jbert...@apache.org
Subject [1/2] activemq-6 git commit: Updates to Documentation
Date Fri, 23 Jan 2015 16:56:11 GMT
Repository: activemq-6
Updated Branches:
  refs/heads/master 51793627f -> 005af9dea


Updates to Documentation


Project: http://git-wip-us.apache.org/repos/asf/activemq-6/repo
Commit: http://git-wip-us.apache.org/repos/asf/activemq-6/commit/4c2f0619
Tree: http://git-wip-us.apache.org/repos/asf/activemq-6/tree/4c2f0619
Diff: http://git-wip-us.apache.org/repos/asf/activemq-6/diff/4c2f0619

Branch: refs/heads/master
Commit: 4c2f0619556023e7a115d461759af2df6e80f59f
Parents: 5179362
Author: Martyn Taylor <mtaylor@redhat.com>
Authored: Wed Jan 21 18:46:15 2015 +0000
Committer: Martyn Taylor <mtaylor@redhat.com>
Committed: Fri Jan 23 16:51:08 2015 +0000

----------------------------------------------------------------------
 docs/user-manual/en/book.json            | 19 +++++++-------
 docs/user-manual/en/using-jms.md         | 36 +++++++++++++--------------
 docs/user-manual/en/using-server.md      | 17 ++++---------
 docs/user-manual/en/vertx-integration.md |  4 +--
 docs/user-manual/en/wildcard-syntax.md   |  2 +-
 5 files changed, 35 insertions(+), 43 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/activemq-6/blob/4c2f0619/docs/user-manual/en/book.json
----------------------------------------------------------------------
diff --git a/docs/user-manual/en/book.json b/docs/user-manual/en/book.json
index 7469213..cea7872 100644
--- a/docs/user-manual/en/book.json
+++ b/docs/user-manual/en/book.json
@@ -1,12 +1,11 @@
 {
-  "title": "ActiveMQ Documentation",
-  "description": "ActiveMQ User Guide and Reference Documentation",
-  "github": "apache/activemq-6",
-  "githubHost": "https://github.com/",
-
-  "links": {
-    "home": "http://activemq.apache.org/",
-    "issues": "http://activemq.apache.org/",
-    "contribute": "http://activemq.apache.org/contributing.html"
-  }
+    "title": "ActiveMQ Documentation",
+    "description": "ActiveMQ User Guide and Reference Documentation",
+    "github": "apache/activemq-6",
+    "githubHost": "https://github.com/",
+    "links": {
+        "home": "http://activemq.apache.org/",
+        "issues": "http://activemq.apache.org/",
+        "contribute": "http://activemq.apache.org/contributing.html"
+    }
 }
\ No newline at end of file

http://git-wip-us.apache.org/repos/asf/activemq-6/blob/4c2f0619/docs/user-manual/en/using-jms.md
----------------------------------------------------------------------
diff --git a/docs/user-manual/en/using-jms.md b/docs/user-manual/en/using-jms.md
index f3f4ce1..0fe7595 100644
--- a/docs/user-manual/en/using-jms.md
+++ b/docs/user-manual/en/using-jms.md
@@ -5,9 +5,8 @@ be more comfortable using JMS.
 
 JMS is a very popular API standard for messaging, and most messaging
 systems provide a JMS API. If you are completely new to JMS we suggest
-you follow the[Sun JMS
-tutorial](http://docs.oracle.com/javaee/1.3/jms/tutorial) - a full JMS
-tutorial is out of scope for this guide.
+you follow the [Oracle JMS tutorial](http://docs.oracle.com/javaee/7/tutorial/partmessaging.htm)
-
+a full JMS tutorial is out of scope for this guide.
 
 ActiveMQ also ships with a wide range of examples, many of which
 demonstrate JMS API usage. A good place to start would be to play around
@@ -34,7 +33,7 @@ single `MessageConsumer` consuming the order message from the queue.
 
 The queue will be a `durable` queue, i.e. it will survive a server
 restart or crash. We also want to pre-deploy the queue, i.e. specify the
-queue in the server JMS configuration so it is created automatically
+queue in the server configuration so it is created automatically
 without us having to explicitly create it from the client.
 
 JNDI Configuration
@@ -47,9 +46,9 @@ they see fit assuming the implementation fits the API. ActiveMQ does not
 have a JNDI server. Rather, it uses a client-side JNDI implementation
 that relies on special properties set in the environment to construct
 the appropriate JMS objects. In other words, no objects are stored in
-JNDI on the ActiveMQ server. There are simply instantiated on the client
-based on the provided configuration. Let's look at the different kinds
-of administered objects and how to configure them.
+JNDI on the ActiveMQ server, instead they are simply instantiated on the
+client based on the provided configuration. Let's look at the different
+kinds of administered objects and how to configure them.
 
 > **Note**
 >
@@ -217,31 +216,31 @@ properties. Here are the different options for the `type`:
 <table>
   <tr>
     <th>type</th>
-    <th>interface</th> 
+    <th>interface</th>
   </tr>
   <tr>
     <td>CF (default)</td>
-    <td>javax.jms.ConnectionFactory</td> 
-  </tr>    
+    <td>javax.jms.ConnectionFactory</td>
+  </tr>
   <tr>
     <td>XA_CF</td>
-    <td>javax.jms.XAConnectionFactory</td> 
+    <td>javax.jms.XAConnectionFactory</td>
   </tr>
   <tr>
     <td>QUEUE_CF</td>
-    <td>javax.jms.QueueConnectionFactory</td> 
+    <td>javax.jms.QueueConnectionFactory</td>
   </tr>
   <tr>
     <td>QUEUE_XA_CF</td>
-    <td>javax.jms.XAQueueConnectionFactory</td> 
+    <td>javax.jms.XAQueueConnectionFactory</td>
   </tr>
   <tr>
     <td>TOPIC_CF</td>
-    <td>javax.jms.TopicConnectionFactory</td> 
+    <td>javax.jms.TopicConnectionFactory</td>
   </tr>
   <tr>
     <td>TOPIC_XA_CF</td>
-    <td>javax.jms.XATopicConnectionFactory</td> 
+    <td>javax.jms.XATopicConnectionFactory</td>
   </tr>
 </table>
 
@@ -349,8 +348,9 @@ With ActiveMQ you can do exactly that. ActiveMQ supports the direct
 instantiation of JMS Queue, Topic and ConnectionFactory instances, so
 you don't have to use JNDI at all.
 
-For a full working example of direct instantiation please see the JMS
-examples in ?.
+>For a full working example of direct instantiation please look at the
+>"Instantiate JMS Objects Directly" example under the JMS section of the
+>examples.  See the [Examples](examples.md) section for more info.
 
 Here's our simple example, rewritten to not use JNDI at all:
 
@@ -359,7 +359,7 @@ Utility class, note we need to provide connection parameters and specify
 which transport we are using, for more information on connectors please
 see [Configuring the Transport](configuring-transports.md).
 
-``` java                  
+``` java
 TransportConfiguration transportConfiguration = new TransportConfiguration(NettyConnectorFactory.class.getName());
 
 ConnectionFactory cf = ActiveMQJMSClient.createConnectionFactoryWithoutHA(JMSFactoryType.CF,transportConfiguration);

http://git-wip-us.apache.org/repos/asf/activemq-6/blob/4c2f0619/docs/user-manual/en/using-server.md
----------------------------------------------------------------------
diff --git a/docs/user-manual/en/using-server.md b/docs/user-manual/en/using-server.md
index 46998be..52c92fe 100644
--- a/docs/user-manual/en/using-server.md
+++ b/docs/user-manual/en/using-server.md
@@ -80,7 +80,8 @@ JVM will use the environment variable `LD_LIBRARY_PATH`.
 ActiveMQ can take a system property on the command line for configuring
 logging.
 
-For more information on configuring logging, please see ?.
+For more information on configuring logging, please see the section on
+[Logging](logging.md).
 
 ## Configuration files
 
@@ -112,7 +113,7 @@ files.
     ConnectionFactorys from this file into JNDI. If you're not using
     JMS, or you don't need to deploy JMS objects on the server side,
     then you don't need this file. For more information on using JMS,
-    please see ?.
+    please see the section on [Logging](logging.md).
 
 > **Note**
 >
@@ -149,7 +150,6 @@ The bootstrap file is very simple. Let's take a look at an example:
     <broker xmlns="http://activemq.org/schema">
 
        <file:core configuration="${activemq.home}/config/stand-alone/non-clustered/activemq-configuration.xml"></core>
-       <file:jms configuration="${activemq.home}/config/stand-alone/non-clustered/activemq-jms.xml"></jms>
 
        <basic-security/>
 
@@ -157,15 +157,8 @@ The bootstrap file is very simple. Let's take a look at an example:
 
 -   core - Instantiates a core server using the configuration file from the
     `configuration` attribute. This is the main broker POJO necessary to
-    do all the real messaging work.
-
--   jms - This deploys any JMS Objects such as JMS Queues, Topics and
-    ConnectionFactory instances from the `activemq-jms.xml` file
-    specified. It also provides a simple management API for manipulating
-    JMS Objects. On the whole it just translates and delegates its work
-    to the core server. If you don't need to deploy JMS Queues, Topics
-    and ConnectionFactories from server side configuration and don't
-    require the JMS management interface this can be disabled.
+    do all the real messaging work.  In addition all JMS objects such as:
+    Queues, Topics and ConnectionFactory instances are configured here.
 
 ## The main configuration file.
 

http://git-wip-us.apache.org/repos/asf/activemq-6/blob/4c2f0619/docs/user-manual/en/vertx-integration.md
----------------------------------------------------------------------
diff --git a/docs/user-manual/en/vertx-integration.md b/docs/user-manual/en/vertx-integration.md
index ea4d6f8..4f5ea79 100644
--- a/docs/user-manual/en/vertx-integration.md
+++ b/docs/user-manual/en/vertx-integration.md
@@ -27,7 +27,7 @@ Shown are the required params for the connector service:
 
 -   `queue`. The name of the ActiveMQ queue to send message to.
 
-As well as these required paramaters there are the following optional
+As well as these required parameters there are the following optional
 parameters
 
 -   `host`. The host name on which the vertx target container is
@@ -42,7 +42,7 @@ parameters
     Default is `activemq`.
 
 -   `vertx-address`. The vertx address to listen to. default is
-    org.apache.activemq.
+    `org.apache.activemq`.
 
 ## Configuring a Vertx Outgoing Connector Service
 

http://git-wip-us.apache.org/repos/asf/activemq-6/blob/4c2f0619/docs/user-manual/en/wildcard-syntax.md
----------------------------------------------------------------------
diff --git a/docs/user-manual/en/wildcard-syntax.md b/docs/user-manual/en/wildcard-syntax.md
index da599d8..6344012 100644
--- a/docs/user-manual/en/wildcard-syntax.md
+++ b/docs/user-manual/en/wildcard-syntax.md
@@ -5,7 +5,7 @@ settings, address settings and when creating consumers.
 
 The syntax is similar to that used by [AMQP](http://www.amqp.org).
 
-A ActiveMQ wildcard expression contains words delimited by the character
+An ActiveMQ wildcard expression contains words delimited by the character
 '`.`' (full stop).
 
 The special characters '`#`' and '`*`' also have special meaning and can


Mime
View raw message