Message Threads | The Odoo Community Association

Re: OCA pip module loaded by external organization on pypi.org

Hi,

I suppose the https://pypi.org/user/ssi-bot/ user own the pypi project before OCA bot try to create it so it's certainly a best practice to first get OCA package from the OCA wheelhouse https://wheelhouse.odoo-community.org/

regards,

Le ven. 24 janv. 2025 à 17:38, Sergio Corato <notifications@odoo-community.org> a écrit :

Hi all,
I am writing this mail even if I've already written it in OCA Discord, because I think this is a security issue, I apologize whether it's not.

I found installed in an instance a pip from pypi.org of an OCA module upgraded there from a company outside OCA: https://pypi.org/project/odoo14-addon-stock-move-backdating/14.0.1.2.0/

They pushed the module changed and with a different logo (almost this change made me notice it) and a link to their website. It's a bad thing that someone can put a pip there with a random code.

I'll stop taking this pip from pypi.org or I'll take the OCA version, but what about other instances installed in this way? Or is it a deprecated way of deployment?

In tests done on github is used the "non-OCA" version too:

Requirement already satisfied: odoo14-addon-stock-move-backdating in /opt/odoo-venv/src/odoo14-addon-stock-move-backdating/setup/stock_move_backdating (from -r test-requirements.txt (line 6)) (14.0.1.0.2.dev2)

while the current OCA version is "version": "14.0.1.0.1",

Sergio Corato

_______________________________________________
Mailing-List: https://odoo-community.org/groups/contributors-15
Post to: mailto:contributors@odoo-community.org
Unsubscribe: https://odoo-community.org/groups?unsubscribe

--

Pierre

by Pierre Verkest - 06:36 - 24 Jan 2025

OCA pip module loaded by external organization on pypi.org

Hi all,

I am writing this mail even if I've already written it in OCA Discord, because I think this is a security issue, I apologize whether it's not.

I found installed in an instance a pip from pypi.org of an OCA module upgraded there from a company outside OCA: https://pypi.org/project/odoo14-addon-stock-move-backdating/14.0.1.2.0/

They pushed the module changed and with a different logo (almost this change made me notice it) and a link to their website. It's a bad thing that someone can put a pip there with a random code.

I'll stop taking this pip from pypi.org or I'll take the OCA version, but what about other instances installed in this way? Or is it a deprecated way of deployment?

In tests done on github is used the "non-OCA" version too:

Requirement already satisfied: odoo14-addon-stock-move-backdating in /opt/odoo-venv/src/odoo14-addon-stock-move-backdating/setup/stock_move_backdating (from -r test-requirements.txt (line 6)) (14.0.1.0.2.dev2)

while the current OCA version is "version": "14.0.1.0.1",

Sergio Corato

by Sergio Corato - 05:36 - 24 Jan 2025

Request for Guidance on Migrating from POS UI API v15 to v16

I am currently working on migrating a community addon from Odoo v15 to v16 and have encountered a challenge related to the updated POS API.

In v15, the addon interacts with the POS UI and defines custom models using Backbone.Model.extend, as shown here:

var MyCustomModel = Backbone.Model.extend({
    // Custom model logic
});

The goal is to create a new model at the same logic level as Order and Orderline, not to extend those models. While there are plenty of examples showing how to extend Order and Orderline, I have not found clear guidance on defining entirely new models at this level under the v16 API.

In addition, models like Order and Orderline in v15 extended PosModel, which was accessible. However, in v16, PosModel has been made private, and PosGlobalState doesn’t seem to provide the functionality needed for this type of model creation.

Could anyone provide guidance on:

How to create a new model at the same logic level as Order and Orderline in the v16 POS API?
Why was PosModel made private in v16, and is there an alternative for extending POS-related functionality?
Are there updated patterns or best practices in v16 for integrating custom models into the POS framework?

I want to ensure that this approach aligns with the design philosophy of the v16 API and avoids anti-patterns. Your advice, examples, or references to relevant documentation would be greatly appreciated.

Thank you for your help!

Best regards,

\Rolando

by Ing. Rolando Pérez Rebollo - 10:51 - 23 Jan 2025

Solicitud para colaborar con Odoo

Estimado equipo de Odoo,

Quiero expresar mi interés en colaborar con ustedes y contribuir al desarrollo de su plataforma. Quedo a disposición para conversar sobre cómo puedo aportar al equipo.

Saludos cordiales

by Ing. Yudith Recio Milanés - 01:10 - 23 Jan 2025

