[FIX] helpdesk_mgmt_activity: documentation updated, context file add…

…ed, images added

helpdesk_mgmt_activity/README.rst

@@ -43,6 +43,20 @@ The module adds the following features:
 .. contents::
    :local:
 
+Use Cases / Context
+===================
+
+To streamline your helpdesk operations you can set activities to the pre-configured odoo modules records right from the Helpdesk. 
+
+The ticket will be moved to the pre-defined stage when the activity is marked as done.
+
+For instance:
+
+A customer reaches the support team regarding a delayed shipment. 
+- Assign Activity: The helpdesk support team user opens a ticket for the relevant Inventory picking record with specific instructions to check the shipment status and actions that must be taken.
+- Warehouse Action: The assigned warehouse user sees the new activity in their Odoo dashboard, follows the prescribed steps to investigate, and updates the activity status accordingly.
+- Automated Updates: Once the warehouse user marks the activity as done, the ticket automatically moves to the "Awaiting" stage to be checked by the support team user.
+
 Configuration
 =============
 
@@ -52,6 +66,10 @@ Configuration
 - Go to Helpdesk-->Configuration-->Settings
 - In the Available Models field add models available for a Helpdesk
 
+.. figure:: https://raw.githubusercontent.com/OCA/helpdesk/16.0/helpdesk_mgmt_activity/static/img/settings.png
+   :alt: Settings view
+   :width: 600 px
+
 To Configure Ticket's Stage on Activity State**
 ===============================================
 
@@ -60,6 +78,11 @@ To Configure Ticket's Stage on Activity State**
 - Enable the "Set Activities" checkbox to enable the feature
 - Select the "Done Activity Stage" to move the ticket when the activity is done
 
+.. figure:: https://raw.githubusercontent.com/OCA/helpdesk/16.0/helpdesk_mgmt_activity/static/img/team.png
+   :alt: Team view
+   :width: 600 px
+
+
 Usage
 =====
 

helpdesk_mgmt_activity/readme/CONFIGURE.rst

@@ -4,10 +4,19 @@
 - Go to Helpdesk-->Configuration-->Settings
 - In the Available Models field add models available for a Helpdesk
 
+.. figure:: ../static/img/settings.png
+   :alt: Settings view
+   :width: 600 px
+
 To Configure Ticket's Stage on Activity State**
 ===============================================
 
 - Go to Helpdesk-->Configuration--Teams
 - Create a "New" team or select an existing record
 - Enable the "Set Activities" checkbox to enable the feature
 - Select the "Done Activity Stage" to move the ticket when the activity is done
+
+.. figure:: ../static/img/team.png
+   :alt: Team view
+   :width: 600 px
+

helpdesk_mgmt_activity/readme/CONTEXT.rst

@@ -0,0 +1,10 @@
+To streamline your helpdesk operations you can set activities to the pre-configured odoo modules records right from the Helpdesk. 
+
+The ticket will be moved to the pre-defined stage when the activity is marked as done.
+
+For instance:
+
+A customer reaches the support team regarding a delayed shipment. 
+- Assign Activity: The helpdesk support team user opens a ticket for the relevant Inventory picking record with specific instructions to check the shipment status and actions that must be taken.
+- Warehouse Action: The assigned warehouse user sees the new activity in their Odoo dashboard, follows the prescribed steps to investigate, and updates the activity status accordingly.
+- Automated Updates: Once the warehouse user marks the activity as done, the ticket automatically moves to the "Awaiting" stage to be checked by the support team user.

helpdesk_mgmt_activity/static/description/index.html

@@ -380,44 +380,61 @@ <h1 class="title">Helpdesk Management Activity</h1>
 <p><strong>Table of contents</strong></p>
 <div class="contents local topic" id="contents">
 <ul class="simple">
