[UPD] README.rst

queue_job/README.rst

@@ -1,11 +1,27 @@
-.. image:: https://img.shields.io/badge/licence-AGPL--3-blue.svg
-   :target: http://www.gnu.org/licenses/agpl-3.0-standalone.html
-   :alt: License: AGPL-3
-
 =========
 Job Queue
 =========
 
+.. !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
+   !! This file is generated by oca-gen-addon-readme !!
+   !! changes will be overwritten.                   !!
+   !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
+
+.. |badge1| image:: https://img.shields.io/badge/maturity-Mature-brightgreen.png
+    :target: https://odoo-community.org/page/development-status
+    :alt: Mature
+.. |badge2| image:: https://img.shields.io/badge/licence-AGPL--3-blue.png
+    :target: http://www.gnu.org/licenses/agpl-3.0-standalone.html
+    :alt: License: AGPL-3
+.. |badge3| image:: https://img.shields.io/badge/github-OCA%2Fqueue-lightgray.png?logo=github
+    :target: https://github.com/OCA/queue/tree/11.0/queue_job
+    :alt: OCA/queue
+.. |badge4| image:: https://img.shields.io/badge/runbot-Try%20me-875A7B.png
+    :target: https://runbot.odoo-community.org/runbot/230/11.0
+    :alt: Try me on Runbot
+
+|badge1| |badge2| |badge3| |badge4| 
+
 This addon adds an integrated Job Queue to Odoo.
 
 It allows to postpone method calls executed asynchronously.
@@ -57,6 +73,8 @@ Features:
 * Related Actions: link an action on the job view, such as open the record
   concerned by the job
 
+.. contents::
+   :local:
 
 Installation
 ============
@@ -118,70 +136,45 @@ To use this module, you need to:
 
 #. Go to ``Job Queue`` menu
 
-.. image:: https://odoo-community.org/website/image/ir.attachment/5784_f2813bd/datas
-   :alt: Try me on Runbot
-   :target: https://runbot.odoo-community.org/runbot/230/10.0
-
-Known issues / Roadmap
-======================
-
-* After creating a new database or installing ``queue_job`` on an
-  existing database, Odoo must be restarted for the runner to detect it.
-
-* When Odoo shuts down normally, it waits for running jobs to finish.
-  However, when the Odoo server crashes or is otherwise force-stopped,
-  running jobs are interrupted while the runner has no chance to know
-  they have been aborted. In such situations, jobs may remain in
-  ``started`` or ``enqueued`` state after the Odoo server is halted.
-  Since the runner has no way to know if they are actually running or
-  not, and does not know for sure if it is safe to restart the jobs,
-  it does not attempt to restart them automatically. Such stale jobs
-  therefore fill the running queue and prevent other jobs to start.
-  You must therefore requeue them manually, either from the Jobs view,
-  or by running the following SQL statement *before starting Odoo*:
-
-.. code-block:: sql
-
-  update queue_job set state='pending' where state in ('started', 'enqueued')
-
 Bug Tracker
 ===========
 
-Bugs are tracked on `GitHub Issues
-<https://github.com/OCA/queue/issues>`_. In case of trouble, please
-check there if your issue has already been reported. If you spotted it first,
-help us smashing it by providing a detailed and welcomed feedback.
+Bugs are tracked on `GitHub Issues <https://github.com/OCA/queue/issues>`_.
+In case of trouble, please check there if your issue has already been reported.
+If you spotted it first, help us smashing it by providing a detailed and welcomed feedback.
+
+Do not contact contributors directly about support or help with technical issues.
 
 Credits
 =======
 
-Images
-------
+Authors
+~~~~~~~
 
-* Odoo Community Association: `Icon <https://github.com/OCA/maintainer-tools/blob/master/template/module/static/description/icon.svg>`_.
+* Camptocamp
+* ACSONE SA/NV
 
-Contributors
-------------
+Maintainers
+~~~~~~~~~~~
 
-* Guewen Baconnier <guewen.baconnier@camptocamp.com>
-* Stéphane Bidoul <stephane.bidoul@acsone.eu>
-* Matthieu Dietrich <matthieu.dietrich@camptocamp.com>
-* Jos De Graeve <Jos.DeGraeve@apertoso.be>
-* David Lefever <dl@taktik.be>
-* Laurent Mignon <laurent.mignon@acsone.eu>
-* Laetitia Gangloff <laetitia.gangloff@acsone.eu>
-
-Maintainer
-----------
+This module is maintained by the OCA.
 
 .. image:: https://odoo-community.org/logo.png
    :alt: Odoo Community Association
    :target: https://odoo-community.org
 
-This module is maintained by the OCA.
-
 OCA, or the Odoo Community Association, is a nonprofit organization whose
 mission is to support the collaborative development of Odoo features and
 promote its widespread use.
 
-To contribute to this module, please visit https://odoo-community.org.
+.. |maintainer-guewen| image:: https://github.com/guewen.png?size=40px
+    :target: https://github.com/guewen
+    :alt: guewen
+
+Current `maintainer <https://odoo-community.org/page/maintainer-role>`_:
+
+|maintainer-guewen| 
+
+This module is part of the `OCA/queue <https://github.com/OCA/queue/tree/11.0/queue_job>`_ project on GitHub.
+
+You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute.