qpid-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From tr...@apache.org
Subject svn commit: r1583756 - /qpid/dispatch/trunk/doc/book/TODO
Date Tue, 01 Apr 2014 19:13:24 GMT
Author: tross
Date: Tue Apr  1 19:13:23 2014
New Revision: 1583756

URL: http://svn.apache.org/r1583756
Log:
NO-JIRA - TODO list for the documentation

Added:
    qpid/dispatch/trunk/doc/book/TODO

Added: qpid/dispatch/trunk/doc/book/TODO
URL: http://svn.apache.org/viewvc/qpid/dispatch/trunk/doc/book/TODO?rev=1583756&view=auto
==============================================================================
--- qpid/dispatch/trunk/doc/book/TODO (added)
+++ qpid/dispatch/trunk/doc/book/TODO Tue Apr  1 19:13:23 2014
@@ -0,0 +1,76 @@
+;;
+;; Licensed to the Apache Software Foundation (ASF) under one
+;; or more contributor license agreements.  See the NOTICE file
+;; distributed with this work for additional information
+;; regarding copyright ownership.  The ASF licenses this file
+;; to you under the Apache License, Version 2.0 (the
+;; "License"); you may not use this file except in compliance
+;; with the License.  You may obtain a copy of the License at
+;; 
+;;   http://www.apache.org/licenses/LICENSE-2.0
+;; 
+;; Unless required by applicable law or agreed to in writing,
+;; software distributed under the License is distributed on an
+;; "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+;; KIND, either express or implied.  See the License for the
+;; specific language governing permissions and limitations
+;; under the License.
+;;
+
+Proposed Outline for the Dispatch documentation:
+
+  - Books:
+    - Introduction and Tutorial
+      - Why would you use Dispatch
+      - Where does it fit in the Apache Qpid picture
+      - Install and run a simple deployment
+      - Run some example applications on your simple deployment
+        - Broadcast to multiple receivers
+        - Balance handling of requests across several servers
+
+    - Installation and Deployment Manual
+      - Install from source or binary distribution
+      - Understand the configuration file
+      - Set up a logging framework
+        - Log sources and severities
+        - Syslog
+        - Log files and log rotation
+      - Deploy a network of routers
+        - Network topology for best availability
+        - Topologies for multiple regions or sites
+        - Topologies that reach into private IP networks
+        - Using "Edge" routers for concentration and increased scale
+      - Establish secure inter-router connections (SSL/x.509)
+      - Scale access using multiple routers behind a load balancer
+
+    - User Manual
+      - A comprehensive set of examples for use-cases X platforms/APIs
+      - Explanation of Addressing and guidance for how to map addresses into an application
+      - Interacting with the management agent
+        - Limitations based on user access
+
+    - Operations Manual
+      - Monitoring and Management
+      - Troubleshooting
+      - Tracing routes
+      - Interpreting the logs
+      - Scripting against the management agent
+
+    - Technical Specifications
+      - How Dispatch uses AMQP
+        - Header usage
+        - Support for address fields in message and terminus
+        - Routable address format
+      - Support for the AMQP Management specification
+        - Management operations
+        - Management entities
+        - Management node tracking
+      - Route computation
+        - The Dispatch link-state protocol
+        - Route computation algorithms
+      - Address semantics
+        - Multicast over multiple routers
+        - Closest Subscriber
+        - Spread Subscribers
+        - Balanced Message Delivery
+      - Performance



---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@qpid.apache.org
For additional commands, e-mail: commits-help@qpid.apache.org


Mime
View raw message