[IMP] product_expiry_configurable: Improve README

product_expiry_configurable/README.rst

@@ -25,18 +25,42 @@ Product Expiry Configurable
 
 |badge1| |badge2| |badge3| |badge4| |badge5| 
 
-This module allows changing the standard expiry dates managing.
-Currently, the odoo product_expiry modules compute the use_date, removal_date, expiration_date, and alert_date applying the use_time, removal_time, expiration_date, and alert_date to the creation date of the lot. For example, if alert_time is set to 2 days and the lot is created the 16/02/2022, the alert_date is set to 18/02/2022.
-With this module, this behavior can be changed. It computes the use_date, removal_date, and alert_date depending on the expiration_date. For example, if the alert_time is set to 2 days, and the lot expiration_date is 20/04/2022, the alert_date is set to 18/04/22.
-In addition, the times and type of computing (from current_date or expiration_date) can be configured on the product_category and on the product_template. If a field is provided on the product, the provided on the category is set.
-Filters of "Alert Date Reached", "Use Date Reached", "Expiration Date Reached" and "Removal Date Reached" have been added.
-Finally, crons that generate activities have been created to warn for each date. By default, they are desastivated.
+This module allows to manage product life delays on category level:
+
+- Use Time
+- Removal Time
+- Alert Time
+- Expiration Time
+
+If these values are set on category level, when creating a product and assigning that category or changing that category on existing product,
+those value are reflected on product side. Those values can also be set per product.
+
+The 'Use Expiration Date' field that exists on product level is set too on category with the same behavior as above.
+
+Last but not least, activities can be created automatically to warn users for product that have some dates expired (Removal, Use and Expiration).
 
 **Table of contents**
 
 .. contents::
    :local:
 
+Configuration
+=============
+
+* To configure a times on categories, Go to Configuration menu (in Purchase/Invoicing/Inventory), then Product Categories.
+* Choose the one you want to configure and fill in the times and the Use Expiration Date:
+
+.. image:: https://raw.githubusercontent.com/OCA/product-attribute/16.0/product_expiry_configurable/static/images/category.png
+  :width: 600
+  :alt: Category
+
+* To configure activities crons, go to Settings > Technical > Scheduled Actions
+* Choose the one you want to activate and configure the time to run it
+
+.. image:: https://raw.githubusercontent.com/OCA/product-attribute/16.0/product_expiry_configurable/static/images/crons.png
+  :width: 600
+  :alt: Category
+
 Bug Tracker
 ===========
 

product_expiry_configurable/readme/CONFIGURE.rst

@@ -0,0 +1,13 @@
+* To configure a times on categories, Go to Configuration menu (in Purchase/Invoicing/Inventory), then Product Categories.
+* Choose the one you want to configure and fill in the times and the Use Expiration Date:
+
+.. image:: ../static/images/category.png
+  :width: 600
+  :alt: Category
+
+* To configure activities crons, go to Settings > Technical > Scheduled Actions
+* Choose the one you want to activate and configure the time to run it
+
+.. image:: ../static/images/crons.png
+  :width: 600
+  :alt: Category

product_expiry_configurable/readme/DESCRIPTION.rst

@@ -1,6 +1,13 @@
-This module allows changing the standard expiry dates managing.
-Currently, the odoo product_expiry modules compute the use_date, removal_date, expiration_date, and alert_date applying the use_time, removal_time, expiration_date, and alert_date to the creation date of the lot. For example, if alert_time is set to 2 days and the lot is created the 16/02/2022, the alert_date is set to 18/02/2022.
-With this module, this behavior can be changed. It computes the use_date, removal_date, and alert_date depending on the expiration_date. For example, if the alert_time is set to 2 days, and the lot expiration_date is 20/04/2022, the alert_date is set to 18/04/22.
-In addition, the times and type of computing (from current_date or expiration_date) can be configured on the product_category and on the product_template. If a field is provided on the product, the provided on the category is set.
-Filters of "Alert Date Reached", "Use Date Reached", "Expiration Date Reached" and "Removal Date Reached" have been added.
-Finally, crons that generate activities have been created to warn for each date. By default, they are desastivated.
+This module allows to manage product life delays on category level:
+
+- Use Time
+- Removal Time
+- Alert Time
+- Expiration Time
+
+If these values are set on category level, when creating a product and assigning that category or changing that category on existing product,
+those value are reflected on product side. Those values can also be set per product.
+
+The 'Use Expiration Date' field that exists on product level is set too on category with the same behavior as above.
+
+Last but not least, activities can be created automatically to warn users for product that have some dates expired (Removal, Use and Expiration).

product_expiry_configurable/static/description/index.html

@@ -368,35 +368,54 @@ <h1 class="title">Product Expiry Configurable</h1>
 !! 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/product-attribute/tree/16.0/product_expiry_configurable"><img alt="OCA/product-attribute" src="https://img.shields.io/badge/github-OCA%2Fproduct--attribute-lightgray.png?logo=github" /></a> <a class="reference external" href="https://translation.odoo-community.org/projects/product-attribute-16-0/product-attribute-16-0-product_expiry_configurable"><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/135/16.0"><img alt="Try me on Runbot" src="https://img.shields.io/badge/runbot-Try%20me-875A7B.png" /></a></p>
