Browse Source

[UPD] README.rst

pull/380/head
OCA-git-bot 5 years ago
parent
commit
7ca039e1ef
  1. 38
      pos_picking_delayed/README.rst
  2. 61
      pos_picking_delayed/static/description/index.html

38
pos_picking_delayed/README.rst

@ -14,13 +14,13 @@ Point of Sale - Picking Creation Delayed
:target: http://www.gnu.org/licenses/agpl-3.0-standalone.html
:alt: License: AGPL-3
.. |badge3| image:: https://img.shields.io/badge/github-OCA%2Fpos-lightgray.png?logo=github
:target: https://github.com/OCA/pos/tree/10.0/pos_picking_delayed
:target: https://github.com/OCA/pos/tree/12.0/pos_picking_delayed
:alt: OCA/pos
.. |badge4| image:: https://img.shields.io/badge/weblate-Translate%20me-F47D42.png
:target: https://translation.odoo-community.org/projects/pos-10-0/pos-10-0-pos_picking_delayed
:target: https://translation.odoo-community.org/projects/pos-12-0/pos-12-0-pos_picking_delayed
:alt: Translate me on Weblate
.. |badge5| image:: https://img.shields.io/badge/runbot-Try%20me-875A7B.png
:target: https://runbot.odoo-community.org/runbot/184/10.0
:target: https://runbot.odoo-community.org/runbot/184/12.0
:alt: Try me on Runbot
|badge1| |badge2| |badge3| |badge4| |badge5|
@ -29,16 +29,7 @@ This module extends the functionality of odoo Point Of Sale to reduce creation
time of the PoS orders, via the front UI.
For that purpose, it delays the creation of the picking associated, that will
be created later, by cron. (set by default to run each minute).
Technical information
---------------------
A log will be generated to mention the creation of the pickings by cron.
``2018-09-28 07:47:18,300 163 INFO db odoo.addons.base.ir.ir_cron: Starting job `Create Delayed PoS Picking.``
``2018-09-28 07:47:19,168 163 INFO db odoo.addons.pos_picking_delayed.models.pos_order: Pickings created for 3 PoS Orders``
be created later by queue job.
This module is interesting specially in a context of Synchroneous Point Of
Sale that is introduced by certification modules like 'l10n_fr_pos_cert' because
@ -63,30 +54,25 @@ Configuration
.. image:: https://raw.githubusercontent.com/pos_picking_delayed/static/description/pos_config_form.png
* This module depends on ``queue_job`` module that requires specific
configuration to works properly. Make sure your config file is correctly set.
See https://github.com/OCA/queue/tree/12.0/queue_job
Usage
=====
* Use your Point of Sale as usual. when validating an order, the order will
be in a different color until the cron is executed
* Use your Point of Sale as usual. When validating an order, the order will
be in a different color until the job is executed
.. image:: https://raw.githubusercontent.com/pos_picking_delayed/static/description/pos_order_tree.png
Known issues / Roadmap
======================
* Make this module depend on the module OCA `queue_job` job module.
* In the cron job (or the future queue job), improvment can be done, limiting
the quantity of environments, grouping orders by company, and changing
context once.
Bug Tracker
===========
Bugs are tracked on `GitHub Issues <https://github.com/OCA/pos/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 <https://github.com/OCA/pos/issues/new?body=module:%20pos_picking_delayed%0Aversion:%2010.0%0A%0A**Steps%20to%20reproduce**%0A-%20...%0A%0A**Current%20behavior**%0A%0A**Expected%20behavior**>`_.
`feedback <https://github.com/OCA/pos/issues/new?body=module:%20pos_picking_delayed%0Aversion:%2012.0%0A%0A**Steps%20to%20reproduce**%0A-%20...%0A%0A**Current%20behavior**%0A%0A**Expected%20behavior**>`_.
Do not contact contributors directly about support or help with technical issues.
@ -124,6 +110,6 @@ 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.
This module is part of the `OCA/pos <https://github.com/OCA/pos/tree/10.0/pos_picking_delayed>`_ project on GitHub.
This module is part of the `OCA/pos <https://github.com/OCA/pos/tree/12.0/pos_picking_delayed>`_ project on GitHub.
You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute.

61
pos_picking_delayed/static/description/index.html

