diff --git a/base_user_role/README.rst b/base_user_role/README.rst index 5016a8e0..a6d8c0de 100644 --- a/base_user_role/README.rst +++ b/base_user_role/README.rst @@ -17,36 +17,40 @@ User roles :target: http://www.gnu.org/licenses/lgpl-3.0-standalone.html :alt: License: LGPL-3 .. |badge3| image:: https://img.shields.io/badge/github-OCA%2Fserver--backend-lightgray.png?logo=github - :target: https://github.com/OCA/server-backend/tree/16.0/base_user_role + :target: https://github.com/OCA/server-backend/tree/17.0/base_user_role :alt: OCA/server-backend .. |badge4| image:: https://img.shields.io/badge/weblate-Translate%20me-F47D42.png - :target: https://translation.odoo-community.org/projects/server-backend-16-0/server-backend-16-0-base_user_role + :target: https://translation.odoo-community.org/projects/server-backend-17-0/server-backend-17-0-base_user_role :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/server-backend&target_branch=16.0 + :target: https://runboat.odoo-community.org/builds?repo=OCA/server-backend&target_branch=17.0 :alt: Try me on Runboat |badge1| |badge2| |badge3| |badge4| |badge5| -This module was written to extend the standard functionality regarding users -and groups management. -It helps creating well-defined user roles and associating them to users. +This module was written to extend the standard functionality regarding +users and groups management. It helps creating well-defined user roles +and associating them to users. -It can become very hard to maintain a large number of user profiles over time, -juggling with many technical groups. For this purpose, this module will help -you to: +It can become very hard to maintain a large number of user profiles over +time, juggling with many technical groups. For this purpose, this module +will help you to: - * define functional roles by aggregating low-level groups, - * set user accounts with the predefined roles (roles are cumulative), - * update groups of all relevant user accounts (all at once), - * ensure that user accounts will have the groups defined in their roles - (nothing more, nothing less). In other words, you can not set groups - manually on a user as long as there is roles configured on it, - * activate/deactivate roles depending on the date (useful to plan holidays, etc) - * get a quick overview of roles and the related user accounts. + - define functional roles by aggregating low-level groups, + - set user accounts with the predefined roles (roles are + cumulative), + - update groups of all relevant user accounts (all at once), + - ensure that user accounts will have the groups defined in their + roles (nothing more, nothing less). In other words, you can not + set groups manually on a user as long as there is roles configured + on it, + - activate/deactivate roles depending on the date (useful to plan + holidays, etc) + - get a quick overview of roles and the related user accounts. -That way you make clear the different responsabilities within a company, and -are able to add and update user accounts in a scalable and reliable way. +That way you make clear the different responsabilities within a company, +and are able to add and update user accounts in a scalable and reliable +way. **Table of contents** @@ -57,42 +61,42 @@ Configuration ============= To configure this module, you need to go to *Settings / Users / Roles*, -and create a new role. From there, you can add groups to compose your role, -and then associate users to it. +and create a new role. From there, you can add groups to compose your +role, and then associate users to it. -You can also define default roles for a new user by editing the user called -"Default User". +You can also define default roles for a new user by editing the user +called "Default User". Roles: -.. figure:: https://raw.githubusercontent.com/OCA/server-backend/16.0/base_user_role/static/description/roles.png - :width: 80 % - :align: center +|image1| Add groups: -.. figure:: https://raw.githubusercontent.com/OCA/server-backend/16.0/base_user_role/static/description/role_groups.png - :width: 80 % - :align: center +|image2| Add users (with dates or not): -.. figure:: https://raw.githubusercontent.com/OCA/server-backend/16.0/base_user_role/static/description/role_users.png - :width: 80 % - :align: center +|image3| Instead of creating roles from scratch, it is possible to create a role -based on the groups of an existing user: select or open the user and choose -"Create role from user" in the action menu. +based on the groups of an existing user: select or open the user and +choose "Create role from user" in the action menu. + +.. |image1| image:: https://raw.githubusercontent.com/OCA/server-backend/16.0/base_user_role/static/description/roles.png +.. |image2| image:: https://raw.githubusercontent.com/OCA/server-backend/16.0/base_user_role/static/description/role_groups.png +.. |image3| image:: https://raw.githubusercontent.com/OCA/server-backend/16.0/base_user_role/static/description/role_users.png Usage ===== To use this module, you need to: -#. Go to Configuration / Users / Users choose user and set Roles: +1. Go to Configuration / Users / Users choose user and set Roles: -.. image:: https://raw.githubusercontent.com/OCA/server-backend/base_user_role/static/description/user_form.png +|image| + +.. |image| image:: https://raw.githubusercontent.com/OCA/server-backend/base_user_role/static/description/user_form.png Bug Tracker =========== @@ -100,7 +104,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. @@ -108,35 +112,40 @@ Credits ======= Authors -~~~~~~~ +------- * ABF OSIELL Contributors -~~~~~~~~~~~~ +------------ -* Sébastien Alix -* Duc, Dao Dong (https://komit-consulting.com) -* Jean-Charles Drubay (https://komit-consulting.com) -* Alan Ramos (https://www.jarsa.com.mx) -* Harald Panten -* Kevin Khao -* Tatiana Deribina (https://sprintit.fi) -* Guillem Casassas -* Guillaume Pothier +- Sébastien Alix +- Duc, Dao Dong + (https://komit-consulting.com) +- Jean-Charles Drubay + (https://komit-consulting.com) +- Alan Ramos (https://www.jarsa.com.mx) +- Harald Panten +- Kevin Khao +- Tatiana Deribina (https://sprintit.fi) +- Guillem Casassas +- Guillaume Pothier -Do not contact contributors directly about support or help with technical issues. +Do not contact contributors directly about support or help with +technical issues. Other credits -~~~~~~~~~~~~~ +------------- Images ------- +~~~~~~ -* Oxygen Team: `Icon `_ (LGPL) +- Oxygen Team: + `Icon `__ + (LGPL) Maintainers -~~~~~~~~~~~ +----------- This module is maintained by the OCA. @@ -162,6 +171,6 @@ Current `maintainers `__: |maintainer-sebalix| |maintainer-jcdrubay| |maintainer-novawish| -This module is part of the `OCA/server-backend `_ project on GitHub. +This module is part of the `OCA/server-backend `_ project on GitHub. You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute. diff --git a/base_user_role/pyproject.toml b/base_user_role/pyproject.toml new file mode 100644 index 00000000..4231d0cc --- /dev/null +++ b/base_user_role/pyproject.toml @@ -0,0 +1,3 @@ +[build-system] +requires = ["whool"] +build-backend = "whool.buildapi" diff --git a/base_user_role/readme/CONFIGURE.md b/base_user_role/readme/CONFIGURE.md new file mode 100644 index 00000000..95a56381 --- /dev/null +++ b/base_user_role/readme/CONFIGURE.md @@ -0,0 +1,22 @@ +To configure this module, you need to go to *Settings / Users / Roles*, +and create a new role. From there, you can add groups to compose your +role, and then associate users to it. + +You can also define default roles for a new user by editing the user +called "Default User". + +Roles: + +![](/OCA/server-backend/16.0/base_user_role/static/description/roles.png) + +Add groups: + +![](/OCA/server-backend/16.0/base_user_role/static/description/role_groups.png) + +Add users (with dates or not): + +![](/OCA/server-backend/16.0/base_user_role/static/description/role_users.png) + +Instead of creating roles from scratch, it is possible to create a role +based on the groups of an existing user: select or open the user and +choose "Create role from user" in the action menu. diff --git a/base_user_role/readme/CONFIGURE.rst b/base_user_role/readme/CONFIGURE.rst deleted file mode 100644 index d54ecb10..00000000 --- a/base_user_role/readme/CONFIGURE.rst +++ /dev/null @@ -1,28 +0,0 @@ -To configure this module, you need to go to *Settings / Users / Roles*, -and create a new role. From there, you can add groups to compose your role, -and then associate users to it. - -You can also define default roles for a new user by editing the user called -"Default User". - -Roles: - -.. figure:: /OCA/server-backend/16.0/base_user_role/static/description/roles.png - :width: 80 % - :align: center - -Add groups: - -.. figure:: /OCA/server-backend/16.0/base_user_role/static/description/role_groups.png - :width: 80 % - :align: center - -Add users (with dates or not): - -.. figure:: /OCA/server-backend/16.0/base_user_role/static/description/role_users.png - :width: 80 % - :align: center - -Instead of creating roles from scratch, it is possible to create a role -based on the groups of an existing user: select or open the user and choose -"Create role from user" in the action menu. diff --git a/base_user_role/readme/CONTRIBUTORS.md b/base_user_role/readme/CONTRIBUTORS.md new file mode 100644 index 00000000..39d94fbe --- /dev/null +++ b/base_user_role/readme/CONTRIBUTORS.md @@ -0,0 +1,15 @@ +- Sébastien Alix \<\> +- Duc, Dao Dong \<\> + () +- Jean-Charles Drubay \<\> + () +- Alan Ramos \<\> () +- Harald Panten \<\> +- Kevin Khao \<\> +- Tatiana Deribina \<\> + () +- Guillem Casassas \<\> +- Guillaume Pothier \<\> + +Do not contact contributors directly about support or help with +technical issues. diff --git a/base_user_role/readme/CONTRIBUTORS.rst b/base_user_role/readme/CONTRIBUTORS.rst deleted file mode 100644 index 72507fec..00000000 --- a/base_user_role/readme/CONTRIBUTORS.rst +++ /dev/null @@ -1,11 +0,0 @@ -* Sébastien Alix -* Duc, Dao Dong (https://komit-consulting.com) -* Jean-Charles Drubay (https://komit-consulting.com) -* Alan Ramos (https://www.jarsa.com.mx) -* Harald Panten -* Kevin Khao -* Tatiana Deribina (https://sprintit.fi) -* Guillem Casassas -* Guillaume Pothier - -Do not contact contributors directly about support or help with technical issues. diff --git a/base_user_role/readme/CREDITS.md b/base_user_role/readme/CREDITS.md new file mode 100644 index 00000000..7c749e6c --- /dev/null +++ b/base_user_role/readme/CREDITS.md @@ -0,0 +1,5 @@ +## Images + +- Oxygen Team: + [Icon](http://www.iconarchive.com/show/oxygen-icons-by-oxygen-icons.org/Actions-user-group-new-icon.html) + (LGPL) diff --git a/base_user_role/readme/CREDITS.rst b/base_user_role/readme/CREDITS.rst deleted file mode 100644 index e4408914..00000000 --- a/base_user_role/readme/CREDITS.rst +++ /dev/null @@ -1,4 +0,0 @@ -Images ------- - -* Oxygen Team: `Icon `_ (LGPL) diff --git a/base_user_role/readme/DESCRIPTION.md b/base_user_role/readme/DESCRIPTION.md new file mode 100644 index 00000000..42ca49c0 --- /dev/null +++ b/base_user_role/readme/DESCRIPTION.md @@ -0,0 +1,22 @@ +This module was written to extend the standard functionality regarding +users and groups management. It helps creating well-defined user roles +and associating them to users. + +It can become very hard to maintain a large number of user profiles over +time, juggling with many technical groups. For this purpose, this module +will help you to: + +> - define functional roles by aggregating low-level groups, +> - set user accounts with the predefined roles (roles are cumulative), +> - update groups of all relevant user accounts (all at once), +> - ensure that user accounts will have the groups defined in their +> roles (nothing more, nothing less). In other words, you can not set +> groups manually on a user as long as there is roles configured on +> it, +> - activate/deactivate roles depending on the date (useful to plan +> holidays, etc) +> - get a quick overview of roles and the related user accounts. + +That way you make clear the different responsabilities within a company, +and are able to add and update user accounts in a scalable and reliable +way. diff --git a/base_user_role/readme/DESCRIPTION.rst b/base_user_role/readme/DESCRIPTION.rst deleted file mode 100644 index 70f94197..00000000 --- a/base_user_role/readme/DESCRIPTION.rst +++ /dev/null @@ -1,19 +0,0 @@ -This module was written to extend the standard functionality regarding users -and groups management. -It helps creating well-defined user roles and associating them to users. - -It can become very hard to maintain a large number of user profiles over time, -juggling with many technical groups. For this purpose, this module will help -you to: - - * define functional roles by aggregating low-level groups, - * set user accounts with the predefined roles (roles are cumulative), - * update groups of all relevant user accounts (all at once), - * ensure that user accounts will have the groups defined in their roles - (nothing more, nothing less). In other words, you can not set groups - manually on a user as long as there is roles configured on it, - * activate/deactivate roles depending on the date (useful to plan holidays, etc) - * get a quick overview of roles and the related user accounts. - -That way you make clear the different responsabilities within a company, and -are able to add and update user accounts in a scalable and reliable way. diff --git a/base_user_role/readme/USAGE.md b/base_user_role/readme/USAGE.md new file mode 100644 index 00000000..8d016e3f --- /dev/null +++ b/base_user_role/readme/USAGE.md @@ -0,0 +1,5 @@ +To use this module, you need to: + +1. Go to Configuration / Users / Users choose user and set Roles: + +![image](/OCA/server-backend/base_user_role/static/description/user_form.png) diff --git a/base_user_role/readme/USAGE.rst b/base_user_role/readme/USAGE.rst deleted file mode 100644 index cd31bf73..00000000 --- a/base_user_role/readme/USAGE.rst +++ /dev/null @@ -1,5 +0,0 @@ -To use this module, you need to: - -#. Go to Configuration / Users / Users choose user and set Roles: - -.. image:: /OCA/server-backend/base_user_role/static/description/user_form.png diff --git a/base_user_role/static/description/index.html b/base_user_role/static/description/index.html index da5d8769..05ea8758 100644 --- a/base_user_role/static/description/index.html +++ b/base_user_role/static/description/index.html @@ -369,27 +369,31 @@ ul.auto-toc { !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! !! source digest: sha256:c476130dcc75dc43a4aa9cfcc84eba040aafbdb3b9ff2b672278a59bd46f91ef !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! --> -