Re: BPM On Odoo

Hello Graeme,

We've already made significant progress, which you might want to explore to understand how we're managing everything within our BPM using Odoo

Regards,

Manish Mannan

From: Graeme Gellatly <notifications@odoo-community.org>
Date: Wednesday, 22 January 2025 at 3:52 AM
To: Contributors <contributors@odoo-community.org>
Subject: Re: BPM On Odoo

This seems a variation that comes up every year or so. This should be your starting point, and probably ending point IMO. https://docs.google.com/presentation/d/e/2PACX-1vR9VGsSQUnITdnQq5KRiWnY7o-yERCB8YfnqxzhFW5tFcJ8AzMmIQ1CpLTdEgy5Sz9nx-yQlC0BhyGR/pub?start=false&loop=false&delayms=3000&slide=id.p

On Wed, Jan 22, 2025 at 10:07 AM Michel Stroom <notifications@odoo-community.org> wrote:

Great progress, Manish!

You already have my full support and my contact details.

As we’ve discussed, focus on specific industries where workflows play a crucial role.
Keep in mind that workflow solutions are typically more suited to larger enterprises rather than smaller ones.

I’m looking forward to collaborating with you and seeing how we, as the OCA, can contribute to creating the BPM.
Stay in touch, and please keep us — and me — updated.

Warmest regards,

Michel Stroom

--

Office Everywhere
Business Partner Odoo

t: +31 6 53360677
e: mstroom@office-everywhere.com
w: Office-Everywhere.com

LinkedIn profile: https://linkedin.com/in/stroom

On 21 Jan 2025, at 18:03, Manish Mannan (Manish) <notifications@odoo-community.org> wrote:

Hello Community,

We are in the process of developing a BPM solution on top of Odoo. Your suggestions and input would be greatly appreciated.

Looking forward to hearing your ideas!

Regards,

Manish Mannan

_______________________________________________
Mailing-List: https://odoo-community.org/groups/contributors-15
Post to: mailto:contributors@odoo-community.org
Unsubscribe: https://odoo-community.org/groups?unsubscribe

_______________________________________________
Mailing-List: https://odoo-community.org/groups/contributors-15
Post to: mailto:contributors@odoo-community.org
Unsubscribe: https://odoo-community.org/groups?unsubscribe

_______________________________________________
Mailing-List: https://odoo-community.org/groups/contributors-15
Post to: mailto:contributors@odoo-community.org
Unsubscribe: https://odoo-community.org/groups?unsubscribe

by vickynoida007 - 07:06 - 22 Jan 2025

Re: BPM On Odoo

Hi Michel,

Thanks for your support, we are working on setting up few vertical but our tool can be used to implement any new processes example employee onboarding, leave approval, multi department approval etc that you or your customer may need to manage your business.

Regards,

Manish Mannan

From: Michel Stroom <notifications@odoo-community.org>
Date: Wednesday, 22 January 2025 at 2:37 AM
To: Contributors <contributors@odoo-community.org>
Subject: Re: BPM On Odoo

Great progress, Manish!

You already have my full support and my contact details.

As we’ve discussed, focus on specific industries where workflows play a crucial role.
Keep in mind that workflow solutions are typically more suited to larger enterprises rather than smaller ones.

I’m looking forward to collaborating with you and seeing how we, as the OCA, can contribute to creating the BPM.
Stay in touch, and please keep us — and me — updated.

Warmest regards,

Michel Stroom

--

Office Everywhere
Business Partner Odoo

t: +31 6 53360677
e: mstroom@office-everywhere.com
w: Office-Everywhere.com

LinkedIn profile: https://linkedin.com/in/stroom

On 21 Jan 2025, at 18:03, Manish Mannan (Manish) <notifications@odoo-community.org> wrote:

Hello Community,

We are in the process of developing a BPM solution on top of Odoo. Your suggestions and input would be greatly appreciated.

Looking forward to hearing your ideas!

Regards,

Manish Mannan

_______________________________________________
Mailing-List: https://odoo-community.org/groups/contributors-15
Post to: mailto:contributors@odoo-community.org
Unsubscribe: https://odoo-community.org/groups?unsubscribe

_______________________________________________
Mailing-List: https://odoo-community.org/groups/contributors-15
Post to: mailto:contributors@odoo-community.org
Unsubscribe: https://odoo-community.org/groups?unsubscribe

by Manish Mannan - 07:01 - 22 Jan 2025

Re: BPM On Odoo

