audrius/contract
1
0
Fork 1
mirror of https://github.com/OCA/contract.git synced 2025-02-13 17:57:24 +02:00
Code Issues Packages Projects Releases Wiki Activity

[IMP] Documentation

Browse Source
This commit is contained in:
Maxime Chambreuil
2018-10-16 10:43:44 -05:00
parent 7d40232093
commit 98af456370
8 changed files with 56 additions and 32 deletions
Download Patch File Download Diff File Expand all files Collapse all files

31
agreement/README.md
View File

@@ -1,31 +0,0 @@
Agreements
This module adds Agreements to the partner module.
Usage
To use this module, you need to:
1. .
Known issues / Roadmap
* .
Bug Tracker
Bugs are tracked on GitHub Issues. 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 feedback.
Credits
Images
* Agreement: Icon.
Contributors
* Patrick Wilson <pwilson@pavlovmedia.com>
* Bhavesh Odedra <bodedra@opensourceintegrators.com>
Do not contact contributors directly about support or help with technical issues.
Maintainer

21
agreement/README.rst Normal file
View File

@@ -0,0 +1,21 @@
**This file is going to be generated by oca-gen-addon-readme.**
*Manual changes will be overwritten.*
Please provide content in the ``readme`` directory:
* **DESCRIPTION.rst** (required)
* INSTALL.rst (optional)
* CONFIGURE.rst (optional)
* **USAGE.rst** (optional, highly recommended)
* DEVELOP.rst (optional)
* ROADMAP.rst (optional)
* HISTORY.rst (optional, recommended)
* **CONTRIBUTORS.rst** (optional, highly recommended)
* CREDITS.rst (optional)
Content of this README will also be drawn from the addon manifest,
from keys such as name, authors, maintainers, development_status,
and license.
A good, one sentence summary in the manifest is also highly recommended.

6
agreement/__manifest__.py
View File

@@ -4,7 +4,9 @@
{
"name": "Agreements",
"summary": "Manage Agreements, LOI and Contracts",
"author": "Pavlov Media, Odoo Community Association (OCA)",
"author": "Pavlov Media, "
"Open Source Integrators, "
"Odoo Community Association (OCA)",
"website": "https://github.com/OCA/contract",
"category": "Partner",
"license": "AGPL-3",
@@ -27,4 +29,6 @@
"security/ir.model.access.csv",
],
"application": True,
"development_status": "Beta",
"maintainers": "max3903",
}

6
agreement/readme/CONFIGURE.rst Normal file
View File

@@ -0,0 +1,6 @@
To configure this module:
* Go to Agreement > Configuration > Templates
* Create a new template with sections and clauses and their respective content
* Go to Agreement > Configuration > Stages
* Create and reorder stages to match your process

4
agreement/readme/CONTRIBUTORS.rst Normal file
View File

@@ -0,0 +1,4 @@
* Patrick Wilson <pwilson@pavlovmedia.com>
* Bhavesh Odedra <bodedra@opensourceintegrators.com>
* Wolfgang Hall <whall@opensourceintegrators.com>
* Maxime Chambreuil <mchambreuil@opensourceintegrators.com>

4
agreement/readme/CREDITS.rst Normal file
View File

@@ -0,0 +1,4 @@
The development of this module has been financially supported by:
* Pavlov Media
* Open Source Integrators

9
agreement/readme/DESCRIPTION.rst Normal file
View File

@@ -0,0 +1,9 @@
This module allows you to manage agreements, letter of intent and contract content.
The module is meant to be used by the legal team of a company and to allow them
to define sections, clauses and templates with their respective content that can
be dynamic.
Based on the template, an agreement can be created and the pdf document generated.
The agreement would go through a workflow to finally become a contract with the
customer signature.

7
agreement/readme/USAGE.rst Normal file
View File

@@ -0,0 +1,7 @@
To use this module:
* Go to Agreement > Agrements
* Create a new agreement
* Select a template
* Follow the process to get the required approval
* Send the invitation to the customer to review and sign the agreement