@ -367,16 +367,11 @@ ul.auto-toc {
!! This file is generated by oca-gen-addon-readme !!
!! changes will be overwritten. !!
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! -->
<p><a class="reference external" href="https://odoo-community.org/page/development-status"><img alt="Beta" src="https://img.shields.io/badge/maturity-Beta-yellow.png" /></a> <a class="reference external" href="http://www.gnu.org/licenses/agpl-3.0-standalone.html"><img alt="License: AGPL-3" src="https://img.shields.io/badge/licence-AGPL--3-blue.png" /></a> <a class="reference external" href="https://github.com/OCA/pos/tree/10.0/pos_picking_delayed"><img alt="OCA/pos" src="https://img.shields.io/badge/github-OCA%2Fpos-lightgray.png?logo=github" /></a> <a class="reference external" href="https://translation.odoo-community.org/projects/pos-10-0/pos-10-0-pos_picking_delayed"><img alt="Translate me on Weblate" src="https://img.shields.io/badge/weblate-Translate%20me-F47D42.png" /></a> <a class="reference external" href="https://runbot.odoo-community.org/runbot/184/10.0"><img alt="Try me on Runbot" src="https://img.shields.io/badge/runbot-Try%20me-875A7B.png" /></a></p>
<p><a class="reference external" href="https://odoo-community.org/page/development-status"><img alt="Beta" src="https://img.shields.io/badge/maturity-Beta-yellow.png" /></a> <a class="reference external" href="http://www.gnu.org/licenses/agpl-3.0-standalone.html"><img alt="License: AGPL-3" src="https://img.shields.io/badge/licence-AGPL--3-blue.png" /></a> <a class="reference external" href="https://github.com/OCA/pos/tree/12.0/pos_picking_delayed"><img alt="OCA/pos" src="https://img.shields.io/badge/github-OCA%2Fpos-lightgray.png?logo=github" /></a> <a class="reference external" href="https://translation.odoo-community.org/projects/pos-12-0/pos-12-0-pos_picking_delayed"><img alt="Translate me on Weblate" src="https://img.shields.io/badge/weblate-Translate%20me-F47D42.png" /></a> <a class="reference external" href="https://runbot.odoo-community.org/runbot/184/12.0"><img alt="Try me on Runbot" src="https://img.shields.io/badge/runbot-Try%20me-875A7B.png" /></a></p>
<p>This module extends the functionality of odoo Point Of Sale to reduce creation
time of the PoS orders, via the front UI.</p>
<p>For that purpose, it delays the creation of the picking associated, that will
be created later, by cron. (set by default to run each minute).</p>
<div class="section" id="technical-information">
<h1>Technical information</h1>
<p>A log will be generated to mention the creation of the pickings by cron.</p>
<p><tt class="docutils literal"><span class="pre">2018-09-28</span> 07:47:18,300 163 INFO db odoo.addons.base.ir.ir_cron: Starting job `Create Delayed PoS Picking.</tt></p>
<p><tt class="docutils literal"><span class="pre">2018-09-28</span> 07:47:19,168 163 INFO db odoo.addons.pos_picking_delayed.models.pos_order: Pickings created for 3 PoS Orders</tt></p>
be created later by queue job.</p>
<p>This module is interesting specially in a context of Synchroneous Point Of
Sale that is introduced by certification modules like ‘l10n_fr_pos_cert’ because
in such cases, the bill will be printed only when the pos order is created (
@ -389,67 +384,62 @@ for more information.</p>
<ul class="simple">
<li><a class="reference internal" href="#configuration" id="id1">Configuration</a></li>
<li><a class="reference internal" href="#usage" id="id2">Usage</a></li>
<li><a class="reference internal" href="#known-issues-roadmap" id="id3">Known issues / Roadmap</a></li>
<li><a class="reference internal" href="#bug-tracker" id="id4">Bug Tracker</a></li>
<li><a class="reference internal" href="#credits" id="id5">Credits</a><ul>
<li><a class="reference internal" href="#authors" id="id6">Authors</a></li>
<li><a class="reference internal" href="#contributors" id="id7">Contributors</a></li>
<li><a class="reference internal" href="#other-credits" id="id8">Other credits</a></li>
<li><a class="reference internal" href="#maintainers" id="id9">Maintainers</a></li>
<li><a class="reference internal" href="#bug-tracker" id="id3">Bug Tracker</a></li>
<li><a class="reference internal" href="#credits" id="id4">Credits</a><ul>
<li><a class="reference internal" href="#authors" id="id5">Authors</a></li>
<li><a class="reference internal" href="#contributors" id="id6">Contributors</a></li>
<li><a class="reference internal" href="#other-credits" id="id7">Other credits</a></li>
<li><a class="reference internal" href="#maintainers" id="id8">Maintainers</a></li>
</ul>
</li>
</ul>
</div>
<div class="section" id="configuration">
<h2><a class="toc-backref" href="#id1">Configuration</a></h2>
<h1><a class="toc-backref" href="#id1">Configuration</a></h1>
<ul class="simple">
<li>Go to ‘Point of Sale’ / ‘Configuration’ / ‘Point of Sale’</li>
<li>Select your Point of Sale</li>
<li>Set the value in the field ‘Picking Creation Delayed’. (Checked by default)</li>
</ul>
<img alt="https://raw.githubusercontent.com/pos_picking_delayed/static/description/pos_config_form.png" src="https://raw.githubusercontent.com/pos_picking_delayed/static/description/pos_config_form.png" />
</div>
<div class="section" id="usage">
<h2><a class="toc-backref" href="#id2">Usage</a></h2>
<ul class="simple">
<li>Use your Point of Sale as usual. when validating an order, the order will
be in a different color until the cron is executed</li>
<li>This module depends on <tt class="docutils literal">queue_job</tt> module that requires specific
configuration to works properly. Make sure your config file is correctly set.
See <a class="reference external" href="https://github.com/OCA/queue/tree/12.0/queue_job">https://github.com/OCA/queue/tree/12.0/queue_job</a></li>
</ul>
<img alt="https://raw.githubusercontent.com/pos_picking_delayed/static/description/pos_order_tree.png" src="https://raw.githubusercontent.com/pos_picking_delayed/static/description/pos_order_tree.png" />
</div>
<div class="section" id="known-issues-roadmap">
<h2><a class="toc-backref" href="#id3">Known issues / Roadmap</a></h2>
<div class="section" id="usage">
<h1><a class="toc-backref" href="#id2">Usage</a></h1>
<ul class="simple">
<li>Make this module depend on the module OCA <cite>queue_job</cite> job module.</li>
<li>In the cron job (or the future queue job), improvment can be done, limiting
the quantity of environments, grouping orders by company, and changing
context once.</li>
<li>Use your Point of Sale as usual. When validating an order, the order will
be in a different color until the job is executed</li>
</ul>
<img alt="https://raw.githubusercontent.com/pos_picking_delayed/static/description/pos_order_tree.png" src="https://raw.githubusercontent.com/pos_picking_delayed/static/description/pos_order_tree.png" />
</div>
<div class="section" id="bug-tracker">
<h2><a class="toc-backref" href="#id4">Bug Tracker</a></h2>
<h1><a class="toc-backref" href="#id3">Bug Tracker</a></h1>
<p>Bugs are tracked on <a class="reference external" href="https://github.com/OCA/pos/issues">GitHub Issues</a>.
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
<a class="reference external" href="https://github.com/OCA/pos/issues/new?body=module:%20pos_picking_delayed%0Aversion:%2010.0%0A%0A**Steps%20to%20reproduce**%0A-%20...%0A%0A**Current%20behavior**%0A%0A**Expected%20behavior**">feedback</a>.</p>
<a class="reference external" href="https://github.com/OCA/pos/issues/new?body=module:%20pos_picking_delayed%0Aversion:%2012.0%0A%0A**Steps%20to%20reproduce**%0A-%20...%0A%0A**Current%20behavior**%0A%0A**Expected%20behavior**">feedback</a>.</p>
<p>Do not contact contributors directly about support or help with technical issues.</p>
</div>
<div class="section" id="credits">
<h2><a class="toc-backref" href="#id5">Credits</a></h2>
<h1><a class="toc-backref" href="#id4">Credits</a></h1>
<div class="section" id="authors">
<h3><a class="toc-backref" href="#id6">Authors</a></h3>
<h2><a class="toc-backref" href="#id5">Authors</a></h2>
<ul class="simple">
<li>GRAP</li>
</ul>
</div>
<div class="section" id="contributors">
<h3><a class="toc-backref" href="#id7">Contributors</a></h3>
<h2><a class="toc-backref" href="#id6">Contributors</a></h2>
<ul class="simple">
<li>Sylvain LE GAL &lt;<a class="reference external" href="https://twitter.com/legalsylvain">https://twitter.com/legalsylvain</a>&gt;</li>
</ul>
</div>
<div class="section" id="other-credits">
<h3><a class="toc-backref" href="#id8">Other credits</a></h3>
<h2><a class="toc-backref" href="#id7">Other credits</a></h2>
<p>The development of this module has been financially supported by:</p>
<ul class="simple">
<li>GRAP, Groupement Régional Alimentaire de Proximité (www.grap.coop)</li>
@ -457,17 +447,16 @@ If you spotted it first, help us smashing it by providing a detailed and welcome
</ul>
</div>
<div class="section" id="maintainers">
<h3><a class="toc-backref" href="#id9">Maintainers</a></h3>
<h2><a class="toc-backref" href="#id8">Maintainers</a></h2>
<p>This module is maintained by the OCA.</p>
<a class="reference external image-reference" href="https://odoo-community.org"><img alt="Odoo Community Association" src="https://odoo-community.org/logo.png" /></a>
<p>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.</p>
<p>This module is part of the <a class="reference external" href="https://github.com/OCA/pos/tree/10.0/pos_picking_delayed">OCA/pos</a> project on GitHub.</p>
<p>This module is part of the <a class="reference external" href="https://github.com/OCA/pos/tree/12.0/pos_picking_delayed">OCA/pos</a> project on GitHub.</p>
<p>You are welcome to contribute. To learn how please visit <a class="reference external" href="https://odoo-community.org/page/Contribute">https://odoo-community.org/page/Contribute</a>.</p>
</div>
</div>
</div>
</div>
</body>
</html>
Loading…
Cancel
Save