This seems a variation that comes up every year or so. This should be your starting point, and probably ending point IMO. https://docs.google.com/presentation/d/e/2PACX-1vR9VGsSQUnITdnQq5KRiWnY7o-yERCB8YfnqxzhFW5tFcJ8AzMmIQ1CpLTdEgy5Sz9nx-yQlC0BhyGR/pub?start=false&loop=false&delayms=3000&slide=id.p

On Wed, Jan 22, 2025 at 10:07 AM Michel Stroom <notifications@odoo-community.org> wrote:

Great progress, Manish!
You already have my full support and my contact details.

As we’ve discussed, focus on specific industries where workflows play a crucial role.
Keep in mind that workflow solutions are typically more suited to larger enterprises rather than smaller ones.
I’m looking forward to collaborating with you and seeing how we, as the OCA, can contribute to creating the BPM.
Stay in touch, and please keep us — and me — updated.

Warmest regards,

Michel Stroom
--
Office Everywhere
Business Partner Odoo
t: +31 6 53360677
e: mstroom@office-everywhere.com
w: Office-Everywhere.com
LinkedIn profile: https://linkedin.com/in/stroom

On 21 Jan 2025, at 18:03, Manish Mannan (Manish) <notifications@odoo-community.org> wrote:

Hello Community,
We are in the process of developing a BPM solution on top of Odoo. Your suggestions and input would be greatly appreciated.
Looking forward to hearing your ideas!

Regards,

Manish Mannan

_______________________________________________
Mailing-List: https://odoo-community.org/groups/contributors-15
Post to: mailto:contributors@odoo-community.org
Unsubscribe: https://odoo-community.org/groups?unsubscribe

_______________________________________________
Mailing-List: https://odoo-community.org/groups/contributors-15
Post to: mailto:contributors@odoo-community.org
Unsubscribe: https://odoo-community.org/groups?unsubscribe

by Graeme Gellatly - 11:22 - 21 Jan 2025

Re: BPM On Odoo

Great progress, Manish!

You already have my full support and my contact details.

As we’ve discussed, focus on specific industries where workflows play a crucial role.
Keep in mind that workflow solutions are typically more suited to larger enterprises rather than smaller ones.

I’m looking forward to collaborating with you and seeing how we, as the OCA, can contribute to creating the BPM.
Stay in touch, and please keep us — and me — updated.

Warmest regards,

Michel Stroom

--

Office Everywhere
Business Partner Odoo

t: +31 6 53360677
e: mstroom@office-everywhere.com
w: Office-Everywhere.com

LinkedIn profile: https://linkedin.com/in/stroom

On 21 Jan 2025, at 18:03, Manish Mannan (Manish) <notifications@odoo-community.org> wrote:

Hello Community,
We are in the process of developing a BPM solution on top of Odoo. Your suggestions and input would be greatly appreciated.
Looking forward to hearing your ideas!

Regards,

Manish Mannan

_______________________________________________
Mailing-List: https://odoo-community.org/groups/contributors-15
Post to: mailto:contributors@odoo-community.org
Unsubscribe: https://odoo-community.org/groups?unsubscribe

by Michel Stroom - 10:06 - 21 Jan 2025

Re: BPM On Odoo

Hi Miguelângelo,

if you want to collaborate, Please write me an email at manish@o2b.co.in

Regards,

Manish Mannan

From: Miguelângelo Faria Rocha <notifications@odoo-community.org>
Date: Tuesday, 21 January 2025 at 10:52 PM
To: Contributors <contributors@odoo-community.org>
Subject: Re: BPM On Odoo

Hello,

For process modeling I have experience and I recommend using this library: https://bpmn.io

Regards,

Miguelângelo

Em ter., 21 de jan. de 2025 às 14:12, Joel Patrick <notifications@odoo-community.org> escreveu:

That could be useful! Is there a charter document for that?
What jobs would a BPM do for a typical Odoo implementation?

Joel Patrick

On Tue, Jan 21, 2025 at 12:03 PM Manish Mannan (Manish) <notifications@odoo-community.org> wrote:

Hello Community,

We are in the process of developing a BPM solution on top of Odoo. Your suggestions and input would be greatly appreciated.

Looking forward to hearing your ideas!

Regards,

Manish Mannan

_______________________________________________
Mailing-List: https://odoo-community.org/groups/contributors-15
Post to: mailto:contributors@odoo-community.org
Unsubscribe: https://odoo-community.org/groups?unsubscribe

