[IMP] hr_timesheet_portal: add USAGE.md

Add USAGE.md and screenshots to improve documentation.

Signed-off-by: Manuel Fombuena <mfombuena@innovara.tech>

Author: innovara

hr_timesheet_portal/README.rst

@@ -50,6 +50,28 @@ To configure this module, you need to:
    users be able to edit timesheets, add the group as an implied group
    of the Portal group
 
+Usage
+=====
+
+Users in the Website group Editable timesheets will see a plus button
+when they hover over Timesheets.
+
+|Portal general view|
+
+Clicking the plus button allows them to add a new timesheet line:
+
+|Add timesheet line|
+
+They can also edit their timesheet lines by hovering over a line and
+clicking the pencil button next to the date, or delete a line by
+clicking the cross next to the duration:
+
+|Edit timesheet line|
+
+.. |Portal general view| image:: https://raw.githubusercontent.com/OCA/timesheet/17.0/hr_timesheet_portal/static/img/01_portal_general_view.png
+.. |Add timesheet line| image:: https://raw.githubusercontent.com/OCA/timesheet/17.0/hr_timesheet_portal/static/img/02_add_timesheet_line.png
+.. |Edit timesheet line| image:: https://raw.githubusercontent.com/OCA/timesheet/17.0/hr_timesheet_portal/static/img/03_edit_timesheet_line.png
+
 Bug Tracker
 ===========
 

hr_timesheet_portal/readme/USAGE.md

@@ -0,0 +1,11 @@
+Users in the Website group Editable timesheets will see a plus button when they hover over Timesheets.
+
+![Portal general view](../static/img/01_portal_general_view.png)
+
+Clicking the plus button allows them to add a new timesheet line:
+
+![Add timesheet line](../static/img/02_add_timesheet_line.png)
+
+They can also edit their timesheet lines by hovering over a line and clicking the pencil button next to the date, or delete a line by clicking the cross next to the duration:
+
+![Edit timesheet line](../static/img/03_edit_timesheet_line.png)

hr_timesheet_portal/static/description/index.html

@@ -382,11 +382,12 @@ <h1 class="title">Timesheet portal (editable)</h1>
 <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="#bug-tracker" id="toc-entry-2">Bug Tracker</a></li>
-<li><a class="reference internal" href="#credits" id="toc-entry-3">Credits</a><ul>
-<li><a class="reference internal" href="#authors" id="toc-entry-4">Authors</a></li>
-<li><a class="reference internal" href="#contributors" id="toc-entry-5">Contributors</a></li>
-<li><a class="reference internal" href="#maintainers" id="toc-entry-6">Maintainers</a></li>
+<li><a class="reference internal" href="#usage" id="toc-entry-2">Usage</a></li>
+<li><a class="reference internal" href="#bug-tracker" id="toc-entry-3">Bug Tracker</a></li>
+<li><a class="reference internal" href="#credits" id="toc-entry-4">Credits</a><ul>
+<li><a class="reference internal" href="#authors" id="toc-entry-5">Authors</a></li>
+<li><a class="reference internal" href="#contributors" id="toc-entry-6">Contributors</a></li>
+<li><a class="reference internal" href="#maintainers" id="toc-entry-7">Maintainers</a></li>
 </ul>
 </li>
 </ul>
@@ -400,24 +401,36 @@ <h1><a class="toc-backref" href="#toc-entry-1">Configuration</a></h1>
 of the Portal group</li>
 </ol>
 </div>
+<div class="section" id="usage">
+<h1><a class="toc-backref" href="#toc-entry-2">Usage</a></h1>
+<p>Users in the Website group Editable timesheets will see a plus button
+when they hover over Timesheets.</p>
+<p><img alt="Portal general view" src="https://raw.githubusercontent.com/OCA/timesheet/17.0/hr_timesheet_portal/static/img/01_portal_general_view.png" /></p>
+<p>Clicking the plus button allows them to add a new timesheet line:</p>
+<p><img alt="Add timesheet line" src="https://raw.githubusercontent.com/OCA/timesheet/17.0/hr_timesheet_portal/static/img/02_add_timesheet_line.png" /></p>
+<p>They can also edit their timesheet lines by hovering over a line and
+clicking the pencil button next to the date, or delete a line by
+clicking the cross next to the duration:</p>
+<p><img alt="Edit timesheet line" src="https://raw.githubusercontent.com/OCA/timesheet/17.0/hr_timesheet_portal/static/img/03_edit_timesheet_line.png" /></p>
+</div>
 <div class="section" id="bug-tracker">
-<h1><a class="toc-backref" href="#toc-entry-2">Bug Tracker</a></h1>
+<h1><a class="toc-backref" href="#toc-entry-3">Bug Tracker</a></h1>
 <p>Bugs are tracked on <a class="reference external" href="https://github.com/OCA/timesheet/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/timesheet/issues/new?body=module:%20hr_timesheet_portal%0Aversion:%2017.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-3">Credits</a></h1>
+<h1><a class="toc-backref" href="#toc-entry-4">Credits</a></h1>
 <div class="section" id="authors">
-<h2><a class="toc-backref" href="#toc-entry-4">Authors</a></h2>
+<h2><a class="toc-backref" href="#toc-entry-5">Authors</a></h2>
 <ul class="simple">
 <li>Hunki Enterprises BV</li>
 </ul>
 </div>
 <div class="section" id="contributors">
-<h2><a class="toc-backref" href="#toc-entry-5">Contributors</a></h2>
+<h2><a class="toc-backref" href="#toc-entry-6">Contributors</a></h2>
 <ul class="simple">
 <li><a class="reference external" href="https://hunki-enterprises.com">Hunki Enterprises BV</a><ul>
 <li>Holger Brunn &lt;<a class="reference external" href="mailto:mail&#64;hunki-enterprises.com">mail&#64;hunki-enterprises.com</a>&gt;</li>
@@ -434,7 +447,7 @@ <h2><a class="toc-backref" href="#toc-entry-5">Contributors</a></h2>
 </ul>
 </div>
 <div class="section" id="maintainers">
-<h2><a class="toc-backref" href="#toc-entry-6">Maintainers</a></h2>
+<h2><a class="toc-backref" href="#toc-entry-7">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" />