-
Notifications
You must be signed in to change notification settings - Fork 5
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
wms_connector_picking_batch: Adds README.rst
- Loading branch information
1 parent
71fd961
commit 823366b
Showing
10 changed files
with
241 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,178 @@ | ||
============= | ||
Wms Connector | ||
============= | ||
|
||
.. | ||
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! | ||
!! This file is generated by oca-gen-addon-readme !! | ||
!! changes will be overwritten. !! | ||
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! | ||
!! source digest: sha256:44a9f6e07491ade0e00cbf23e00b4a4dc58cb5fcb6e0f296aa5552fd8439398b | ||
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! | ||
.. |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/licence-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-OCA%2Fwms-lightgray.png?logo=github | ||
:target: https://github.com/OCA/wms/tree/14.0/wms_connector_picking_batch | ||
:alt: OCA/wms | ||
.. |badge4| image:: https://img.shields.io/badge/weblate-Translate%20me-F47D42.png | ||
:target: https://translation.odoo-community.org/projects/wms-14-0/wms-14-0-wms_connector_picking_batch | ||
: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/wms&target_branch=14.0 | ||
:alt: Try me on Runboat | ||
|
||
|badge1| |badge2| |badge3| |badge4| |badge5| | ||
|
||
[ This file must be max 2-3 paragraphs, and is required. ] | ||
|
||
This module extends the functionality of ... to support ... and to allow | ||
you 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. ] | ||
|
||
It should explain the “why” of the module: | ||
|
||
- in which context or use cases this module can be useful (practical | ||
examples are welcome!). | ||
- what is the business requirement that generated the need to develop | ||
this module | ||
|
||
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) | ||
|
||
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. ] | ||
|
||
To install this module, you need to: | ||
|
||
1. Do this ... | ||
|
||
Configuration | ||
============= | ||
|
||
[ This file is optional, it should explain how to configure the module | ||
before using it; it is aimed at advanced users. ] | ||
|
||
To configure this module, you need to: | ||
|
||
- Go to ... | ||
|
||
|alternative description|../static/description/image.png) | ||
|
||
https://raw.githubusercontent.com/OCA/wms/14.0/wms_connector_picking_batch/.https://raw.githubusercontent.com/OCA/wms/14.0/wms_connector_picking_batch/.https://raw.githubusercontent.com/OCA/wms/14.0/wms_connector_picking_batch/ https://raw.githubusercontent.com/OCA/wms/14.0/wms_connector_picking_batch/|https://raw.githubusercontent.com/OCA/wms/14.0/wms_connector_picking_batch/ahttps://raw.githubusercontent.com/OCA/wms/14.0/wms_connector_picking_batch/lhttps://raw.githubusercontent.com/OCA/wms/14.0/wms_connector_picking_batch/thttps://raw.githubusercontent.com/OCA/wms/14.0/wms_connector_picking_batch/ehttps://raw.githubusercontent.com/OCA/wms/14.0/wms_connector_picking_batch/rhttps://raw.githubusercontent.com/OCA/wms/14.0/wms_connector_picking_batch/nhttps://raw.githubusercontent.com/OCA/wms/14.0/wms_connector_picking_batch/ahttps://raw.githubusercontent.com/OCA/wms/14.0/wms_connector_picking_batch/thttps://raw.githubusercontent.com/OCA/wms/14.0/wms_connector_picking_batch/ihttps://raw.githubusercontent.com/OCA/wms/14.0/wms_connector_picking_batch/vhttps://raw.githubusercontent.com/OCA/wms/14.0/wms_connector_picking_batch/ehttps://raw.githubusercontent.com/OCA/wms/14.0/wms_connector_picking_batch/ https://raw.githubusercontent.com/OCA/wms/14.0/wms_connector_picking_batch/dhttps://raw.githubusercontent.com/OCA/wms/14.0/wms_connector_picking_batch/ehttps://raw.githubusercontent.com/OCA/wms/14.0/wms_connector_picking_batch/shttps://raw.githubusercontent.com/OCA/wms/14.0/wms_connector_picking_batch/chttps://raw.githubusercontent.com/OCA/wms/14.0/wms_connector_picking_batch/rhttps://raw.githubusercontent.com/OCA/wms/14.0/wms_connector_picking_batch/ihttps://raw.githubusercontent.com/OCA/wms/14.0/wms_connector_picking_batch/phttps://raw.githubusercontent.com/OCA/wms/14.0/wms_connector_picking_batch/thttps://raw.githubusercontent.com/OCA/wms/14.0/wms_connector_picking_batch/ihttps://raw.githubusercontent.com/OCA/wms/14.0/wms_connector_picking_batch/ohttps://raw.githubusercontent.com/OCA/wms/14.0/wms_connector_picking_batch/nhttps://raw.githubusercontent.com/OCA/wms/14.0/wms_connector_picking_batch/|https://raw.githubusercontent.com/OCA/wms/14.0/wms_connector_picking_batch/ https://raw.githubusercontent.com/OCA/wms/14.0/wms_connector_picking_batch/ihttps://raw.githubusercontent.com/OCA/wms/14.0/wms_connector_picking_batch/mhttps://raw.githubusercontent.com/OCA/wms/14.0/wms_connector_picking_batch/ahttps://raw.githubusercontent.com/OCA/wms/14.0/wms_connector_picking_batch/ghttps://raw.githubusercontent.com/OCA/wms/14.0/wms_connector_picking_batch/ehttps://raw.githubusercontent.com/OCA/wms/14.0/wms_connector_picking_batch/:https://raw.githubusercontent.com/OCA/wms/14.0/wms_connector_picking_batch/:https://raw.githubusercontent.com/OCA/wms/14.0/wms_connector_picking_batch/ https://raw.githubusercontent.com/OCA/wms/14.0/wms_connector_picking_batch/ | ||
https://raw.githubusercontent.com/OCA/wms/14.0/wms_connector_picking_batch/ | ||
|
||
Usage | ||
===== | ||
|
||
1. Tick the boolean active_wms_sync | ||
2. On the generated task, select the storage backend that you want to | ||
use | ||
|
||
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 <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) | ||
----------------------- | ||
|
||
- ... | ||
|
||
Bug Tracker | ||
=========== | ||
|
||
Bugs are tracked on `GitHub Issues <https://github.com/OCA/wms/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/wms/issues/new?body=module:%20wms_connector_picking_batch%0Aversion:%2014.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. | ||
|
||
Credits | ||
======= | ||
|
||
Authors | ||
------- | ||
|
||
* Akretion | ||
|
||
Contributors | ||
------------ | ||
|
||
- François Poizat [email protected] | ||
|
||
Other credits | ||
------------- | ||
|
||
[ 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 | ||
|
||
Maintainers | ||
----------- | ||
|
||
This module is maintained by the OCA. | ||
|
||
.. image:: https://odoo-community.org/logo.png | ||
:alt: Odoo Community Association | ||
:target: https://odoo-community.org | ||
|
||
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/wms <https://github.com/OCA/wms/tree/14.0/wms_connector_picking_batch>`_ project on GitHub. | ||
|
||
You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,8 @@ | ||
[ This file is optional, it should explain how to configure the module before using it; | ||
it is aimed at advanced users. ] | ||
|
||
To configure this module, you need to: | ||
|
||
- Go to ... | ||
|
||
![alternative description]()../static/description/image.png) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,14 @@ | ||
[ This file is optional but strongly suggested to allow end-users to evaluate the | ||
module's usefulness in their context. ] | ||
|
||
It should explain the “why” of the module: | ||
|
||
- in which context or use cases this module can be useful (practical examples are | ||
welcome!). | ||
- what is the business requirement that generated the need to develop this module | ||
|
||
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) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
- François Poizat <[email protected]> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
[ 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 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,3 @@ | ||
[ This file must be max 2-3 paragraphs, and is required. ] | ||
|
||
This module extends the functionality of ... to support ... and to allow you to ... |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,17 @@ | ||
[ 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) | ||
|
||
- ... |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,6 @@ | ||
[ 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 ... |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,5 @@ | ||
[ 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. ] | ||
|
||
- ... |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,2 @@ | ||
1. Tick the boolean active_wms_sync | ||
2. On the generated task, select the storage backend that you want to use |