-<li><a class="reference internal" href="#configuration" id="toc-entry-1">Configuration</a></li>
-<li><a class="reference internal" href="#to-configure-available-odoo-models" id="toc-entry-2"><strong>To Configure Available Odoo Models</strong></a></li>
-<li><a class="reference internal" href="#to-configure-ticket-s-stage-on-activity-state" id="toc-entry-3">To Configure Ticket’s Stage on Activity State**</a></li>
-<li><a class="reference internal" href="#usage" id="toc-entry-4">Usage</a></li>
-<li><a class="reference internal" href="#go-to-helpdesk-module" id="toc-entry-5"><strong>Go to Helpdesk module</strong></a></li>
-<li><a class="reference internal" href="#bug-tracker" id="toc-entry-6">Bug Tracker</a></li>
-<li><a class="reference internal" href="#credits" id="toc-entry-7">Credits</a><ul>
-<li><a class="reference internal" href="#authors" id="toc-entry-8">Authors</a></li>
-<li><a class="reference internal" href="#contributors" id="toc-entry-9">Contributors</a></li>
-<li><a class="reference internal" href="#maintainers" id="toc-entry-10">Maintainers</a></li>
+<li><a class="reference internal" href="#use-cases-context" id="toc-entry-1">Use Cases / Context</a></li>
+<li><a class="reference internal" href="#configuration" id="toc-entry-2">Configuration</a></li>
+<li><a class="reference internal" href="#to-configure-available-odoo-models" id="toc-entry-3"><strong>To Configure Available Odoo Models</strong></a></li>
+<li><a class="reference internal" href="#to-configure-ticket-s-stage-on-activity-state" id="toc-entry-4">To Configure Ticket’s Stage on Activity State**</a></li>
+<li><a class="reference internal" href="#usage" id="toc-entry-5">Usage</a></li>
+<li><a class="reference internal" href="#go-to-helpdesk-module" id="toc-entry-6"><strong>Go to Helpdesk module</strong></a></li>
+<li><a class="reference internal" href="#bug-tracker" id="toc-entry-7">Bug Tracker</a></li>
+<li><a class="reference internal" href="#credits" id="toc-entry-8">Credits</a><ul>
+<li><a class="reference internal" href="#authors" id="toc-entry-9">Authors</a></li>
+<li><a class="reference internal" href="#contributors" id="toc-entry-10">Contributors</a></li>
+<li><a class="reference internal" href="#maintainers" id="toc-entry-11">Maintainers</a></li>
 </ul>
 </li>
 </ul>
 </div>
+<div class="section" id="use-cases-context">
+<h1><a class="toc-backref" href="#toc-entry-1">Use Cases / Context</a></h1>
+<p>To streamline your helpdesk operations you can set activities to the pre-configured odoo modules records right from the Helpdesk.</p>
+<p>The ticket will be moved to the pre-defined stage when the activity is marked as done.</p>
+<p>For instance:</p>
+<p>A customer reaches&nbsp;the support team regarding a delayed shipment.
+- Assign Activity:&nbsp;The helpdesk support team user opens a ticket for the relevant Inventory picking&nbsp;record&nbsp;with specific instructions to check the shipment status and actions that must be taken.
+- Warehouse Action: The assigned warehouse user sees the new activity in their Odoo dashboard, follows the prescribed steps to investigate, and updates the activity status accordingly.
+- Automated Updates: Once the warehouse user marks the activity as done, the ticket automatically moves to the “Awaiting” stage to be checked by the support team user.</p>
+</div>
 <div class="section" id="configuration">
-<h1><a class="toc-backref" href="#toc-entry-1">Configuration</a></h1>
+<h1><a class="toc-backref" href="#toc-entry-2">Configuration</a></h1>
 </div>
 <div class="section" id="to-configure-available-odoo-models">
