From 928e1188871874ca79ff1efe3d69b76a32aa7029 Mon Sep 17 00:00:00 2001 From: Raf Ven Date: Fri, 19 Jul 2024 14:27:33 +0200 Subject: [PATCH] [IMP] partner_tier_validation: pre-commit stuff --- partner_tier_validation/README.rst | 77 +++++++++---------- partner_tier_validation/pyproject.toml | 3 + .../readme/CONTRIBUTORS.md | 4 + .../readme/CONTRIBUTORS.rst | 5 -- partner_tier_validation/readme/DESCRIPTION.md | 12 +++ .../readme/DESCRIPTION.rst | 12 --- partner_tier_validation/readme/INSTALL.md | 2 + partner_tier_validation/readme/INSTALL.rst | 2 - partner_tier_validation/readme/USAGE.md | 24 ++++++ partner_tier_validation/readme/USAGE.rst | 24 ------ .../static/description/index.html | 64 +++++++-------- 11 files changed, 117 insertions(+), 112 deletions(-) create mode 100644 partner_tier_validation/pyproject.toml create mode 100644 partner_tier_validation/readme/CONTRIBUTORS.md delete mode 100644 partner_tier_validation/readme/CONTRIBUTORS.rst create mode 100644 partner_tier_validation/readme/DESCRIPTION.md delete mode 100644 partner_tier_validation/readme/DESCRIPTION.rst create mode 100644 partner_tier_validation/readme/INSTALL.md delete mode 100644 partner_tier_validation/readme/INSTALL.rst create mode 100644 partner_tier_validation/readme/USAGE.md delete mode 100644 partner_tier_validation/readme/USAGE.rst diff --git a/partner_tier_validation/README.rst b/partner_tier_validation/README.rst index 803e62b8884..9982d601095 100644 --- a/partner_tier_validation/README.rst +++ b/partner_tier_validation/README.rst @@ -17,29 +17,29 @@ Partner Tier Validation :target: http://www.gnu.org/licenses/agpl-3.0-standalone.html :alt: License: AGPL-3 .. |badge3| image:: https://img.shields.io/badge/github-OCA%2Fpartner--contact-lightgray.png?logo=github - :target: https://github.com/OCA/partner-contact/tree/16.0/partner_tier_validation + :target: https://github.com/OCA/partner-contact/tree/17.0/partner_tier_validation :alt: OCA/partner-contact .. |badge4| image:: https://img.shields.io/badge/weblate-Translate%20me-F47D42.png - :target: https://translation.odoo-community.org/projects/partner-contact-16-0/partner-contact-16-0-partner_tier_validation + :target: https://translation.odoo-community.org/projects/partner-contact-17-0/partner-contact-17-0-partner_tier_validation :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/partner-contact&target_branch=16.0 + :target: https://runboat.odoo-community.org/builds?repo=OCA/partner-contact&target_branch=17.0 :alt: Try me on Runboat |badge1| |badge2| |badge3| |badge4| |badge5| -Adds an approval workflow to Partners. -The default rule requires new company Contacts to be approved -before they can be used. +Adds an approval workflow to Partners. The default rule requires new +company Contacts to be approved before they can be used. -The rule can be extended to new non-company contact, -but beware that may cause issues with automatically created new contacts, -such as the ones generated when processing incoming emails. +The rule can be extended to new non-company contact, but beware that may +cause issues with automatically created new contacts, such as the ones +generated when processing incoming emails. -If the 'Is Company' or 'Parent' field changes then the contact is Request -for approval. +If the 'Is Company' or 'Parent' field changes then the contact is +Request for approval. -For this, the new Contact record is kept as "Archived" until it is approved. +For this, the new Contact record is kept as "Archived" until it is +approved. **Table of contents** @@ -50,35 +50,34 @@ Installation ============ This module depends on ``base_tier_validation``. You can find it at -`OCA/server-ux `_ +`OCA/server-ux `__ Usage ===== -Before using, check Contact Stages configuration, -to ensure that the default stage has the "Related State" field -set to "To Approve". -For example, having the "Draft" stage the default ensures this. +Before using, check Contact Stages configuration, to ensure that the +default stage has the "Related State" field set to "To Approve". For +example, having the "Draft" stage the default ensures this. A regular user creates a new Contact and sends it for approval: -#. Create a Contact triggering at least one "Tier Definition". - The Contact will be in Draft state and marked as Archived until approved. -#. Click on *Request Validation* button. -#. In the *Reviews* section, at the bottom of the form, inspect the pending reviews and their status. - +1. Create a Contact triggering at least one "Tier Definition". The + Contact will be in Draft state and marked as Archived until approved. +2. Click on *Request Validation* button. +3. In the *Reviews* section, at the bottom of the form, inspect the + pending reviews and their status. The approver reviews Contacts to approve: -#. Navigate to the Contacts app, and select the filter "Needs my Approval" -#. Open the Contact form to approve. It will display a - "This Records needs to be validated" banner, with "Validate" and "Reject" options. -#. The approver can change the state to "Active". - This will automatically unarchive the record and make it available to be used. - +1. Navigate to the Contacts app, and select the filter "Needs my + Approval" +2. Open the Contact form to approve. It will display a "This Records + needs to be validated" banner, with "Validate" and "Reject" options. +3. The approver can change the state to "Active". This will + automatically unarchive the record and make it available to be used. -The Approve/Reject actions do not automatically change the State. -This could be a future improvement. +The Approve/Reject actions do not automatically change the State. This +could be a future improvement. Bug Tracker =========== @@ -86,7 +85,7 @@ 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 `_. +`feedback `_. Do not contact contributors directly about support or help with technical issues. @@ -94,21 +93,21 @@ Credits ======= Authors -~~~~~~~ +------- * Open Source Integrators Contributors -~~~~~~~~~~~~ +------------ -* `Open Source Integrators `_. +- `Open Source Integrators `__. - * Antonio Yamuta - * Daniel Reis - * Urvisha Desai + - Antonio Yamuta + - Daniel Reis + - Urvisha Desai Maintainers -~~~~~~~~~~~ +----------- This module is maintained by the OCA. @@ -128,6 +127,6 @@ Current `maintainer `__: |maintainer-dreispt| -This module is part of the `OCA/partner-contact `_ project on GitHub. +This module is part of the `OCA/partner-contact `_ project on GitHub. You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute. diff --git a/partner_tier_validation/pyproject.toml b/partner_tier_validation/pyproject.toml new file mode 100644 index 00000000000..4231d0cccb3 --- /dev/null +++ b/partner_tier_validation/pyproject.toml @@ -0,0 +1,3 @@ +[build-system] +requires = ["whool"] +build-backend = "whool.buildapi" diff --git a/partner_tier_validation/readme/CONTRIBUTORS.md b/partner_tier_validation/readme/CONTRIBUTORS.md new file mode 100644 index 00000000000..4b26e0b41b6 --- /dev/null +++ b/partner_tier_validation/readme/CONTRIBUTORS.md @@ -0,0 +1,4 @@ +- [Open Source Integrators](https://opensourceintegrators.com). + - Antonio Yamuta \<\> + - Daniel Reis \<\> + - Urvisha Desai \<\> diff --git a/partner_tier_validation/readme/CONTRIBUTORS.rst b/partner_tier_validation/readme/CONTRIBUTORS.rst deleted file mode 100644 index f3a6bc52754..00000000000 --- a/partner_tier_validation/readme/CONTRIBUTORS.rst +++ /dev/null @@ -1,5 +0,0 @@ -* `Open Source Integrators `_. - - * Antonio Yamuta - * Daniel Reis - * Urvisha Desai diff --git a/partner_tier_validation/readme/DESCRIPTION.md b/partner_tier_validation/readme/DESCRIPTION.md new file mode 100644 index 00000000000..639cb2859fd --- /dev/null +++ b/partner_tier_validation/readme/DESCRIPTION.md @@ -0,0 +1,12 @@ +Adds an approval workflow to Partners. The default rule requires new +company Contacts to be approved before they can be used. + +The rule can be extended to new non-company contact, but beware that may +cause issues with automatically created new contacts, such as the ones +generated when processing incoming emails. + +If the 'Is Company' or 'Parent' field changes then the contact is +Request for approval. + +For this, the new Contact record is kept as "Archived" until it is +approved. diff --git a/partner_tier_validation/readme/DESCRIPTION.rst b/partner_tier_validation/readme/DESCRIPTION.rst deleted file mode 100644 index fe2b83fe66f..00000000000 --- a/partner_tier_validation/readme/DESCRIPTION.rst +++ /dev/null @@ -1,12 +0,0 @@ -Adds an approval workflow to Partners. -The default rule requires new company Contacts to be approved -before they can be used. - -The rule can be extended to new non-company contact, -but beware that may cause issues with automatically created new contacts, -such as the ones generated when processing incoming emails. - -If the 'Is Company' or 'Parent' field changes then the contact is Request -for approval. - -For this, the new Contact record is kept as "Archived" until it is approved. diff --git a/partner_tier_validation/readme/INSTALL.md b/partner_tier_validation/readme/INSTALL.md new file mode 100644 index 00000000000..c45725c465b --- /dev/null +++ b/partner_tier_validation/readme/INSTALL.md @@ -0,0 +1,2 @@ +This module depends on `base_tier_validation`. You can find it at +[OCA/server-ux](https://github.com/OCA/server-ux) diff --git a/partner_tier_validation/readme/INSTALL.rst b/partner_tier_validation/readme/INSTALL.rst deleted file mode 100644 index 638fbd2d688..00000000000 --- a/partner_tier_validation/readme/INSTALL.rst +++ /dev/null @@ -1,2 +0,0 @@ -This module depends on ``base_tier_validation``. You can find it at -`OCA/server-ux `_ diff --git a/partner_tier_validation/readme/USAGE.md b/partner_tier_validation/readme/USAGE.md new file mode 100644 index 00000000000..b5fa5eccc56 --- /dev/null +++ b/partner_tier_validation/readme/USAGE.md @@ -0,0 +1,24 @@ +Before using, check Contact Stages configuration, to ensure that the +default stage has the "Related State" field set to "To Approve". For +example, having the "Draft" stage the default ensures this. + +A regular user creates a new Contact and sends it for approval: + +1. Create a Contact triggering at least one "Tier Definition". The + Contact will be in Draft state and marked as Archived until + approved. +2. Click on *Request Validation* button. +3. In the *Reviews* section, at the bottom of the form, inspect the + pending reviews and their status. + +The approver reviews Contacts to approve: + +1. Navigate to the Contacts app, and select the filter "Needs my + Approval" +2. Open the Contact form to approve. It will display a "This Records + needs to be validated" banner, with "Validate" and "Reject" options. +3. The approver can change the state to "Active". This will + automatically unarchive the record and make it available to be used. + +The Approve/Reject actions do not automatically change the State. This +could be a future improvement. diff --git a/partner_tier_validation/readme/USAGE.rst b/partner_tier_validation/readme/USAGE.rst deleted file mode 100644 index fb81ae01d5c..00000000000 --- a/partner_tier_validation/readme/USAGE.rst +++ /dev/null @@ -1,24 +0,0 @@ -Before using, check Contact Stages configuration, -to ensure that the default stage has the "Related State" field -set to "To Approve". -For example, having the "Draft" stage the default ensures this. - -A regular user creates a new Contact and sends it for approval: - -#. Create a Contact triggering at least one "Tier Definition". - The Contact will be in Draft state and marked as Archived until approved. -#. Click on *Request Validation* button. -#. In the *Reviews* section, at the bottom of the form, inspect the pending reviews and their status. - - -The approver reviews Contacts to approve: - -#. Navigate to the Contacts app, and select the filter "Needs my Approval" -#. Open the Contact form to approve. It will display a - "This Records needs to be validated" banner, with "Validate" and "Reject" options. -#. The approver can change the state to "Active". - This will automatically unarchive the record and make it available to be used. - - -The Approve/Reject actions do not automatically change the State. -This could be a future improvement. diff --git a/partner_tier_validation/static/description/index.html b/partner_tier_validation/static/description/index.html index 5b4b42ec7be..3f9d271bd53 100644 --- a/partner_tier_validation/static/description/index.html +++ b/partner_tier_validation/static/description/index.html @@ -8,10 +8,11 @@ /* :Author: David Goodger (goodger@python.org) -:Id: $Id: html4css1.css 8954 2022-01-20 10:10:25Z milde $ +:Id: $Id: html4css1.css 9511 2024-01-13 09:50:07Z milde $ :Copyright: This stylesheet has been placed in the public domain. Default cascading style sheet for the HTML output of Docutils. +Despite the name, some widely supported CSS2 features are used. See https://docutils.sourceforge.io/docs/howto/html-stylesheets.html for how to customize this style sheet. @@ -274,7 +275,7 @@ margin-left: 2em ; margin-right: 2em } -pre.code .ln { color: grey; } /* line numbers */ +pre.code .ln { color: gray; } /* line numbers */ pre.code, code { background-color: #eeeeee } pre.code .comment, code .comment { color: #5C6576 } pre.code .keyword, code .keyword { color: #3B0D06; font-weight: bold } @@ -300,7 +301,7 @@ span.pre { white-space: pre } -span.problematic { +span.problematic, pre.problematic { color: red } span.section-subtitle { @@ -368,16 +369,16 @@

