-
-
Notifications
You must be signed in to change notification settings - Fork 161
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
519e6e7
commit dbcbdd5
Showing
15 changed files
with
1,115 additions
and
59 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
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 |
|---|---|---|
| @@ -1,35 +1,117 @@ | ||
| **This file is going to be generated by oca-gen-addon-readme.** | ||
| =================== | ||
| Fs Base Multi Media | ||
| =================== | ||
|
|
||
| *Manual changes will be overwritten.* | ||
| .. | ||
| !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! | ||
| !! This file is generated by oca-gen-addon-readme !! | ||
| !! changes will be overwritten. !! | ||
| !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! | ||
| !! source digest: sha256:854289aaf0e0ead7af13579fc0fb6eda2958f5386b77f5fbe056915dcc514666 | ||
| !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! | ||
| Please provide content in the ``readme`` directory: | ||
| .. |badge1| image:: https://img.shields.io/badge/maturity-Alpha-red.png | ||
| :target: https://odoo-community.org/page/development-status | ||
| :alt: Alpha | ||
| .. |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%2Fstorage-lightgray.png?logo=github | ||
| :target: https://github.com/OCA/storage/tree/16.0/fs_base_multi_media | ||
| :alt: OCA/storage | ||
| .. |badge4| image:: https://img.shields.io/badge/weblate-Translate%20me-F47D42.png | ||
| :target: https://translation.odoo-community.org/projects/storage-16-0/storage-16-0-fs_base_multi_media | ||
| :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/storage&target_branch=16.0 | ||
| :alt: Try me on Runboat | ||
|
|
||
| * **DESCRIPTION.rst** (required) | ||
| * INSTALL.rst (optional) | ||
| * CONFIGURE.rst (optional) | ||
| * **USAGE.rst** (optional, highly recommended) | ||
| * DEVELOP.rst (optional) | ||
| * ROADMAP.rst (optional) | ||
| * HISTORY.rst (optional, recommended) | ||
| * **CONTRIBUTORS.rst** (optional, highly recommended) | ||
| * CREDITS.rst (optional) | ||
| |badge1| |badge2| |badge3| |badge4| |badge5| | ||
|
|
||
| Content of this README will also be drawn from the addon manifest, | ||
| from keys such as name, authors, maintainers, development_status, | ||
| and license. | ||
| This addon allows you to store media file into external filesystem from odoo. | ||
| It also provides is a technical mixin model to ease the creation of other models | ||
| that need to be linked to multiple medias stored into external filesystems. | ||
|
|
||
| A good, one sentence summary in the manifest is also highly recommended. | ||
| The models provided by this addon are: | ||
|
|
||
| * ``fs.media``: a model that stores a reference to an media stored into | ||
| an external filesystem. | ||
| * ``fs.media.relation.mixin``: an abstract model that can be used to | ||
| as base class for models created to store an media linked to a model. | ||
| This abstract model defines fields and methods to transparently handle | ||
| 2 cases: | ||
| * the media is specific to the model. | ||
| * the media is shared between multiple models and therefore is a ``fs.media`` instance linked to the mixin. | ||
|
|
||
| Automatic changelog generation | ||
| ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | ||
| .. IMPORTANT:: | ||
| This is an alpha version, the data model and design can change at any time without warning. | ||
| Only for development or testing purpose, do not use in production. | ||
| `More details on development status <https://odoo-community.org/page/development-status>`_ | ||
|
|
||
| `HISTORY.rst` can be auto generated using `towncrier <https://pypi.org/project/towncrier>`_. | ||
| **Table of contents** | ||
|
|
||
| Just put towncrier compatible changelog fragments into `readme/newsfragments` | ||
| and the changelog file will be automatically generated and updated when a new fragment is added. | ||
| .. contents:: | ||
| :local: | ||
|
|
||
| Please refer to `towncrier` documentation to know more. | ||
| Usage | ||
| ===== | ||
|
|
||
| NOTE: the changelog will be automatically generated when using `/ocabot merge $option`. | ||
| If you need to run it manually, refer to `OCA/maintainer-tools README <https://github.com/OCA/maintainer-tools>`_. | ||
| To be able to create and or manages shared images, you must have the ``Media Manager`` | ||
| role. If you do not have this role, as an authenticated user, you can | ||
| only view the shared images. | ||
|
|
||
| Known issues / Roadmap | ||
| ====================== | ||
|
|
||
| * Add dedicated widget to ease the addition of new media to a model linked to | ||
| multiple medias. (As it's the case in the *storage_image_product* addon) | ||
|
|
||
| Bug Tracker | ||
| =========== | ||
|
|
||
| Bugs are tracked on `GitHub Issues <https://github.com/OCA/storage/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/storage/issues/new?body=module:%20fs_base_multi_media%0Aversion:%2016.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 | ||
| ~~~~~~~ | ||
|
|
||
| * ACSONE SA/NV | ||
| * Akretion | ||
|
|
||
| Contributors | ||
| ~~~~~~~~~~~~ | ||
|
|
||
| * Sebastien Beau <sebastien.beau@akretion.com> | ||
| * Laurent Mignon <laurent.mignon@acsone.eu> (https://www.acsone.eu/) | ||
|
|
||
| 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. | ||
|
|
||
| .. |maintainer-lmignon| image:: https://github.com/lmignon.png?size=40px | ||
| :target: https://github.com/lmignon | ||
| :alt: lmignon | ||
|
|
||
| Current `maintainer <https://odoo-community.org/page/maintainer-role>`__: | ||
|
|
||
| |maintainer-lmignon| | ||
|
|
||
| This module is part of the `OCA/storage <https://github.com/OCA/storage/tree/16.0/fs_base_multi_media>`_ 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
Oops, something went wrong.