_______________________________________________
Mailing-List: https://odoo-community.org/groups/contributors-15
Post to: mailto:contributors@odoo-community.org
Unsubscribe: https://odoo-community.org/groups?unsubscribe

_______________________________________________
Mailing-List: https://odoo-community.org/groups/contributors-15
Post to: mailto:contributors@odoo-community.org
Unsubscribe: https://odoo-community.org/groups?unsubscribe

by Manish Mannan - 06:36 - 21 Jan 2025

Re: BPM On Odoo

Hi Joel,

Thank you for your prompt interest. While we have not yet created a charter document, we are in the process of developing one. I would like to outline the key advantages of building BPM processes on Odoo.

1. Enhanced Process Customization

While Odoo provides excellent built-in workflows for various business functions, BPM solutions allow for greater flexibility to design, optimize, and adapt custom workflows that align perfectly with an organization’s unique needs. having a BPM Solution could eliminate the need of greater customization.

2. Cross-Departmental Integration

Odoo focuses on specific modules (e.g., CRM, Inventory, HR), but BPM solutions can manage end-to-end workflows across multiple departments, ensuring seamless coordination between systems and teams.

3. Process Automation Beyond Standard Odoo Workflows

Odoo is excellent for managing standard workflows, but BPM adds layers of automation for complex, multi-step processes that might involve decision-making, approvals, or external integrations.

4. Visual Process Mapping

BPM tools often come with drag-and-drop visual designers to model processes intuitively. This visual mapping makes workflows easier to understand, modify, and manage compared to Odoo's backend workflows.

5. Dynamic Workflow Adjustments

Odoo workflows may require coding or module adjustments for changes. BPM tools enable real-time updates to processes without heavy technical intervention, saving time and effort during process optimization.

6. Advanced Reporting and Analytics

BPM systems provide detailed insights into workflow performance, bottlenecks, and inefficiencies, helping organizations make data-driven decisions. While Odoo offers reports, BPM tools often provide deeper analytics tailored to process optimization.

7. Improved Compliance Management

BPM tools are specifically designed to ensure processes comply with industry standards and regulations, enabling better tracking, auditing, and adherence to legal requirements.

8. Scalability for Complex Organizations

As businesses grow, their processes become more complex. BPM solutions offer scalability to manage workflows that involve multiple systems, geographies, or external partners, which may be beyond Odoo’s standard capabilities.

employees can design and modify workflows on their own without IT dependency, fostering innovation and improving overall efficiency.

Key Use Cases for BPM Over Odoo

Custom approval workflows that span multiple departments.
Automating regulatory compliance processes.
Advanced task prioritization and resource allocation.
Visualizing bottlenecks and optimizing operational workflows.
Rapid adaptation to business changes without disrupting operations.

Conclusion

While Odoo is a powerful ERP with robust standard workflows, a BPM solution complements it by adding agility, customization, and efficiency, particularly for businesses with unique or highly complex processes. Tools can bridge the gap by empowering organizations to create, manage, and optimize workflows seamlessly.

Best Regards,

Manish Mannan

From: Joel Patrick <notifications@odoo-community.org>
Date: Tuesday, 21 January 2025 at 10:42 PM
To: Contributors <contributors@odoo-community.org>
Subject: Re: BPM On Odoo

That could be useful! Is there a charter document for that?
What jobs would a BPM do for a typical Odoo implementation?

Joel Patrick

On Tue, Jan 21, 2025 at 12:03 PM Manish Mannan (Manish) <notifications@odoo-community.org> wrote:

Hello Community,

We are in the process of developing a BPM solution on top of Odoo. Your suggestions and input would be greatly appreciated.

Looking forward to hearing your ideas!

Regards,

Manish Mannan

_______________________________________________
Mailing-List: https://odoo-community.org/groups/contributors-15
Post to: mailto:contributors@odoo-community.org
Unsubscribe: https://odoo-community.org/groups?unsubscribe

_______________________________________________
Mailing-List: https://odoo-community.org/groups/contributors-15
Post to: mailto:contributors@odoo-community.org
Unsubscribe: https://odoo-community.org/groups?unsubscribe

by Manish Mannan - 06:31 - 21 Jan 2025

Re: BPM On Odoo

Hello,

For process modeling I have experience and I recommend using this library: https://bpmn.io

Regards,

Miguelângelo

Em ter., 21 de jan. de 2025 às 14:12, Joel Patrick <notifications@odoo-community.org> escreveu:

That could be useful! Is there a charter document for that?
What jobs would a BPM do for a typical Odoo implementation?