-<p>This module allows changing the standard expiry dates managing.
-Currently, the odoo product_expiry modules compute the use_date, removal_date, expiration_date, and alert_date applying the use_time, removal_time, expiration_date, and alert_date to the creation date of the lot. For example, if alert_time is set to 2 days and the lot is created the 16/02/2022, the alert_date is set to 18/02/2022.
-With this module, this behavior can be changed. It computes the use_date, removal_date, and alert_date depending on the expiration_date. For example, if the alert_time is set to 2 days, and the lot expiration_date is 20/04/2022, the alert_date is set to 18/04/22.
-In addition, the times and type of computing (from current_date or expiration_date) can be configured on the product_category and on the product_template. If a field is provided on the product, the provided on the category is set.
-Filters of “Alert Date Reached”, “Use Date Reached”, “Expiration Date Reached” and “Removal Date Reached” have been added.
-Finally, crons that generate activities have been created to warn for each date. By default, they are desastivated.</p>
+<p>This module allows to manage product life delays on category level:</p>
+<ul class="simple">
+<li>Use Time</li>
+<li>Removal Time</li>
+<li>Alert Time</li>
+<li>Expiration Time</li>
+</ul>
+<p>If these values are set on category level, when creating a product and assigning that category or changing that category on existing product,
+those value are reflected on product side. Those values can also be set per product.</p>
+<p>The ‘Use Expiration Date’ field that exists on product level is set too on category with the same behavior as above.</p>
+<p>Last but not least, activities can be created automatically to warn users for product that have some dates expired (Removal, Use and Expiration).</p>
 <p><strong>Table of contents</strong></p>
 <div class="contents local topic" id="contents">
 <ul class="simple">
-<li><a class="reference internal" href="#bug-tracker" id="id1">Bug Tracker</a></li>
-<li><a class="reference internal" href="#credits" id="id2">Credits</a><ul>
-<li><a class="reference internal" href="#contributors" id="id3">Contributors</a></li>
-<li><a class="reference internal" href="#maintainers" id="id4">Maintainers</a></li>
+<li><a class="reference internal" href="#configuration" id="id1">Configuration</a></li>
+<li><a class="reference internal" href="#bug-tracker" id="id2">Bug Tracker</a></li>
+<li><a class="reference internal" href="#credits" id="id3">Credits</a><ul>
+<li><a class="reference internal" href="#contributors" id="id4">Contributors</a></li>
+<li><a class="reference internal" href="#maintainers" id="id5">Maintainers</a></li>
 </ul>
 </li>
 </ul>
 </div>
+<div class="section" id="configuration">
+<h1><a class="toc-backref" href="#id1">Configuration</a></h1>
+<ul class="simple">
+<li>To configure a times on categories, Go to Configuration menu (in Purchase/Invoicing/Inventory), then Product Categories.</li>
+<li>Choose the one you want to configure and fill in the times and the Use Expiration Date:</li>
+</ul>
+<img alt="Category" src="https://raw.githubusercontent.com/OCA/product-attribute/16.0/product_expiry_configurable/static/images/category.png" style="width: 600px;" />
+<ul class="simple">
+<li>To configure activities crons, go to Settings &gt; Technical &gt; Scheduled Actions</li>
+<li>Choose the one you want to activate and configure the time to run it</li>
+</ul>
+<img alt="Category" src="https://raw.githubusercontent.com/OCA/product-attribute/16.0/product_expiry_configurable/static/images/crons.png" style="width: 600px;" />
+</div>
 <div class="section" id="bug-tracker">
-<h1><a class="toc-backref" href="#id1">Bug Tracker</a></h1>
+<h1><a class="toc-backref" href="#id2">Bug Tracker</a></h1>
 <p>Bugs are tracked on <a class="reference external" href="https://github.com/OCA/product-attribute/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/product-attribute/issues/new?body=module:%20product_expiry_configurable%0Aversion:%2016.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">
-<h1><a class="toc-backref" href="#id2">Credits</a></h1>
+<h1><a class="toc-backref" href="#id3">Credits</a></h1>
 <div class="section" id="contributors">
-<h2><a class="toc-backref" href="#id3">Contributors</a></h2>
+<h2><a class="toc-backref" href="#id4">Contributors</a></h2>
 <ul>
 <li><p class="first"><a class="reference external" href="https://www.creublanca.es">CreuBlanca</a>:</p>
 <blockquote>
@@ -410,7 +429,7 @@ <h2><a class="toc-backref" href="#id3">Contributors</a></h2>
 </ul>
 </div>
 <div class="section" id="maintainers">
-<h2><a class="toc-backref" href="#id4">Maintainers</a></h2>
+<h2><a class="toc-backref" href="#id5">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