[IMP] READMEs and TODOs

stock_available/README.rst

@@ -0,0 +1,47 @@
+Stock available to promise
+==========================
+
+This module proposes several options to compute the quantity available to
+promise for each product.
+This quantity is based on the projected stock and, depending on the
+configuration, it can account for various data such as sales quotations or
+immediate production capacity.
+This can be configured in the menu Settings > Configuration > Warehouse.
+
+Configuration
+=============
+
+By default, this module computes the stock available to promise as the virtual
+stock.
+To take davantage of the additional features, you must which information you
+want to base the computation, by checking one or more boxes in the settings:
+`Configuration` > `Warehouse` > `Stock available to promise`.
+
+Usage
+=====
+
+This module adds a field named `Available for sale` on the Product form.
+Various additional fields may be added, depending on which information you
+chose to base the computation on.
+
+Credits
+=======
+
+Contributors
+------------
+
+* Lionel Sausin (Numérigraphe) <ls@numerigraphe.com>
+* many others contributed to sub-modules, please refer to each sub-module's credits
+
+Maintainer
+----------
+
+.. image:: http://odoo-community.org/logo.png
+   :alt: Odoo Community Association
+   :target: http://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 http://odoo-community.org.

stock_available/__openerp__.py

@@ -27,13 +27,54 @@
     'description': """
 Stock available to promise
 ==========================
+
 This module proposes several options to compute the quantity available to
 promise for each product.
 This quantity is based on the projected stock and, depending on the
 configuration, it can account for various data such as sales quotations or
 immediate production capacity.
 This can be configured in the menu Settings > Configuration > Warehouse.
-""",
+
+Configuration
+=============
+
+By default, this module computes the stock available to promise as the virtual
+stock.
+To take davantage of the additional features, you must which information you
+want to base the computation, by checking one or more boxes in the settings:
+`Configuration` > `Warehouse` > `Stock available to promise`.
+
+Usage
+=====
+
+This module adds a field named `Available for sale` on the Product form.
+Various additional fields may be added, depending on which information you
+chose to base the computation on.
+
+Credits
+=======
+
+Contributors
+------------
+
+* Lionel Sausin (Numérigraphe) <ls@numerigraphe.com>
+* many others contributed to sub-modules, please refer to each sub-module's
+  credits
+
+Maintainer
+----------
+
+.. image:: http://odoo-community.org/logo.png
+   :alt: Odoo Community Association
+   :target: http://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 http://odoo-community.org.""",
     'license': 'AGPL-3',
     'data': [
         'product_view.xml',

stock_available_immediately/README.rst

@@ -0,0 +1,30 @@
+Ignore planned receptions in quantity available to promise
+==========================================================
+
+Normally the quantity available to promise is based on the virtual stock,
+which includes both planned outgoing and incoming goods.
+This module will subtract the planned receptions from the quantity available to
+promise.
+
+Credits
+=======
+
+Contributors
+------------
+
+* Author: Guewen Baconnier (Camptocamp SA)
+* Sébastien BEAU (Akretion) <sebastien.beau@akretion.com>
+* Lionel Sausin (Numérigraphe) <ls@numerigraphe.com>
+
+Maintainer
+----------
+
+.. image:: http://odoo-community.org/logo.png
+   :alt: Odoo Community Association
+   :target: http://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 http://odoo-community.org.

stock_available_immediately/__openerp__.py

@@ -28,18 +28,36 @@
     "license": "AGPL-3",
     "description": u"""
 Ignore planned receptions in quantity available to promise
-----------------------------------------------------------
+==========================================================
 
 Normally the quantity available to promise is based on the virtual stock,
 which includes both planned outgoing and incoming goods.
 This module will subtract the planned receptions from the quantity available to
 promise.
 
+Credits
+=======
+
 Contributors
 ------------
-  * Author: Guewen Baconnier (Camptocamp SA)
-  * Sébastien BEAU (Akretion) <sebastien.beau@akretion.com>
-  * Lionel Sausin (Numérigraphe) <ls@numerigraphe.com>
-""",
+
+* Author: Guewen Baconnier (Camptocamp SA)
+* Sébastien BEAU (Akretion) <sebastien.beau@akretion.com>
+* Lionel Sausin (Numérigraphe) <ls@numerigraphe.com>
+
+Maintainer
+----------
+
+.. image:: http://odoo-community.org/logo.png
+   :alt: Odoo Community Association
+   :target: http://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 http://odoo-community.org.""",
     "category": "Hidden",
 }

stock_available_mrp/README.rst

@@ -0,0 +1,48 @@
+Consider the production potential is available to promise
+=========================================================
+
+This module takes the potential quantities available for Products in account in
+the quantity available to promise, where the "Potential quantity" is the
+quantity that can be manufactured with the components immediately at hand.
+
+Known issues
+============
+
+The manufacturing delays are not taken into account : this module assumes that
+if you have components in stock goods, you can manufacture finished goods
+quickly enough.
+To avoid overestimating, **only the first level** of Bill of Materials is
+considered.
+
+Roadmap
+-------
+
+* include all levels of BoM, using `bom_explode`. @gdgellatly gave an example
+  of how to do it here: https://github.com/OCA/stock-logistics-warehouse/pull/5#issuecomment-66902191
+    Ideally, we will want to take manufacturing delays into account: we can't
+    promiss goods to customers if they want them delivered earlier that we can
+    make them
+* add an option (probably as a sub-module) to consider all raw materials as
+  available if they can be bought from the suppliers in time for the
+  manufacturing.
+
+Credits
+=======
+
+Contributors
+------------
+* Loïc Bellier (Numérigraphe) <lb@numerigraphe.com>
+* Lionel Sausin (Numérigraphe) <ls@numerigraphe.com>
+
+Maintainer
+----------
+
+.. image:: http://odoo-community.org/logo.png
+   :alt: Odoo Community Association
+   :target: http://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 http://odoo-community.org.

stock_available_mrp/__openerp__.py

@@ -25,10 +25,57 @@
     'category': 'Hidden',
     'depends': ['stock_available', 'mrp'],
     'description': """
+Consider the production potential is available to promise
+=========================================================
+
 This module takes the potential quantities available for Products in account in
 the quantity available to promise, where the "Potential quantity" is the
-quantity that can be manufactured with the components immediately at hand,
-following a single level of Bill of Materials.""",
+quantity that can be manufactured with the components immediately at hand.
+
+Known issues
+============
+
+The manufacturing delays are not taken into account : this module assumes that
+if you have components in stock goods, you can manufacture finished goods
+quickly enough.
+To avoid overestimating, **only the first level** of Bill of Materials is
+considered.
+
+Roadmap
+-------
+
+* include all levels of BoM, using `bom_explode`. @gdgellatly gave an example
+  of how to do it here:
+  https://github.com/OCA/stock-logistics-warehouse/pull/5#issuecomment-66902191
+   Ideally, we will want to take manufacturing delays into account: we can't
+   promiss goods to customers if they want them delivered earlier that we can
+   make them
+* add an option (probably as a sub-module) to consider all raw materials as
+  available if they can be bought from the suppliers in time for the
+  manufacturing.
+
+Credits
+=======
+
+Contributors
+------------
+* Loïc Bellier (Numérigraphe) <lb@numerigraphe.com>
+* Lionel Sausin (Numérigraphe) <ls@numerigraphe.com>
+
+Maintainer
+----------
+
+.. image:: http://odoo-community.org/logo.png
+   :alt: Odoo Community Association
+   :target: http://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 http://odoo-community.org.""",
     'data': [
         'product_view.xml',
     ],

stock_available_sale/README.rst

@@ -0,0 +1,38 @@
+Quotations in quantity available to promise
+===========================================
+
+This module computes the quoted quantity of each Product, and subtracts it from
+the quantity available to promise.
+
+"Quoted" is defined as the sum of the quantities of this Product in
+Sale Quotations, taking the context's shop or warehouse into account.
+
+Known issues / Roadmap
+======================
+
+This module does not warn salespersons when the quantity available to promise
+is insufficient to deliver a sale order line.
+
+Work to add this feature is underway: https://github.com/OCA/stock-logistics-warehouse/pull/25
+
+Credits
+=======
+
+Contributors
+------------
+
+* Loïc Bellier (Numérigraphe) <lb@numerigraphe.com>
+* Lionel Sausin (Numérigraphe) <ls@numerigraphe.com>
+
+Maintainer
+----------
+
+.. image:: http://odoo-community.org/logo.png
+   :alt: Odoo Community Association
+   :target: http://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 http://odoo-community.org.

stock_available_sale/__openerp__.py

@@ -29,11 +29,47 @@
         'sale_stock',
     ],
     'description': """
-This module computes the quoted quantity of the Products, and subtracts it from
-the quantities available to promise .
+Quotations in quantity available to promise
+===========================================
 
-"Quoted" is defined as the sum of the quantities of this product in Quotations,
-taking the context's shop or warehouse into account.""",
+This module computes the quoted quantity of each Product, and subtracts it from
+the quantity available to promise.
+
+"Quoted" is defined as the sum of the quantities of this Product in
+Sale Quotations, taking the context's shop or warehouse into account.
+
+Known issues / Roadmap
+======================
+
+This module does not warn salespersons when the quantity available to promise
+is insufficient to deliver a sale order line.
+
+Work to add this feature is underway:
+https://github.com/OCA/stock-logistics-warehouse/pull/25
+
+Credits
+=======
+
+Contributors
+------------
+
+* Loïc Bellier (Numérigraphe) <lb@numerigraphe.com>
+* Lionel Sausin (Numérigraphe) <ls@numerigraphe.com>
+
+Maintainer
+----------
+
+.. image:: http://odoo-community.org/logo.png
+   :alt: Odoo Community Association
+   :target: http://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 http://odoo-community.org.""",
     'data': [
         'product_view.xml',
     ],