Partner Tier Validation

!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! !! source digest: sha256:930cc26243226cbf43d923b5d31be3b293d7e95643548c905d2dbe109a5116f1 !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! --> -

Beta License: AGPL-3 OCA/partner-contact Translate me on Weblate Try me on Runboat

-

Adds an approval workflow to Partners. -The default rule requires new company Contacts to be approved -before they can be used.

-

The rule can be extended to new non-company contact, -but beware that may cause issues with automatically created new contacts, -such as the ones generated when processing incoming emails.

-

If the ‘Is Company’ or ‘Parent’ field changes then the contact is Request -for approval.

-

For this, the new Contact record is kept as “Archived” until it is approved.

+

Beta License: AGPL-3 OCA/partner-contact Translate me on Weblate Try me on Runboat

+

Adds an approval workflow to Partners. The default rule requires new +company Contacts to be approved before they can be used.

+

The rule can be extended to new non-company contact, but beware that may +cause issues with automatically created new contacts, such as the ones +generated when processing incoming emails.

+

If the ‘Is Company’ or ‘Parent’ field changes then the contact is +Request for approval.

+

For this, the new Contact record is kept as “Archived” until it is +approved.

Table of contents

Usage

-

Before using, check Contact Stages configuration, -to ensure that the default stage has the “Related State” field -set to “To Approve”. -For example, having the “Draft” stage the default ensures this.

