diff --git a/fleet_vehicle_ownership/README.rst b/fleet_vehicle_ownership/README.rst index f81e5929..a1047ace 100644 --- a/fleet_vehicle_ownership/README.rst +++ b/fleet_vehicle_ownership/README.rst @@ -28,10 +28,9 @@ Fleet Vehicle Ownership |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 ... +This module extends the functionality of fleet to support vehicle owner +data and to allow you to add vehicle ownership, linking partners to +vehicles **Table of contents** diff --git a/fleet_vehicle_ownership/readme/CONFIGURE.md b/fleet_vehicle_ownership/readme/CONFIGURE.md deleted file mode 100644 index 703e8dea..00000000 --- a/fleet_vehicle_ownership/readme/CONFIGURE.md +++ /dev/null @@ -1,8 +0,0 @@ -[ 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) diff --git a/fleet_vehicle_ownership/readme/CONTEXT.md b/fleet_vehicle_ownership/readme/CONTEXT.md index 66aa44f0..f0fb63ec 100644 --- a/fleet_vehicle_ownership/readme/CONTEXT.md +++ b/fleet_vehicle_ownership/readme/CONTEXT.md @@ -1,14 +1,9 @@ -[ This file is optional but strongly suggested to allow end-users to evaluate the -module's usefulness in their context. ] +This is an extension of the 'fleet.vehicle' model in the Odoo framework. +It introduces a new field, 'owner_id', to track and associate the owner of a vehicle. -It should explain the “why” of the module: +Fields: +- owner_id: Many2one field linking to the 'res.partner' model. It represents the owner of the vehicle. -- 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) +Usage: +- This extension is particularly useful in scenarios where it's essential to associate each fleet vehicle with a specific owner. +- The 'owner_id' field can be utilized to establish relationships with partners in the 'res.partner' model, facilitating clear ownership tracking. diff --git a/fleet_vehicle_ownership/readme/CONTRIBUTORS.md b/fleet_vehicle_ownership/readme/CONTRIBUTORS.md index 7be72fb9..e3fe9dd4 100644 --- a/fleet_vehicle_ownership/readme/CONTRIBUTORS.md +++ b/fleet_vehicle_ownership/readme/CONTRIBUTORS.md @@ -1,2 +1 @@ -- Firstname Lastname (optional company website url) -- Second Person (optional company website url) +- Raimundo Junior diff --git a/fleet_vehicle_ownership/readme/CREDITS.md b/fleet_vehicle_ownership/readme/CREDITS.md deleted file mode 100644 index c951ebab..00000000 --- a/fleet_vehicle_ownership/readme/CREDITS.md +++ /dev/null @@ -1,7 +0,0 @@ -[ 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 diff --git a/fleet_vehicle_ownership/readme/DESCRIPTION.md b/fleet_vehicle_ownership/readme/DESCRIPTION.md index 7504c6ab..8bfb0f1c 100644 --- a/fleet_vehicle_ownership/readme/DESCRIPTION.md +++ b/fleet_vehicle_ownership/readme/DESCRIPTION.md @@ -1,3 +1 @@ -[ 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 module extends the functionality of fleet to support vehicle owner data and to allow you to add vehicle ownership, linking partners to vehicles diff --git a/fleet_vehicle_ownership/readme/HISTORY.md b/fleet_vehicle_ownership/readme/HISTORY.md deleted file mode 100644 index 9894c783..00000000 --- a/fleet_vehicle_ownership/readme/HISTORY.md +++ /dev/null @@ -1,17 +0,0 @@ -[ 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) - -- ... diff --git a/fleet_vehicle_ownership/readme/INSTALL.md b/fleet_vehicle_ownership/readme/INSTALL.md deleted file mode 100644 index 29f7d0ec..00000000 --- a/fleet_vehicle_ownership/readme/INSTALL.md +++ /dev/null @@ -1,6 +0,0 @@ -[ 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 ... diff --git a/fleet_vehicle_ownership/readme/ROADMAP.md b/fleet_vehicle_ownership/readme/ROADMAP.md deleted file mode 100644 index febf7687..00000000 --- a/fleet_vehicle_ownership/readme/ROADMAP.md +++ /dev/null @@ -1,5 +0,0 @@ -[ 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. ] - -- ... diff --git a/fleet_vehicle_ownership/readme/USAGE.md b/fleet_vehicle_ownership/readme/USAGE.md index b8ff7853..d0e67afd 100644 --- a/fleet_vehicle_ownership/readme/USAGE.md +++ b/fleet_vehicle_ownership/readme/USAGE.md @@ -1,9 +1,3 @@ -[ This file must be present and contains the usage instructions for end-users. As all -other rst files included in the README, it MUST NOT contain reStructuredText sections -only body text (paragraphs, lists, tables, etc). Should you need a more elaborate -structure to explain the addon, please create a Sphinx documentation (which may include -this file as a "quick start" section). ] - To use this module, you need to: -1. Go to ... +1. Go to the veichle form and associate an owner or go to the partner form and associate a vehicle.