-<h1><a class="toc-backref" href="#toc-entry-2"><strong>To Configure Available Odoo Models</strong></a></h1>
+<h1><a class="toc-backref" href="#toc-entry-3"><strong>To Configure Available Odoo Models</strong></a></h1>
 <ul class="simple">
 <li>Go to Helpdesk–&gt;Configuration–&gt;Settings</li>
 <li>In the Available Models field add models available for a Helpdesk</li>
 </ul>
+<div class="figure">
+<img alt="Settings view" src="https://raw.githubusercontent.com/OCA/helpdesk/16.0/helpdesk_mgmt_activity/static/img/settings.png" style="width: 600px;" />
+</div>
 </div>
 <div class="section" id="to-configure-ticket-s-stage-on-activity-state">
-<h1><a class="toc-backref" href="#toc-entry-3">To Configure Ticket’s Stage on Activity State**</a></h1>
+<h1><a class="toc-backref" href="#toc-entry-4">To Configure Ticket’s Stage on Activity State**</a></h1>
 <ul class="simple">
 <li>Go to Helpdesk–&gt;Configuration–Teams</li>
 <li>Create a “New” team or select an existing record</li>
 <li>Enable the “Set Activities” checkbox to enable the feature</li>
 <li>Select the “Done Activity Stage” to move the ticket when the activity is done</li>
 </ul>
+<div class="figure">
+<img alt="Team view" src="https://raw.githubusercontent.com/OCA/helpdesk/16.0/helpdesk_mgmt_activity/static/img/team.png" style="width: 600px;" />
+</div>
 </div>
 <div class="section" id="usage">
-<h1><a class="toc-backref" href="#toc-entry-4">Usage</a></h1>
+<h1><a class="toc-backref" href="#toc-entry-5">Usage</a></h1>
 </div>
 <div class="section" id="go-to-helpdesk-module">
-<h1><a class="toc-backref" href="#toc-entry-5"><strong>Go to Helpdesk module</strong></a></h1>
+<h1><a class="toc-backref" href="#toc-entry-6"><strong>Go to Helpdesk module</strong></a></h1>
 <ul class="simple">
 <li>Select a Team</li>
 <li>Open a Ticket</li>
@@ -434,23 +451,23 @@ <h1><a class="toc-backref" href="#toc-entry-5"><strong>Go to Helpdesk module</st
 </ul>
 </div>
 <div class="section" id="bug-tracker">
-<h1><a class="toc-backref" href="#toc-entry-6">Bug Tracker</a></h1>
+<h1><a class="toc-backref" href="#toc-entry-7">Bug Tracker</a></h1>
 <p>Bugs are tracked on <a class="reference external" href="https://github.com/OCA/helpdesk/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 to smash it by providing a detailed and welcomed
 <a class="reference external" href="https://github.com/OCA/helpdesk/issues/new?body=module:%20helpdesk_mgmt_activity%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="#toc-entry-7">Credits</a></h1>
+<h1><a class="toc-backref" href="#toc-entry-8">Credits</a></h1>
 <div class="section" id="authors">
-<h2><a class="toc-backref" href="#toc-entry-8">Authors</a></h2>
+<h2><a class="toc-backref" href="#toc-entry-9">Authors</a></h2>
 <ul class="simple">
 <li>Cetmix OÜ</li>
 </ul>
 </div>
 <div class="section" id="contributors">
-<h2><a class="toc-backref" href="#toc-entry-9">Contributors</a></h2>
+<h2><a class="toc-backref" href="#toc-entry-10">Contributors</a></h2>
 <ul class="simple">
 <li><a class="reference external" href="https://cetmix.com">Cetmix OÜ</a>:<ul>
 <li>Ivan Sokolov</li>
@@ -462,7 +479,7 @@ <h2><a class="toc-backref" href="#toc-entry-9">Contributors</a></h2>
 </ul>
 </div>
 <div class="section" id="maintainers">
-<h2><a class="toc-backref" href="#toc-entry-10">Maintainers</a></h2>
+<h2><a class="toc-backref" href="#toc-entry-11">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