From 8d330cd86a4fb0a3b5be1e0eea6d0ff45b7c69df Mon Sep 17 00:00:00 2001 From: Alexandre Fayolle Date: Wed, 5 Jun 2019 22:20:37 +0200 Subject: [PATCH] [FIX] lint errors in README files and add missing README.rst files (copied from 9.0 branch) and fix some manifest files --- attachment_preview/README.rst | 7 +- document_no_unique_filenames/README.rst | 3 + document_no_unique_filenames/__openerp__.py | 2 +- document_page/README.rst | 68 ++++++++++++++++ document_page/__openerp__.py | 7 +- document_page/wizard/__init__.py | 2 - .../wizard/document_page_create_menu.py | 3 - .../wizard/document_page_show_diff.py | 2 - document_page_approval/README.rst | 81 +++++++++++++++++++ document_page_approval/__openerp__.py | 18 +---- document_page_partner_id/README.rst | 7 +- document_url/README.rst | 57 +++++++++++++ document_url/__openerp__.py | 5 +- 13 files changed, 223 insertions(+), 39 deletions(-) create mode 100644 document_page/README.rst create mode 100644 document_page_approval/README.rst create mode 100644 document_url/README.rst diff --git a/attachment_preview/README.rst b/attachment_preview/README.rst index 6dcebbd4..3f984f32 100644 --- a/attachment_preview/README.rst +++ b/attachment_preview/README.rst @@ -1,3 +1,8 @@ +.. image:: https://img.shields.io/badge/licence-AGPL--3-blue.svg + :target: http://www.gnu.org/licenses/agpl-3.0-standalone.html + :alt: License: AGPL-3 + +=================== Preview attachments =================== @@ -11,7 +16,7 @@ Installation For filetype recognition, you'll get the best results by installing ``python-magic``:: -sudo apt-get install python-magic + sudo apt-get install python-magic Usage ===== diff --git a/document_no_unique_filenames/README.rst b/document_no_unique_filenames/README.rst index 23fcec00..cad2920b 100644 --- a/document_no_unique_filenames/README.rst +++ b/document_no_unique_filenames/README.rst @@ -1,5 +1,8 @@ .. image:: https://img.shields.io/badge/licence-AGPL--3-blue.svg + :target: http://www.gnu.org/licenses/agpl-3.0-standalone.html :alt: License: AGPL-3 + +================================== No unique filenames in directories ================================== diff --git a/document_no_unique_filenames/__openerp__.py b/document_no_unique_filenames/__openerp__.py index af99976f..e4e8bc81 100644 --- a/document_no_unique_filenames/__openerp__.py +++ b/document_no_unique_filenames/__openerp__.py @@ -21,7 +21,7 @@ { "name": "No unique filenames in directories", "version": "8.0.1.0.0", - "author": "Therp BV", + "author": "Therp BV,Odoo Community Association (OCA)", "license": "AGPL-3", "category": "Knowledge Management", "summary": "Drop the uniquness constraint on filenames for directories", diff --git a/document_page/README.rst b/document_page/README.rst new file mode 100644 index 00000000..e55abf17 --- /dev/null +++ b/document_page/README.rst @@ -0,0 +1,68 @@ +.. image:: https://img.shields.io/badge/licence-AGPL--3-blue.svg + :target: http://www.gnu.org/licenses/agpl-3.0-standalone.html + :alt: License: AGPL-3 + +============= +Document Page +============= + +This module allows you to write web pages for internal documentation. + +Installation +============ + +This module depends on module knowledge. So make sure to have it in your addons list. + +Configuration +============= + +No configuration required + +Usage +===== + +To use this module, you need to: + +* Go to Knowledge menu +* Click on Categories to create the document's category you need with the template +* Click on Pages to create pages and select the previous category to use the template + + +.. image:: https://odoo-community.org/website/image/ir.attachment/5784_f2813bd/datas + :alt: Try me on Runbot + :target: https://runbot.odoo-community.org/runbot/118/8.0 + +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 `here `_. + +Credits +======= + +Contributors +------------ + +* Odoo SA +* Savoir-faire Linux +* Gervais Naoussi + +Maintainer +---------- + +.. image:: https://odoo-community.org/logo.png + :alt: Odoo Community Association + :target: https://odoo-community.org + +This module is maintained by the OCA. + +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. + +To contribute to this module, please visit http://odoo-community.org. diff --git a/document_page/__openerp__.py b/document_page/__openerp__.py index 17628eb1..7bbc662b 100644 --- a/document_page/__openerp__.py +++ b/document_page/__openerp__.py @@ -23,12 +23,7 @@ 'name': 'Document Page', 'version': '8.0.1.0.2', 'category': 'Knowledge Management', - 'description': """ -Pages -===== -Web pages - """, - 'author': ['OpenERP SA'], + 'author': 'OpenERP SA,Odoo Community Association (OCA)', 'website': 'http://www.openerp.com/', 'license': 'AGPL-3', 'depends': [ diff --git a/document_page/wizard/__init__.py b/document_page/wizard/__init__.py index 3348328b..af150490 100644 --- a/document_page/wizard/__init__.py +++ b/document_page/wizard/__init__.py @@ -20,5 +20,3 @@ ############################################################################## from . import document_page_create_menu from . import document_page_show_diff - -# vim:expandtab:smartindent:tabstop=4:softtabstop=4:shiftwidth=4: diff --git a/document_page/wizard/document_page_create_menu.py b/document_page/wizard/document_page_create_menu.py index 91821718..325fea51 100644 --- a/document_page/wizard/document_page_create_menu.py +++ b/document_page/wizard/document_page_create_menu.py @@ -86,6 +86,3 @@ class document_page_create_menu(models.TransientModel): 'type': 'ir.actions.client', 'tag': 'reload', } - - -# vim:expandtab:smartindent:tabstop=4:softtabstop=4:shiftwidth=4: diff --git a/document_page/wizard/document_page_show_diff.py b/document_page/wizard/document_page_show_diff.py index 25a93de2..6d359a66 100644 --- a/document_page/wizard/document_page_show_diff.py +++ b/document_page/wizard/document_page_show_diff.py @@ -57,5 +57,3 @@ class showdiff(models.TransientModel): readonly=True, default=get_diff ) - -# vim:expandtab:smartindent:tabstop=4:softtabstop=4:shiftwidth=4: diff --git a/document_page_approval/README.rst b/document_page_approval/README.rst new file mode 100644 index 00000000..05645b22 --- /dev/null +++ b/document_page_approval/README.rst @@ -0,0 +1,81 @@ +.. image:: https://img.shields.io/badge/licence-AGPL--3-blue.svg + :target: http://www.gnu.org/licenses/agpl-3.0-standalone.html + :alt: License: AGPL-3 + +====================== +Document Page Approval +====================== + +This module adds a workflow to approve page modification and show the approved +version by default. + +Installation +============ + +Makes the document page approval available from where some users can approved the modifications +made by others users in documents that required approvement. + +Configuration +============= + +No configuration required + +Usage +===== + +To use this module, you need to: + +* Set a valid email address on the company settings. +* go to knowledge > Categories. +* Create a new page category and set an approver group. Make sure users + belonging to that group have valid email addresses. +* go to knowledge > Pages +* Create a new page and choose the previously created category. +* A notification is sent to the group with a link to the page history to + review. +* Depending on the review, the page history is approved or not. +* Users reading the page see the last approved version. + +.. image:: https://odoo-community.org/website/image/ir.attachment/5784_f2813bd/datas + :alt: Try me on Runbot + :target: https://runbot.odoo-community.org/runbot/118/8.0 + +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 `here `_. + + +Credits +======= + +Contributors +------------ + +* Odoo SA +* Savoir-faire Linux +* Gervais Naoussi + +Maintainer +---------- + +.. image:: https://odoo-community.org/logo.png + :alt: Odoo Community Association + :target: https://odoo-community.org + +This module is maintained by the OCA. + +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. + +To contribute to this module, please visit http://odoo-community.org. + + diff --git a/document_page_approval/__openerp__.py b/document_page_approval/__openerp__.py index a60b5a0c..c87dac8c 100644 --- a/document_page_approval/__openerp__.py +++ b/document_page_approval/__openerp__.py @@ -1,4 +1,4 @@ -# -*- encoding: utf-8 -*- +# -*- coding: utf-8 -*- ############################################################################## # # OpenERP, Open Source Management Solution @@ -26,22 +26,6 @@ "website": "http://www.savoirfairelinux.com", "license": "AGPL-3", 'category': 'Knowledge Management', - 'description': """ -This module adds a workflow to approve page modification and show the approved -version by default. - -Scenario -======== - -* Set a valid email address on the company settings. -* Create a new page category and set an approver group. Make sure users - belonging to that group have valid email addresses. -* Create a new page and choose the previously created category. -* A notification is sent to the group with a link to the page history to - review. -* Depending on the review, the page history is approved or not. -* Users reading the page see the last approved version. - """, 'depends': [ 'knowledge', 'document_page', diff --git a/document_page_partner_id/README.rst b/document_page_partner_id/README.rst index 08ec1348..2ae90676 100644 --- a/document_page_partner_id/README.rst +++ b/document_page_partner_id/README.rst @@ -1,5 +1,7 @@ .. image:: https://img.shields.io/badge/licence-AGPL--3-blue.svg - :alt: License: AGPL-3 + :target: http://www.gnu.org/licenses/agpl-3.0-standalone.html + :alt: License: AGPL-3 + =================================== Link to a partner in document pages =================================== @@ -11,9 +13,8 @@ Usage To use this module, simply fill in a partner for some pages, then you can search by partner or group by partner. -* go to ... .. image:: https://odoo-community.org/website/image/ir.attachment/5784_f2813bd/datas -:alt: Try me on Runbotknowl + :alt: Try me on Runbotknowl :target: https://runbot.odoo-community.org/runbot/118/8.0 Bug Tracker diff --git a/document_url/README.rst b/document_url/README.rst new file mode 100644 index 00000000..db6f9268 --- /dev/null +++ b/document_url/README.rst @@ -0,0 +1,57 @@ +.. image:: https://img.shields.io/badge/licence-AGPL--3-blue.svg + :target: http://www.gnu.org/licenses/agpl-3.0-standalone.html + :alt: License: AGPL-3 + +============== +URL attachment +============== + +Module that allows to attach an URL as a document. + +Installation +============ + +To install this module, you need to click on install + +Usage +===== + +To use this module, you need to: + + * go to menu more and click on add an url. + * Insert name and url into the wizard. + +.. image:: https://odoo-community.org/website/image/ir.attachment/5784_f2813bd/datas + :alt: Try me on Runbot + :target: https://runbot.odoo-community.org/runbot/118/8.0 + +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 +`here `_. + +Credits +======= + +Contributors +------------ + +* Jonathan Nemry +* Pedro M. Baeza +* Jairo Llopis + +Maintainer +---------- + +.. image:: https://odoo-community.org/logo.png + :alt: Odoo Community Association + :target: https://odoo-community.org + +This module is maintained by the OCA. + +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. + +To contribute to this module, please visit https://odoo-community.org. diff --git a/document_url/__openerp__.py b/document_url/__openerp__.py index b2af4554..f2ad3143 100644 --- a/document_url/__openerp__.py +++ b/document_url/__openerp__.py @@ -1,4 +1,4 @@ -# -*- encoding: utf-8 -*- +# -*- coding: utf-8 -*- ############################################################################## # # OpenERP, Open Source Management Solution @@ -24,9 +24,6 @@ 'name': 'URL attachment', 'version': '8.0.1.0.0', 'category': 'Tools', - 'description': """ -Module that allows to attach an URL as a document. - """, 'author': "Serv. Tecnol. Avanzados - Pedro M. Baeza," "Odoo Community Association (OCA)", 'website': 'http://www.serviciosbaeza.com',