Production/Stable License: LGPL-3 OCA/server-backend Translate me on Weblate Try me on Runboat

-

This module was written to extend the standard functionality regarding users -and groups management. -It helps creating well-defined user roles and associating them to users.

-

It can become very hard to maintain a large number of user profiles over time, -juggling with many technical groups. For this purpose, this module will help -you to:

+

Production/Stable License: LGPL-3 OCA/server-backend Translate me on Weblate Try me on Runboat

+

This module was written to extend the standard functionality regarding +users and groups management. It helps creating well-defined user roles +and associating them to users.

+

It can become very hard to maintain a large number of user profiles over +time, juggling with many technical groups. For this purpose, this module +will help you to:

  • define functional roles by aggregating low-level groups,
    • -
  • set user accounts with the predefined roles (roles are cumulative),
    • +
  • set user accounts with the predefined roles (roles are +cumulative),
  • update groups of all relevant user accounts (all at once),
    • -
  • ensure that user accounts will have the groups defined in their roles -(nothing more, nothing less). In other words, you can not set groups -manually on a user as long as there is roles configured on it,
    • -
  • activate/deactivate roles depending on the date (useful to plan holidays, etc)
    • +
  • ensure that user accounts will have the groups defined in their +roles (nothing more, nothing less). In other words, you can not +set groups manually on a user as long as there is roles configured +on it,
    • +
  • activate/deactivate roles depending on the date (useful to plan +holidays, etc)
  • get a quick overview of roles and the related user accounts.