Joel Patrick

On Tue, Jan 21, 2025 at 12:03 PM Manish Mannan (Manish) <notifications@odoo-community.org> wrote:

Hello Community,

We are in the process of developing a BPM solution on top of Odoo. Your suggestions and input would be greatly appreciated.

Looking forward to hearing your ideas!

Regards,

Manish Mannan

_______________________________________________
Mailing-List: https://odoo-community.org/groups/contributors-15
Post to: mailto:contributors@odoo-community.org
Unsubscribe: https://odoo-community.org/groups?unsubscribe

_______________________________________________
Mailing-List: https://odoo-community.org/groups/contributors-15
Post to: mailto:contributors@odoo-community.org
Unsubscribe: https://odoo-community.org/groups?unsubscribe

by miguelangelo.rocha@gmail.com - 06:21 - 21 Jan 2025

Re: BPM On Odoo

That could be useful! Is there a charter document for that?
What jobs would a BPM do for a typical Odoo implementation?

Joel Patrick

On Tue, Jan 21, 2025 at 12:03 PM Manish Mannan (Manish) <notifications@odoo-community.org> wrote:

Hello Community,

We are in the process of developing a BPM solution on top of Odoo. Your suggestions and input would be greatly appreciated.

Looking forward to hearing your ideas!

Regards,

Manish Mannan

_______________________________________________
Mailing-List: https://odoo-community.org/groups/contributors-15
Post to: mailto:contributors@odoo-community.org
Unsubscribe: https://odoo-community.org/groups?unsubscribe

by joel.patrick - 06:11 - 21 Jan 2025

BPM On Odoo

Hello Community,

We are in the process of developing a BPM solution on top of Odoo. Your suggestions and input would be greatly appreciated.

Looking forward to hearing your ideas!

Regards,

Manish Mannan

by Manish Mannan - 06:01 - 21 Jan 2025

Re: OCA Code Sprint - Brussels - 30 + 31 January

Unfortunately i wasn.t in Brussels in this dates , success for oca members
Regards

Le mar. 21 janv. 2025, 13:49, Rebecca Gellatly <notifications@odoo-community.org> a écrit :

Hello OCA Contributors,

I hope 2025 is treating you well so far.

I just wanted to remind you we have our code sprint in Brussels coming up on the 30th and 31st of January. Just a couple of weeks away. We thought, as people might be in town for FOSDEM we would harness the opportunity to encourage people to meet up.

You can attend for just one day or both, completely up to you.

You can register here: https://odoo-community.org/event/oca-codeprint-brussels-2025-01-30-2025-02-01-158/register
The small price is just to cover lunches and refreshments.

We will run remotely too.

To help prepare:
Working document for the sprint is here. It is great to fill in beforehand to help focus the work at the event.
Discord Channel is here. This way our remote companions can join in too!
We look forward to seeing those that can make it.
Rebecca

--
Rebecca Gellatly
General Secretary
Odoo Community Association

_______________________________________________
Mailing-List: https://odoo-community.org/groups/contributors-15
Post to: mailto:contributors@odoo-community.org
Unsubscribe: https://odoo-community.org/groups?unsubscribe

by Abdrahman Elkafil - 05:01 - 21 Jan 2025

Re: Questions about ODOO v.17 - Mass creation of items in purchase orders.

If you have the website_sale module installed, you can call product.template create_product_variant [1] idempotently via XML-RPC to create product variants on demand. Under the hood, that simply calls product.template _create_product_variant [2] in the product module, but you can't call that directly via XML-RPC since the function is private (indicated by the leading underscore in the name).

[1] https://github.com/odoo/odoo/blob/dc1cbcfec29d2434a842cbd668c9d800665b2cbe/addons/website_sale/models/product_template.py#L572

[2] https://github.com/odoo/odoo/blob/dc1cbcfec29d2434a842cbd668c9d800665b2cbe/addons/product/models/product_template.py#L1125

On Tue, Jan 21, 2025 at 7:22 AM hugo.ferrer <notifications@odoo-community.org> wrote:

Good afternoon, Community.
I have a question, I am participating in an implementation project of the ODOO system in version 17, I need to create products with their variants dynamically, and then upload the items in bulk, to a purchase order, my partner tells me that this is not possible, I must do it from the sales order, and then create the purchase order manually, I cannot create the items in bulk. That causes a problem for me because my purchase orders contain up to 1000 SKU´s This is a restriction that complicates my operations at the purchasing level. I want to ask you if there is a solution if there is something that we and our partner are not seeing in the process.

I appreciate your support.

Regards.
HF

_______________________________________________
Mailing-List: https://odoo-community.org/groups/contributors-15
Post to: mailto:contributors@odoo-community.org
Unsubscribe: https://odoo-community.org/groups?unsubscribe

by Adam Heinz - 02:41 - 21 Jan 2025

Mass Import of Products with Dynamic Attributes in Odoo 17 for Sales Orders.

I have some doubts, I am participating in a project to implement the ODOO system in version 17, I need to create products with their variants using the dynamic method, and then upload the new articles created in bulk.

I have two specific questions:

1. How can new items (SKUs) be uploaded en masse to a sales order, when the attributes are dynamic?

2. Is there a template to do this?

Regards.

HF.

by Hugo Ferrer - 06:07 - 20 Jan 2025

Questions about ODOO v.17 - Mass creation of items in purchase orders.

Good afternoon, Community.

I have a question, I am participating in an implementation project of the ODOO system in version 17, I need to create products with their variants dynamically, and then upload the items in bulk, to a purchase order, my partner tells me that this is not possible, I must do it from the sales order, and then create the purchase order manually, I cannot create the items in bulk. That causes a problem for me because my purchase orders contain up to 1000 SKU´s This is a restriction that complicates my operations at the purchasing level. I want to ask you if there is a solution if there is something that we and our partner are not seeing in the process.

I appreciate your support.

Regards.

HF

by Hugo Ferrer - 06:07 - 20 Jan 2025

Members update of PSC team Finland

Dear maintainer of the web page https://odoo-community.org/psc-teams/finland-63

