[IMP] pms: adapt readme and manifest to OCA Guidelines

This commit is contained in:
Sara Lago
2021-05-25 12:25:47 +02:00
parent 368a2e6948
commit 884c684f21
8 changed files with 47 additions and 38 deletions

View File

@@ -25,11 +25,11 @@ PMS (Property Management System)
|badge1| |badge2| |badge3| |badge4| |badge5|
This module is an all-in-one property management system (PMS) focused on medium-sized hotels
This module is an all-in-one property management system (PMS) focused on medium-sized properties
for managing every aspect of your property's daily operations.
You can manage hotel properties with multi-hotel and multi-company support, including your rooms inventory,
reservations, check-in, daily reports, board services, rate and availability plans among other hotel functionalities.
You can manage properties with multi-property and multi-company support, including your rooms inventory,
reservations, check-in, daily reports, board services, rate and availability plans among other property functionalities.
.. IMPORTANT::
This is an alpha version, the data model and design can change at any time without warning.
@@ -44,20 +44,20 @@ reservations, check-in, daily reports, board services, rate and availability pla
Installation
============
This module depends on modules ``base``, ``sale_stock``, ``account_payment_return``, ``partner_firstname``,
and ``account_cancel``. Ensure yourself to have all them in your addons list.
This module depends on modules ``base``, ``mail``, ``sale`` and ``multi_pms_properties``.
Ensure yourself to have all them in your addons list.
Configuration
=============
You will find the hotel settings in Settings > Users & Companies > Hotels > Your Hotel.
You will find the hotel settings in PMS Management > Configuration > Properties > Your Property.
This module required additional configuration for company, accounting, invoicing and user privileges.
Usage
=====
To use this module, please, read the complete user guide at https://roomdoo.com.
To use this module, please, read the complete user guide at `<roomdoo.com>`_.
Bug Tracker
===========
@@ -75,18 +75,21 @@ Credits
Authors
~~~~~~~
* Dario Lodeiros
* Alexadre Diaz
* Pablo Quesada
* Jose Luis Algara
* Commit [Sun]
Contributors
~~~~~~~~~~~~
* Dario Lodeiros <dario@commitsun.com>
* Alexandre Díaz
* Pablo Quesada
* Jose Luis Algara
* `Commit [Sun] <https://www.commitsun.com>`:
* Dario Lodeiros
* Eric Antones
* Sara Lago
* Brais Abeijon
* Miguel Padin
Maintainers
~~~~~~~~~~~

View File

@@ -8,11 +8,7 @@
"development_status": "Alpha",
"category": "Generic Modules/Property Management System",
"website": "https://github.com/OCA/pms",
"author": "Dario Lodeiros, "
"Alexadre Diaz, "
"Pablo Quesada, "
"Jose Luis Algara, "
"Odoo Community Association (OCA)",
"author": "Commit [Sun], Odoo Community Association (OCA)",
"license": "AGPL-3",
"application": True,
"installable": True,

View File

@@ -1,3 +1,3 @@
You will find the hotel settings in Settings > Users & Companies > Hotels > Your Hotel.
You will find the hotel settings in PMS Management > Configuration > Properties > Your Property.
This module required additional configuration for company, accounting, invoicing and user privileges.

View File

@@ -1,4 +1,10 @@
* Dario Lodeiros <dario@commitsun.com>
* Alexandre Díaz
* Pablo Quesada
* Jose Luis Algara
* `Commit [Sun] <https://www.commitsun.com>`:
* Dario Lodeiros
* Eric Antones
* Sara Lago
* Brais Abeijon
* Miguel Padin

View File

@@ -1,5 +1,5 @@
This module is an all-in-one property management system (PMS) focused on medium-sized hotels
This module is an all-in-one property management system (PMS) focused on medium-sized properties
for managing every aspect of your property's daily operations.
You can manage hotel properties with multi-hotel and multi-company support, including your rooms inventory,
reservations, check-in, daily reports, board services, rate and availability plans among other hotel functionalities.
You can manage properties with multi-property and multi-company support, including your rooms inventory,
reservations, check-in, daily reports, board services, rate and availability plans among other property functionalities.

View File

@@ -1,2 +1,2 @@
This module depends on modules ``base``, ``sale_stock``, ``account_payment_return``, ``partner_firstname``,
and ``account_cancel``. Ensure yourself to have all them in your addons list.
This module depends on modules ``base``, ``mail``, ``sale`` and ``multi_pms_properties``.
Ensure yourself to have all them in your addons list.

View File

@@ -1 +1 @@
To use this module, please, read the complete user guide at https://roomdoo.com.
To use this module, please, read the complete user guide at `<roomdoo.com>`_.

View File