-

That way you make clear the different responsabilities within a company, and -are able to add and update user accounts in a scalable and reliable way.

+

That way you make clear the different responsabilities within a company, +and are able to add and update user accounts in a scalable and reliable +way.

Table of contents

    @@ -411,25 +415,19 @@ are able to add and update user accounts in a scalable and reliable way.

    Configuration

    To configure this module, you need to go to Settings / Users / Roles, -and create a new role. From there, you can add groups to compose your role, -and then associate users to it.

    -

    You can also define default roles for a new user by editing the user called -“Default User”.

    +and create a new role. From there, you can add groups to compose your +role, and then associate users to it.

    +

    You can also define default roles for a new user by editing the user +called “Default User”.

    Roles:

    -
    -https://raw.githubusercontent.com/OCA/server-backend/16.0/base_user_role/static/description/roles.png -
    +

    image1

    Add groups:

    -
    -https://raw.githubusercontent.com/OCA/server-backend/16.0/base_user_role/static/description/role_groups.png -
    +

    image2

    Add users (with dates or not):

    -
    -https://raw.githubusercontent.com/OCA/server-backend/16.0/base_user_role/static/description/role_users.png -
    +

    image3

    Instead of creating roles from scratch, it is possible to create a role -based on the groups of an existing user: select or open the user and choose -“Create role from user” in the action menu.

    +based on the groups of an existing user: select or open the user and +choose “Create role from user” in the action menu.

    Usage

    @@ -437,14 +435,14 @@ based on the groups of an existing user: select or open the user and choose
    1. Go to Configuration / Users / Users choose user and set Roles:
    -https://raw.githubusercontent.com/OCA/server-backend/base_user_role/static/description/user_form.png +

    image

    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.

    @@ -459,8 +457,10 @@ If you spotted it first, help us to smash it by providing a detailed and welcome

    Contributors

    -

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

    +

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

    Other credits

    Images

      -
    • Oxygen Team: Icon (LGPL)
      • +
    • Oxygen Team: +Icon +(LGPL)
    @@ -488,7 +491,7 @@ mission is to support the collaborative development of Odoo features and promote its widespread use.

    Current maintainers:

    sebalix jcdrubay novawish

    -

    This module is part of the OCA/server-backend project on GitHub.

    +

    This module is part of the OCA/server-backend project on GitHub.

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