Skip to content

Commit

Permalink
add README.rst
Browse files Browse the repository at this point in the history
  • Loading branch information
jdidderen committed Oct 1, 2024
1 parent 11c2802 commit 22c6bab
Show file tree
Hide file tree
Showing 7 changed files with 467 additions and 33 deletions.
52 changes: 19 additions & 33 deletions operating_unit_selector_widget/README.rst
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
==============
Operating Unit
==============
================================
Operating Unit - Selector Widget
================================

..
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
Expand All @@ -17,46 +17,37 @@ Operating Unit
:target: http://www.gnu.org/licenses/lgpl-3.0-standalone.html
:alt: License: LGPL-3
.. |badge3| image:: https://img.shields.io/badge/github-OCA%2Foperating--unit-lightgray.png?logo=github
:target: https://github.com/OCA/operating-unit/tree/17.0/operating_unit
:target: https://github.com/OCA/operating-unit/tree/17.0/operating_unit_selector_widget
:alt: OCA/operating-unit
.. |badge4| image:: https://img.shields.io/badge/weblate-Translate%20me-F47D42.png
:target: https://translation.odoo-community.org/projects/operating-unit-17-0/operating-unit-17-0-operating_unit
:target: https://translation.odoo-community.org/projects/operating-unit-17-0/operating-unit-17-0-operating_unit_selector_widget
: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/operating-unit&target_branch=17.0
:alt: Try me on Runboat

|badge1| |badge2| |badge3| |badge4| |badge5|

An operating unit (OU) is an organizational entity part of a company,
with separate management ownership. Management by OU is aimed to
introduce the following features:
Add the same widget as the multi-company in order to only view the
wanted operating units.

- Data partitioning from other OU.
- Own sequencing schemes.
- User access administration for data processing and reporting.
- Product and customer independence of OU.
- OU specific P&L and Balance sheet.
|image|

.. |image| image:: https://raw.githubusercontent.com/OCA/operating-unit/17.0/operating_unit_selector_widget/static/description/widget.png

**Table of contents**

.. contents::
:local:

Configuration
=============

To configure this module, you need to:

- Assign *Multi Operating Unit* group to user.
- Go to *Settings / Users & Companies / Operating Units* and create
Operating Units.

Usage
=====

This module defines the operating unit entity and the user's security
rules. Other modules extend the standard Odoo apps with the OU.
Install the module and be sure to have an user with one of the following
security groups :

- Multiple Operating Unit
- Manager of Operating Units

Known issues / Roadmap
======================
Expand All @@ -69,7 +60,7 @@ Bug Tracker
Bugs are tracked on `GitHub Issues <https://github.com/OCA/operating-unit/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 <https://github.com/OCA/operating-unit/issues/new?body=module:%20operating_unit%0Aversion:%2017.0%0A%0A**Steps%20to%20reproduce**%0A-%20...%0A%0A**Current%20behavior**%0A%0A**Expected%20behavior**>`_.
`feedback <https://github.com/OCA/operating-unit/issues/new?body=module:%20operating_unit_selector_widget%0Aversion:%2017.0%0A%0A**Steps%20to%20reproduce**%0A-%20...%0A%0A**Current%20behavior**%0A%0A**Expected%20behavior**>`_.

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

Expand All @@ -79,17 +70,12 @@ Credits
Authors
-------

* ForgeFlow
* Serpent Consulting Services Pvt. Ltd.
* Jérémy Didderen

Contributors
------------

- ForgeFlow <[email protected]>
- Serpent Consulting Services Pvt. Ltd. <[email protected]>
- Jarsa Sistemas <[email protected]>
- Andrea Stirpe <[email protected]>
- Ooops, Ashish Hirpara <[email protected]>
- Jérémy Didderen

Maintainers
-----------
Expand All @@ -104,6 +90,6 @@ 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.

This module is part of the `OCA/operating-unit <https://github.com/OCA/operating-unit/tree/17.0/operating_unit>`_ project on GitHub.
This module is part of the `OCA/operating-unit <https://github.com/OCA/operating-unit/tree/17.0/operating_unit_selector_widget>`_ project on GitHub.

You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute.
1 change: 1 addition & 0 deletions operating_unit_selector_widget/readme/CONTRIBUTORS.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
- Jérémy Didderen
3 changes: 3 additions & 0 deletions operating_unit_selector_widget/readme/DESCRIPTION.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
Add the same widget as the multi-company in order to only view the wanted operating units.

![image](../static/description/widget.png)
1 change: 1 addition & 0 deletions operating_unit_selector_widget/readme/ROADMAP.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@

4 changes: 4 additions & 0 deletions operating_unit_selector_widget/readme/USAGE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
Install the module and be sure to have an user with one of the following security groups :

- Multiple Operating Unit
- Manager of Operating Units
Loading

0 comments on commit 22c6bab

Please sign in to comment.