@@ -3,7 +3,7 @@
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta name="generator" content="Docutils 0.15.1: http://docutils.sourceforge.net/" />
<meta name="generator" content="Docutils: http://docutils.sourceforge.net/" />
<title>PMS (Property Management System)</title>
<style type="text/css">
@@ -368,10 +368,10 @@ ul.auto-toc {
!! changes will be overwritten. !!
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! -->
<p><a class="reference external" href="https://odoo-community.org/page/development-status"><img alt="Alpha" src="https://img.shields.io/badge/maturity-Alpha-red.png" /></a> <a class="reference external" href="http://www.gnu.org/licenses/agpl-3.0-standalone.html"><img alt="License: AGPL-3" src="https://img.shields.io/badge/licence-AGPL--3-blue.png" /></a> <a class="reference external" href="https://github.com/OCA/pms/tree/14.0/pms"><img alt="OCA/pms" src="https://img.shields.io/badge/github-OCA%2Fpms-lightgray.png?logo=github" /></a> <a class="reference external" href="https://translation.odoo-community.org/projects/pms-14-0/pms-14-0-pms"><img alt="Translate me on Weblate" src="https://img.shields.io/badge/weblate-Translate%20me-F47D42.png" /></a> <a class="reference external" href="https://runbot.odoo-community.org/runbot/293/14.0"><img alt="Try me on Runbot" src="https://img.shields.io/badge/runbot-Try%20me-875A7B.png" /></a></p>
<p>This module is an all-in-one property management system (PMS) focused on medium-sized hotels
<p>This module is an all-in-one property management system (PMS) focused on medium-sized properties
for managing every aspect of your propertys daily operations.</p>
<p>You can manage hotel properties with multi-hotel and multi-company support, including your rooms inventory,
reservations, check-in, daily reports, board services, rate and availability plans among other hotel functionalities.</p>
<p>You can manage properties with multi-property and multi-company support, including your rooms inventory,
reservations, check-in, daily reports, board services, rate and availability plans among other property functionalities.</p>
<div class="admonition important">
<p class="first admonition-title">Important</p>
<p class="last">This is an alpha version, the data model and design can change at any time without warning.
@@ -395,17 +395,17 @@ Only for development or testing purpose, do not use in production.
</div>
<div class="section" id="installation">
<h1><a class="toc-backref" href="#id1">Installation</a></h1>
<p>This module depends on modules <tt class="docutils literal">base</tt>, <tt class="docutils literal">sale_stock</tt>, <tt class="docutils literal">account_payment_return</tt>, <tt class="docutils literal">partner_firstname</tt>,
and <tt class="docutils literal">account_cancel</tt>. Ensure yourself to have all them in your addons list.</p>
<p>This module depends on modules <tt class="docutils literal">base</tt>, <tt class="docutils literal">mail</tt>, <tt class="docutils literal">sale</tt> and <tt class="docutils literal">multi_pms_properties</tt>.
Ensure yourself to have all them in your addons list.</p>
</div>
<div class="section" id="configuration">
<h1><a class="toc-backref" href="#id2">Configuration</a></h1>
<p>You will find the hotel settings in Settings &gt; Users &amp; Companies &gt; Hotels &gt; Your Hotel.</p>
<p>You will find the hotel settings in PMS Management &gt; Configuration &gt; Properties &gt; Your Property.</p>
<p>This module required additional configuration for company, accounting, invoicing and user privileges.</p>
</div>
<div class="section" id="usage">
<h1><a class="toc-backref" href="#id3">Usage</a></h1>
<p>To use this module, please, read the complete user guide at <a class="reference external" href="https://roomdoo.com">https://roomdoo.com</a>.</p>
<p>To use this module, please, read the complete user guide at <a class="reference external" href="roomdoo.com">roomdoo.com</a>.</p>
</div>
<div class="section" id="bug-tracker">
<h1><a class="toc-backref" href="#id4">Bug Tracker</a></h1>
@@ -420,19 +420,23 @@ If you spotted it first, help us smashing it by providing a detailed and welcome
<div class="section" id="authors">
<h2><a class="toc-backref" href="#id6">Authors</a></h2>
<ul class="simple">
<li>Dario Lodeiros</li>
<li>Alexadre Diaz</li>
<li>Pablo Quesada</li>
<li>Jose Luis Algara</li>
<li>Commit [Sun]</li>
</ul>
</div>
<div class="section" id="contributors">
<h2><a class="toc-backref" href="#id7">Contributors</a></h2>
<ul class="simple">
<li>Dario Lodeiros &lt;<a class="reference external" href="mailto:dario&#64;commitsun.com">dario&#64;commitsun.com</a>&gt;</li>
<li>Alexandre Díaz</li>
<li>Pablo Quesada</li>
<li>Jose Luis Algara</li>
<li><cite>Commit [Sun] &lt;https://www.commitsun.com&gt;</cite>:<ul>
<li>Dario Lodeiros</li>
<li>Eric Antones</li>
<li>Sara Lago</li>
<li>Brais Abeijon</li>
<li>Miguel Padin</li>
</ul>
</li>
</ul>
</div>
<div class="section" id="maintainers">