Jarmo Kortetjärvi (jarmo.kortetjarvi@futural.fi, https://odoo-community.org/partners/oy-tawasta-os-technologies-ltd-jarmo-kortetjarvi-2267) has been nominated as the OCA representative of the PSC team Finland. I, Jussi Lehto (https://odoo-community.org/members/ab-cetmix-nordic-oy-jussi-lehto-30807), have been nominated as a member. Due to inactivity, Henri Alasentie and Miku Laitinen have resigned.

Please update the PSC team Finland web page according to the updates. I appreciate any help you can provide.

ystävällisin terveisin / kind regards,


-- 
Jussi Lehto
Country Managing Partner (Finland)
Cetmix®
https://www.cetmix.fi 

e-mail: jussi.lehto@cetmix.com
tel. +358 40 192 8404

by Jussi Lehto - 03:31 - 19 Jan 2025

OCA Code Sprint - Brussels - 30 + 31 January

Hello OCA Contributors,

I hope 2025 is treating you well so far.

I just wanted to remind you we have our code sprint in Brussels coming up on the 30th and 31st of January. Just a couple of weeks away. We thought, as people might be in town for FOSDEM we would harness the opportunity to encourage people to meet up.

You can attend for just one day or both, completely up to you.

You can register here: https://odoo-community.org/event/oca-codeprint-brussels-2025-01-30-2025-02-01-158/register

The small price is just to cover lunches and refreshments.

We will run remotely too.

To help prepare:

Working document for the sprint is here. It is great to fill in beforehand to help focus the work at the event.
Discord Channel is here. This way our remote companions can join in too!

We look forward to seeing those that can make it.

Rebecca

--

Rebecca Gellatly

General Secretary

Odoo Community Association

by Rebecca Gellatly - 05:35 - 17 Jan 2025

Re: "The plan" to help non technical to contribute documentation on OCA modules

In the Odoo eco-system are there Functionals (as opposed to Technicals)? That seems to be the way ERP works. Non-technicals = functionals?

Is there an open source model where the doc could be a model? Hadoop, ERPNext, …? How important is the governance model for good docs? more or less important than Wikipedia, for example?

Best,

JP

On Wed, Jan 15, 2025 at 10:12 AM Francesco Foresti <notifications@odoo-community.org> wrote:

Hi all,

regarding Simone's proposal:

"In order to fix this, and only this, there was one proposal that I did like at that table: add a button in the README that pops up an editor and lets functional people edit the README and seamlessly create a PR."

In your opinion, would that be an acceptable first step that could be implemented relatively quickly?

Cheers

Francesco

Il giorno gio 2 gen 2025 alle ore 11:37 Simone Rubino <notifications@odoo-community.org> ha scritto:
Thanks Jairo for this extensive explanation of pros and cons, and the examples.
I was at that table during the OCA days: I was not entirely convinced then as I'm not entirely convinced right now.
I also tried a prototype of this new workflow and I can say that you and others put a lot of effort into it for sure, thanks again for that.

In my opinion the new workflow is trying to fix many problems all at once, but I think that we should keep the focus on the one problem at hand:
Allow consultants to update the documentation in a user-friendly tool
and then move to others because it's easier to agree on fewer things at a time.

As you explained, there are multiple issues right now:
functionals are not able to easily update the README of a module
a module has a different README in each version
migrations do not update the README properly
translations in README can't be done
I think that right now we should focus on letting functional people update a module documentation (README) easily, let's try to solve only this problem first, then move to others.

In order to fix this, and only this, there was one proposal that I did like at that table: add a button in the README that pops up an editor and lets functional people edit the README and seamlessly create a PR.
It was discarded then because it did not solve version misalignment but that should be another step towards the ultimate documentation solution.
I think this would be much easier to implement and roll out because it does not need a new repo or a new docs database because everything would be on the fly.

On a side note, what about moving to a discussion in https://github.com/orgs/OCA/discussions? I think it would be easier to edit/manage/reply-to than emails.

On Thu, 2 Jan 2025 at 10:37, Jairo Llopis <notifications@odoo-community.org> wrote:
Hi everyone!

IMHO both controversial points, when applied together, reduce the pain that we currently have.

Some current facts:
Current OCA docs (aka READMEs) are not always updated.
Functional contributors have a very hard time at contributing to those docs.
Maintaining version divergences is already very hard for technicians. Asking functionals to do that is a big part of the current problem.
When thinking of a new docs system, we have to think about who will write the docs and who will read them.
Data duplication is not good for SEO.
We want good, up-to-date docs.
So, let's say that we keep the current status quo. We just teach functionals how to use git, write good commit messages, write markdown, use github, switch between branches, do a rebase every now and then, and we expect them to update the readmes. And let's imagine for a second that this happens.

Now they have a task: update docs for 10 modules, across all the 3 versions maintained in their companies. Many OCA contributors just use even Odoo releases, so those versions might be 14.0, 16.0 and 18.0.

Now just do the math: 10 modules x 3 versions = 30 READMEs. With the new system, 10 modules x 1 single doc = 10 REAMEs to update. Conclusion: 1 single doc is more maintainable. And still, versions 15.0 and 17.0 would be forgotten with the older system, while with the newer one they'd also get those changes.

I was sitting down at the table with the functional people expressing how difficult it is for them to contribute to OCA. At the same table were some very experienced contributors, including OCA Board members. We're trying to improve a problematic situation we have right now. Of course, current controversies came to the table. Some of our thoughts:
Is it really that important that the screenshots you see are for the same version of the module that you're using?
No. Many times, modules are migrated and screenshots are not updated. As long as the module works mostly the same, it's good enough.
Besides, you can have a custom theme. Or even you could use Odoo EE and all your UI will be different.
Is it really that common that modules behave significantly different between versions?
It happens, but it's the less common case.
So, if we favor the most common case (the module does mostly the same across versions) and still have a way to handle the least common one (significant UX divergences), we still are winning.

So, are we really crazy to tell you that we can maintain a single doc? Let's see how others do it.

When I think of good docs, I think of Gitlab. Their docs are awesome. How do they handle the different versions? I'll showcase some examples below, so we can learn from them. FWIW I'm currently browsing the latest Gitlab docs, which officially target v17.8. Also FWIW, they have a version dropdown. I used Gitlab for about 10 years and I never had to click that dropdown.

These install instructions will tell you which postgres version to use. They have several gitlab flavors, and they maintain 4 major releases. However, all the info is gathered in a single docs page:

Now, think about it. Is it easier for a writer (who is not a programmer) to maintain 4 different branches of docs with different installation instructions? Or just to maintain the latest one, which has a table indicating data for all versions? Of course, the latter.

How do they handle feature changes? See:

Again, if you're using Gitlab 16.0, it's still better for you to read these docs than the docs for 16.0, because you don't only know how it works, but how it has evolved since the version you're using. This helps you prepare for that. As a docs reader, this structure is way better. For a writer it's also easier to maintain.

Now, let's think about deprecations and removals. They have a page dedicated to that. Currently I'm browsing docs for v17.8, but I can see info for past and future versions (up to Gitlab 20.0!). Future versions! Of course! It's relevant for me to know if something will be deprecated, even if it still works. Brilliant.

Apart from that, deprecated features still have a red warning about their status. One example:

The fact that docs are centralized isn't a big problem IMHO. If you need offline access, you can clone the repo and browse those docs offline. And the fact that the module docs are scattered across various places (oca/docs and the module code) would be "less worse" than having to maintain up-to-date per-version readmes.

An extra point of having centralized docs is that you can exit the current constraints of "just a readme per module", and start having use-case-based docs. Imagine a webpage where you can explain how to use OCA for having better inventory management, for boosting sales, for better privacy, etc. An use-case-based page can just link to the individual modules needed to get that use case done. That's impossible with the current structure.

So, summarizing:
Current workflow
Is easy to "fire and forget". You push the module, it has the readme, it works, done. Never look back. Yes, we knew that taking technicals out of something comfortable for them would produce these kinds of reactions.
When you migrate a module, most times docs are not updated accordingly.
Has everything self-contained.
Is per-version.
Is hard to maintain. As a consequence, it's not properly maintained.
It's impossible to use by functionals. Thus, writing docs is an extra burden almost exclusively on the shoulders of coders.
Docs are written by whoever wrote the module. Sadly, this impacts negatively on the quality of the docs. They communicate with more technical words. Maintaining videos and pictures is burdensome for them.
Translating is impossible.
Merging changes involves irrelevant nitpickings (commit message, formatting, etc.)
New workflow:
Can be equally easy when adding a new module (due to a sync that could import that readme as the starting docs for the module). When adding a new feature, it can involve adding another PR to docs. That PR, however, doesn't have to be done by the programmer.
When migrating a module, if it behaves the same, there'll be nothing to be done. Otherwise, see point 1.
Docs centralized.
Single page. Relevant per-version changes kept on the same page.
Easier to maintain. As a consequence, they'll have more maintenance.
Functionals can learn to contribute in a 5-minutes video. Less copywriting burden for coders.
Docs are written by people that use the module. They communicate without technicisms. They value pictures and videos as that's their daily life. Docs quality will be better.
Translating is possible (not yet in the MVP, before you ask).
Functionals can merge without nitpicks. Reviews are done purely visually. The outcome is an SSG with very little attack surface. Git is just a DB.
The new workflow is not perfect, and it might require an extra PR every now and then. However, IMHO it opens many doors for improvement that are currently closed.

Many have predicted "catastrophes" with this idea. However, it's good to reflect on the pain points we currently have. Why not also try to predict how much better this would be? When I think about it, I see it's worth trying.

_______________________________________________

Mailing-List: https://odoo-community.org/groups/contributors-15
Post to: mailto:contributors@odoo-community.org
Unsubscribe: https://odoo-community.org/groups?unsubscribe

_______________________________________________
Mailing-List: https://odoo-community.org/groups/contributors-15
Post to: mailto:contributors@odoo-community.org
Unsubscribe: https://odoo-community.org/groups?unsubscribe

--

Francesco Foresti
Sicurpharma Srl
francesco.foresti@ooops404.com
+39 333 8123 790

_______________________________________________
Mailing-List: https://odoo-community.org/groups/contributors-15
Post to: mailto:contributors@odoo-community.org
Unsubscribe: https://odoo-community.org/groups?unsubscribe

by joel.patrick - 04:35 - 16 Jan 2025

Archives

Contributors

Re: OCA pip module loaded by external organization on pypi.org

OCA pip module loaded by external organization on pypi.org

Request for Guidance on Migrating from POS UI API v15 to v16

Solicitud para colaborar con Odoo

Re: BPM On Odoo

Re: BPM On Odoo

Re: BPM On Odoo

Re: BPM On Odoo

Re: BPM On Odoo

Re: BPM On Odoo

3. Process Automation Beyond Standard Odoo Workflows

4. Visual Process Mapping

5. Dynamic Workflow Adjustments

6. Advanced Reporting and Analytics

7. Improved Compliance Management

8. Scalability for Complex Organizations

Re: BPM On Odoo

Re: BPM On Odoo

BPM On Odoo

Re: OCA Code Sprint - Brussels - 30 + 31 January

Re: Questions about ODOO v.17 - Mass creation of items in purchase orders.

Mass Import of Products with Dynamic Attributes in Odoo 17 for Sales Orders.

Questions about ODOO v.17 - Mass creation of items in purchase orders.

Members update of PSC team Finland

OCA Code Sprint - Brussels - 30 + 31 January

Re: "The plan" to help non technical to contribute documentation on OCA modules

Follow us