Преглед на файлове

Make it more prominent that MongoDB,SQL,SQS, etc transports are experimental

Ask Solem преди 11 години
родител
ревизия
c477d9bee6

+ 7 - 0
docs/getting-started/brokers/couchdb.rst

@@ -4,6 +4,13 @@
  Using CouchDB
 ===============
 
+.. admonition:: Experimental Status
+
+    The CouchDB transport is in need of improvements in many areas and there
+    are several open bugs.  Sadly we don't have the resources or funds
+    required to improve the situation, so we're looking for contributors
+    and partners willing to help.
+
 .. _broker-couchdb-installation:
 
 Installation

+ 7 - 0
docs/getting-started/brokers/django.rst

@@ -4,6 +4,13 @@
  Using the Django Database
 ===========================
 
+.. admonition:: Experimental Status
+
+    The Django database transport is in need of improvements in many areas
+    and there are several open bugs.  Sadly we don't have the resources or funds
+    required to improve the situation, so we're looking for contributors
+    and partners willing to help.
+
 .. _broker-django-installation:
 
 Installation

+ 7 - 0
docs/getting-started/brokers/index.rst

@@ -19,6 +19,13 @@ Broker Instructions
 
     rabbitmq
     redis
+
+Experimental Transports
+=======================
+
+.. toctree::
+    :maxdepth: 1
+
     sqlalchemy
     django
     mongodb

+ 7 - 0
docs/getting-started/brokers/mongodb.rst

@@ -4,6 +4,13 @@
  Using MongoDB
 ===============
 
+.. admonition:: Experimental Status
+
+    The SQS transport is in need of improvements in many areas and there
+    are several open bugs.  Sadly we don't have the resources or funds
+    required to improve the situation, so we're looking for contributors
+    and partners willing to help.
+
 .. _broker-mongodb-installation:
 
 Installation

+ 7 - 0
docs/getting-started/brokers/sqlalchemy.rst

@@ -4,6 +4,13 @@
  Using SQLAlchemy
 ==================
 
+.. admonition:: Experimental Status
+
+    The SQS transport is unstable in many areas and there are
+    several issues open.  Sadly we don't have the resources or funds
+    required to improve the situation, so we're looking for contributors
+    and partners willing to help.
+
 .. _broker-sqlalchemy-installation:
 
 Installation

+ 7 - 0
docs/getting-started/brokers/sqs.rst

@@ -4,6 +4,13 @@
  Using Amazon SQS
 ==================
 
+.. admonition:: Experimental Status
+
+    The SQS transport is in need of improvements in many areas and there
+    are several open bugs.  Sadly we don't have the resources or funds
+    required to improve the situation, so we're looking for contributors
+    and partners willing to help.
+
 .. _broker-sqs-installation:
 
 Installation

+ 1 - 1
docs/getting-started/first-steps-with-celery.rst

@@ -15,7 +15,7 @@ tools and support you need to run such a system in production.
 In this tutorial you will learn the absolute basics of using Celery.
 You will learn about;
 
-- Choosing and installing a message broker.
+- Choosing and installing a message transport (broker).
 - Installing Celery and creating your first task
 - Starting the worker and calling tasks.
 - Keeping track of tasks as they transition through different states,

+ 7 - 7
docs/getting-started/introduction.rst

@@ -17,7 +17,7 @@ machines.
 A task queue's input is a unit of work, called a task, dedicated worker
 processes then constantly monitor the queue for new work to perform.
 
-Celery communicates via messages using a broker
+Celery communicates via messages, usually using a broker
 to mediate between clients and workers.  To initiate a task a client puts a
 message on the queue, the broker then delivers the message to a worker.
 
@@ -47,9 +47,9 @@ What do I need?
     and from the next version Python 2.6 or newer is required.
     The last version to support Python 2.4 was Celery series 2.2.
 
-*Celery* requires a message broker to send and receive messages.
-The RabbitMQ, Redis and MongoDB broker transports are feature complete,
-but there's also support for a myriad of other solutions, including
+*Celery* requires a message transport to send and receive messages.
+The RabbitMQ and Redis broker transports are feature complete,
+but there's also support for a myriad of other experimental solutions, including
 using SQLite for local development.
 
 *Celery* can run on a single machine, on multiple machines, or even
@@ -118,9 +118,9 @@ Celery is…
         - **Brokers**
 
             - :ref:`RabbitMQ <broker-rabbitmq>`, :ref:`Redis <broker-redis>`,
-            - :ref:`MongoDB <broker-mongodb>`, :ref:`ZeroMQ`
-            - :ref:`CouchDB <broker-couchdb>`, :ref:`SQLAlchemy <broker-sqlalchemy>`
-            - :ref:`Django ORM <broker-django>`, :ref:`Amazon SQS <broker-sqs>`,
+            - :ref:`MongoDB <broker-mongodb>` (exp), :ref:`ZeroMQ` (exp)
+            - :ref:`CouchDB <broker-couchdb>` (exp), :ref:`SQLAlchemy <broker-sqlalchemy>` (exp)
+            - :ref:`Django ORM <broker-django>` (exp), :ref:`Amazon SQS <broker-sqs>`, (exp)
             - and more…
 
         - **Concurrency**

+ 8 - 8
docs/includes/introduction.txt

@@ -16,7 +16,7 @@ machines.
 A task queue's input is a unit of work, called a task, dedicated worker
 processes then constantly monitor the queue for new work to perform.
 
-Celery communicates via messages using a broker
+Celery communicates via messages, usually using a broker
 to mediate between clients and workers.  To initiate a task a client puts a
 message on the queue, the broker then delivers the message to a worker.
 
@@ -46,9 +46,9 @@ This is the last version to support Python 2.5,
 and from Celery 3.1, Python 2.6 or later is required.
 The last version to support Python 2.4 was Celery series 2.2.
 
-*Celery* requires a message broker to send and receive messages.
-The RabbitMQ, Redis and MongoDB broker transports are feature complete,
-but there's also support for a myriad of other solutions, including
+*Celery* is usually used with a message broker to send and receive messages.
+The RabbitMQ, Redis transports are feature complete,
+but there's also experimental support for a myriad of other solutions, including
 using SQLite for local development.
 
 *Celery* can run on a single machine, on multiple machines, or even
@@ -116,12 +116,12 @@ Celery is...
 It supports...
 ==============
 
-    - **Brokers**
+    - **Message Transports**
 
         - RabbitMQ_, Redis_,
-        - MongoDB_, Beanstalk_,
-        - CouchDB_, SQLAlchemy_,
-        - Django ORM, Amazon SQS, `IronMQ`_
+        - MongoDB_ (experimental), Amazon SQS (experimental),
+        - CouchDB_ (experimental), SQLAlchemy_ (experimental),
+        - Django ORM (experimental), `IronMQ`_
         - and more...
 
     - **Concurrency**