Skip to content

Commit

Permalink
[IMP] sign_oca: Improve roadmap and readme
Browse files Browse the repository at this point in the history
  • Loading branch information
etobella committed Aug 2, 2023
1 parent be5f328 commit 20ae772
Show file tree
Hide file tree
Showing 3 changed files with 599 additions and 6 deletions.
124 changes: 123 additions & 1 deletion sign_oca/README.rst
Original file line number Diff line number Diff line change
@@ -1 +1,123 @@
To fill automatically
========
Sign Oca
========

..
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
!! This file is generated by oca-gen-addon-readme !!
!! changes will be overwritten. !!
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
!! source digest: sha256:889a5c44e992879701cb107c8f8ecfa5d2a258c6a739054f12d3739b562d6a4b
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
.. |badge1| image:: https://img.shields.io/badge/maturity-Beta-yellow.png
:target: https://odoo-community.org/page/development-status
:alt: Beta
.. |badge2| image:: https://img.shields.io/badge/licence-AGPL--3-blue.png
:target: http://www.gnu.org/licenses/agpl-3.0-standalone.html
:alt: License: AGPL-3
.. |badge3| image:: https://img.shields.io/badge/github-OCA%2Fsign-lightgray.png?logo=github
:target: https://github.com/OCA/sign/tree/14.0/sign_oca
:alt: OCA/sign
.. |badge4| image:: https://img.shields.io/badge/weblate-Translate%20me-F47D42.png
:target: https://translation.odoo-community.org/projects/sign-14-0/sign-14-0-sign_oca
:alt: Translate me on Weblate
.. |badge5| image:: https://img.shields.io/badge/runboat-Try%20me-875A7B.png
:target: https://runboat.odoo-community.org/builds?repo=OCA/sign&target_branch=14.0
:alt: Try me on Runboat

|badge1| |badge2| |badge3| |badge4| |badge5|

[ This file must be max 2-3 paragraphs, and is required. ]

This module extends the functionality of ... to support ...
and to allow you to ...

**Table of contents**

.. contents::
:local:

Usage
=====

Creation of templates
~~~~~~~~~~~~~~~~~~~~~

* Access `Sign / Templates`
* Create a new template
* Add a PDF File
* Access the configuration menu
* You can add a field by doing a right click inside a page
* Click on the field in order to delete or edit some configuration of it
* The template is autosaved

Sign a document
~~~~~~~~~~~~~~~

* Access `Sign / Templates`
* Press the `Sign` button from a template
* Fill all the possible partners that will sign the document
* The signature action will be opened.
* There, you can fill all the data you need.
* Once you finish, press the sign button on the top
* When the last signer signs it, the final file will be generated as a PDF

Known issues / Roadmap
======================

Tasks
~~~~~

* Make some kind of log in order to ensure the inalterability of the signature
* Ensure that the signature is inalterable.
Maybe we might need to use some tools like endevise or pyHanko with a certificate.
Signer can be authenticated using OTP.

Bug Tracker
===========

Bugs are tracked on `GitHub Issues <https://github.com/OCA/sign/issues>`_.
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
`feedback <https://github.com/OCA/sign/issues/new?body=module:%20sign_oca%0Aversion:%2014.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.

Credits
=======

Authors
~~~~~~~

* Dixmit

Contributors
~~~~~~~~~~~~

* Enric Tobella (www.dixmit.com)

Maintainers
~~~~~~~~~~~

This module is maintained by the OCA.

.. image:: https://odoo-community.org/logo.png
:alt: Odoo Community Association
:target: https://odoo-community.org

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.

.. |maintainer-etobella| image:: https://github.com/etobella.png?size=40px
:target: https://github.com/etobella
:alt: etobella

Current `maintainer <https://odoo-community.org/page/maintainer-role>`__:

|maintainer-etobella|

This module is part of the `OCA/sign <https://github.com/OCA/sign/tree/14.0/sign_oca>`_ project on GitHub.

You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute.
8 changes: 3 additions & 5 deletions sign_oca/readme/ROADMAP.rst
Original file line number Diff line number Diff line change
@@ -1,9 +1,7 @@
Detected issues
~~~~~~~~~~~~~~~

* Add a help on the configuration

Tasks
~~~~~

* Make some kind of log in order to ensure the inalterability of the signature
* Ensure that the signature is inalterable.
Maybe we might need to use some tools like endevise or pyHanko with a certificate.
Signer can be authenticated using OTP.
Loading

0 comments on commit 20ae772

Please sign in to comment.