Browse Source

Add some basic initial celery documentation

Tianon Gravi 10 years ago
parent
commit
81d21fe3d1
4 changed files with 57 additions and 0 deletions
  1. 1 0
      celery/README-short.txt
  2. 41 0
      celery/README.md
  3. 15 0
      celery/content.md
  4. BIN
      celery/logo.png

+ 1 - 0
celery/README-short.txt

@@ -0,0 +1 @@
+Celery is an open source asynchronous task queue/job queue based on distributed message passing.

+ 41 - 0
celery/README.md

@@ -0,0 +1,41 @@
+# Supported tags and respective `Dockerfile` links
+
+-	[`3.1.17`, `3.1`, `3`, `latest` (*Dockerfile*)](https://github.com/docker-library/celery/blob/92bcbab09f2c2e342a57d3a1b643e7646908c76f/Dockerfile)
+
+For more information about this image and its history, please see the [relevant manifest file (`library/celery`)](https://github.com/docker-library/official-images/blob/master/library/celery) in the [`docker-library/official-images` GitHub repo](https://github.com/docker-library/official-images).
+
+# Celery
+
+Celery is an open source asynchronous task queue/job queue based on distributed message passing. It is focused on real-time operation, but supports scheduling as well.
+
+> [wikipedia.org/wiki/Celery_Task_Queue](https://en.wikipedia.org/wiki/Celery_Task_Queue)
+
+# How to use this image
+
+## start a celery worker
+
+	docker run --link some-rabbit:rabbit --name some-celery -d celery
+
+## check the status of a cluster
+
+	docker run --link some-rabbit:rabbit --rm celery celery status
+
+# Supported Docker versions
+
+This image is officially supported on Docker version 1.5.0.
+
+Support for older versions (down to 1.0) is provided on a best-effort basis.
+
+# User Feedback
+
+## Issues
+
+If you have any problems with or questions about this image, please contact us through a [GitHub issue](https://github.com/docker-library/celery/issues).
+
+You can also reach many of the official image maintainers via the `#docker-library` IRC channel on [Freenode](https://freenode.net).
+
+## Contributing
+
+You are invited to contribute new features, fixes, or updates, large or small; we are always thrilled to receive pull requests, and do our best to process them as fast as we can.
+
+Before you start to code, we recommend discussing your plans through a [GitHub issue](https://github.com/docker-library/celery/issues), especially for more ambitious contributions. This gives other contributors a chance to point you in the right direction, give you feedback on your design, and help you find out if someone else is working on the same thing.

+ 15 - 0
celery/content.md

@@ -0,0 +1,15 @@
+# Celery
+
+Celery is an open source asynchronous task queue/job queue based on distributed message passing. It is focused on real-time operation, but supports scheduling as well.
+
+> [wikipedia.org/wiki/Celery_Task_Queue](https://en.wikipedia.org/wiki/Celery_Task_Queue)
+
+# How to use this image
+
+## start a celery worker
+
+	docker run --link some-rabbit:rabbit --name some-celery -d celery
+
+## check the status of a cluster
+
+	docker run --link some-rabbit:rabbit --rm celery celery status

BIN
celery/logo.png