+

Before using, check Contact Stages configuration, to ensure that the +default stage has the “Related State” field set to “To Approve”. For +example, having the “Draft” stage the default ensures this.

A regular user creates a new Contact and sends it for approval:

    -
  1. Create a Contact triggering at least one “Tier Definition”. -The Contact will be in Draft state and marked as Archived until approved.
    2. +
  2. Create a Contact triggering at least one “Tier Definition”. The +Contact will be in Draft state and marked as Archived until approved.
  3. Click on Request Validation button.
    4. -
  4. In the Reviews section, at the bottom of the form, inspect the pending reviews and their status.
    5. +
  5. In the Reviews section, at the bottom of the form, inspect the +pending reviews and their status.

The approver reviews Contacts to approve:

    -
  1. Navigate to the Contacts app, and select the filter “Needs my Approval”
    2. -
  2. Open the Contact form to approve. It will display a -“This Records needs to be validated” banner, with “Validate” and “Reject” options.
    3. -
  3. The approver can change the state to “Active”. -This will automatically unarchive the record and make it available to be used.
    4. +
  4. Navigate to the Contacts app, and select the filter “Needs my +Approval”
    5. +
  5. Open the Contact form to approve. It will display a “This Records +needs to be validated” banner, with “Validate” and “Reject” options.
    6. +
  6. The approver can change the state to “Active”. This will +automatically unarchive the record and make it available to be used.
-

The Approve/Reject actions do not automatically change the State. -This could be a future improvement.

+

The Approve/Reject actions do not automatically change the State. This +could be a future improvement.

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.

+feedback.

Do not contact contributors directly about support or help with technical issues.

@@ -451,13 +453,15 @@

Contributors

Maintainers

This module is maintained by the OCA.

-Odoo Community Association + +Odoo Community Association +

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.

Current maintainer:

dreispt

-

This module is part of the OCA/partner-contact project on GitHub.

+

This module is part of the OCA/partner-contact project on GitHub.

You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute.