diff --git a/crm_usability_misc/README.rst b/crm_usability_misc/README.rst index 0bb2dce..398cc72 100644 --- a/crm_usability_misc/README.rst +++ b/crm_usability_misc/README.rst @@ -1,199 +1,51 @@ -.. image:: https://odoo-community.org/readme-banner-image - :target: https://odoo-community.org/get-involved?utm_source=readme - :alt: Odoo Community Association +=============== +crm_usability_misc +=============== -================== -crm usability misc -================== - -.. - !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! - !! This file is generated by oca-gen-addon-readme !! - !! changes will be overwritten. !! - !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! - !! source digest: sha256:be78325679fda626093147ef1d7023041e2544e8c1cca85c4c7199e4848f8c6f - !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! - -.. |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/license-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-Elabore%2Fcrm--tools-lightgray.png?logo=github - :target: https://github.com/Elabore/crm-tools/tree/16.0/crm_usability_misc - :alt: Elabore/crm-tools - -|badge1| |badge2| |badge3| - -[ This file must be max 2-3 paragraphs, and is required. - -The goal of this document is to explain quickly the features of this -module: “what” this module does and “what” it is for. ] - -Example: - -This module extends the functionality of ... to support ... and to allow -users to ... - -**Table of contents** - -.. contents:: - :local: - -Use Cases / Context -=================== - -[ This file is optional but strongly suggested to allow end-users to -evaluate the module's usefulness in their context. ] - -BUSINESS NEED: It should explain the “why” of the module: - -- what is the business requirement that generated the need to develop - this module -- in which context or use cases this module can be useful (practical - examples are welcome!). - -APPROACH: It could also explain the approach to address the mentioned -need. - -USEFUL INFORMATION: It can also inform on related modules: - -- modules it depends on and their features -- other modules that can work well together with this one -- suggested setups where the module is useful (eg: multicompany, - multi-website) +Various modification of CRM app Installation ============ -[ This file must only be present if there are very specific installation -instructions, such as installing non-python dependencies. The audience -is systems administrators. ] +Use Odoo normal module installation procedure to install +``crm_usability_misc``. -To install this module, you need to: +Description +=========== -1. Do this ... - -Configuration -============= - -[ This file is not always required; it should explain **how to configure -the module before using it**; it is aimed at users with administration -privileges. - -Please be detailed on the path to configuration (eg: do you need to -activate developer mode?), describe step by step configurations and the -use of screenshots is strongly recommended.] - -To configure this module, you need to: - -- Go to *App* > Menu > Menu item -- Activate boolean… > save -- … - -Usage -===== - -[ This file is required and contains the instructions on **“how”** to -use the module for end-users. - -If the module does not have a visible impact on the user interface, just -add the following sentence: - - This module does not impact the user interface. - -If that’s not the case, please make sure that every usage step is -covered and remember that images speak more than words!] - -To use this module, you need to: - -- Go to *App* > Menu > Menu item - - *insert screenshot!* - -- In “Contact” form, add a value to field *xyz* > save - - *insert screenshot!* - -- The value of *xyz* is now displayed in the list view. - - *insert screenshot!* +- Hide the Campaign and Medium fields +- Hove “Source” and “Referred by” under Tags +- Move “Sales team” under Phone Known issues / Roadmap ====================== -[ Enumerate known caveats and future potential improvements. It is -mostly intended for end-users, and can also help potential new -contributors discovering new features to implement. ] - -- ... - -Changelog -========= - -[ The change log. The goal of this file is to help readers understand -changes between version. The primary audience is end users and -integrators. Purely technical changes such as code refactoring must not -be mentioned here. - -This file may contain ONE level of section titles, underlined with the ~ -(tilde) character. Other section markers are forbidden and will likely -break the structure of the README.rst or other documents where this -fragment is included. ] - -11.0.x.y.z (YYYY-MM-DD) ------------------------ - -- [BREAKING] Breaking changes come first. - (`#70 `__) -- [ADD] New feature. (`#74 `__) -- [FIX] Correct this. (`#71 `__) - -11.0.x.y.z (YYYY-MM-DD) ------------------------ - -- ... +None yet. 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 to smash it by providing a detailed and welcomed -`feedback `_. - -Do not contact contributors directly about support or help with technical issues. +Bugs are tracked on `our issues website `_. 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 ======= -Authors -------- - -* Elabore - Contributors ------------ -- Firstname Lastname email.address@example.org (optional company website - url) -- Second Person second.person@example.org (optional company website url) +* `Elabore ` -Other credits -------------- - -[ This file is optional and contains additional credits, other than -authors, contributors, and maintainers. ] +Funders +------- The development of this module has been financially supported by: +* Elabore (https://elabore.coop) -- Company 1 name -- Company 2 name -Maintainers ------------ +Maintainer +---------- -This module is part of the `Elabore/crm-tools `_ project on GitHub. - -You are welcome to contribute. +This module is maintained by Elabore. \ No newline at end of file diff --git a/crm_usability_misc/readme/CONFIGURE.md b/crm_usability_misc/readme/CONFIGURE.md deleted file mode 100644 index 2fdb0e6..0000000 --- a/crm_usability_misc/readme/CONFIGURE.md +++ /dev/null @@ -1,10 +0,0 @@ -[ This file is not always required; it should explain **how to configure the module before using it**; it is aimed at users with administration privileges. - -Please be detailed on the path to configuration (eg: do you need to activate developer mode?), describe step by step configurations and the use of screenshots is strongly recommended.] - - -To configure this module, you need to: - -- Go to *App* > Menu > Menu item -- Activate boolean… > save -- … diff --git a/crm_usability_misc/readme/CONTEXT.md b/crm_usability_misc/readme/CONTEXT.md deleted file mode 100644 index 096235a..0000000 --- a/crm_usability_misc/readme/CONTEXT.md +++ /dev/null @@ -1,16 +0,0 @@ -[ This file is optional but strongly suggested to allow end-users to evaluate the -module's usefulness in their context. ] - -BUSINESS NEED: -It should explain the “why” of the module: -- what is the business requirement that generated the need to develop this module -- in which context or use cases this module can be useful (practical examples are welcome!). - -APPROACH: -It could also explain the approach to address the mentioned need. - -USEFUL INFORMATION: -It can also inform on related modules: -- modules it depends on and their features -- other modules that can work well together with this one -- suggested setups where the module is useful (eg: multicompany, multi-website) diff --git a/crm_usability_misc/readme/CONTRIBUTORS.md b/crm_usability_misc/readme/CONTRIBUTORS.md deleted file mode 100644 index 7be72fb..0000000 --- a/crm_usability_misc/readme/CONTRIBUTORS.md +++ /dev/null @@ -1,2 +0,0 @@ -- Firstname Lastname (optional company website url) -- Second Person (optional company website url) diff --git a/crm_usability_misc/readme/CREDITS.md b/crm_usability_misc/readme/CREDITS.md deleted file mode 100644 index 9c2b025..0000000 --- a/crm_usability_misc/readme/CREDITS.md +++ /dev/null @@ -1,7 +0,0 @@ -[ This file is optional and contains additional credits, other than - authors, contributors, and maintainers. ] - -The development of this module has been financially supported by: - -- Company 1 name -- Company 2 name diff --git a/crm_usability_misc/readme/DESCRIPTION.md b/crm_usability_misc/readme/DESCRIPTION.md deleted file mode 100644 index 2371a14..0000000 --- a/crm_usability_misc/readme/DESCRIPTION.md +++ /dev/null @@ -1,7 +0,0 @@ -[ This file must be max 2-3 paragraphs, and is required. - -The goal of this document is to explain quickly the features of this module: “what” this module does and “what” it is for. ] - -Example: - -This module extends the functionality of ... to support ... and to allow users to ... diff --git a/crm_usability_misc/readme/HISTORY.md b/crm_usability_misc/readme/HISTORY.md deleted file mode 100644 index a6daf58..0000000 --- a/crm_usability_misc/readme/HISTORY.md +++ /dev/null @@ -1,22 +0,0 @@ -[ The change log. The goal of this file is to help readers - understand changes between version. The primary audience is - end users and integrators. Purely technical changes such as - code refactoring must not be mentioned here. - - This file may contain ONE level of section titles, underlined - with the ~ (tilde) character. Other section markers are - forbidden and will likely break the structure of the README.rst - or other documents where this fragment is included. ] - -## 11.0.x.y.z (YYYY-MM-DD) - -- [BREAKING] Breaking changes come first. - ([#70](https://github.com/OCA/repo/issues/70)) -- [ADD] New feature. - ([#74](https://github.com/OCA/repo/issues/74)) -- [FIX] Correct this. - ([#71](https://github.com/OCA/repo/issues/71)) - -## 11.0.x.y.z (YYYY-MM-DD) - -- ... diff --git a/crm_usability_misc/readme/INSTALL.md b/crm_usability_misc/readme/INSTALL.md deleted file mode 100644 index 77b98e7..0000000 --- a/crm_usability_misc/readme/INSTALL.md +++ /dev/null @@ -1,7 +0,0 @@ -[ This file must only be present if there are very specific - installation instructions, such as installing non-python - dependencies. The audience is systems administrators. ] - -To install this module, you need to: - -1. Do this ... diff --git a/crm_usability_misc/readme/ROADMAP.md b/crm_usability_misc/readme/ROADMAP.md deleted file mode 100644 index 446840c..0000000 --- a/crm_usability_misc/readme/ROADMAP.md +++ /dev/null @@ -1,5 +0,0 @@ -[ Enumerate known caveats and future potential improvements. - It is mostly intended for end-users, and can also help - potential new contributors discovering new features to implement. ] - -- ... diff --git a/crm_usability_misc/readme/USAGE.md b/crm_usability_misc/readme/USAGE.md deleted file mode 100644 index 2cf1275..0000000 --- a/crm_usability_misc/readme/USAGE.md +++ /dev/null @@ -1,21 +0,0 @@ -[ This file is required and contains the instructions on **“how”** to use the module for end-users. - -If the module does not have a visible impact on the user interface, just add the following sentence: - -> This module does not impact the user interface. - -If that’s not the case, please make sure that every usage step is covered and remember that images speak more than words!] - -To use this module, you need to: - -- Go to *App* > Menu > Menu item - - *insert screenshot!* - -- In “Contact” form, add a value to field *xyz* > save - - *insert screenshot!* - -- The value of *xyz* is now displayed in the list view. - - *insert screenshot!*