documentation icon indicating copy to clipboard operation
documentation copied to clipboard

Misleading description of creating new module

Open eximius313 opened this issue 2 months ago • 0 comments

I was following this tutorial:
https://www.odoo.com/documentation/19.0/developer/tutorials/server_framework_101/02_newapp.html

I spent hours trying to make my module appear in Odoo. I finally managed to do it, but a few points in the documentation were misleading or confusing:

  1. The “Update Apps List” step
Image

The tutorial says:

“Restart the Odoo server and go to Apps. Click on Update Apps List.”

If you’re following this tutorial for the first time, it’s unclear where to find this “Update Apps List” button. It would be beneficial to insert the screenshot:

Image

Moreover, the Warning note should appear above this text.
I was following the tutorial step by step, and when I got stuck on this step, I stopped reading further — which likely happens to many readers.

Suggested order:

  • Restart the Odoo server and go to Apps.
  • [Warning box here mentioning that one should see this button as shown in screenshot above]
  • Click on “Update Apps List”, search for “estate” and… tadaaa, your module appears! Did it not appear? Maybe try removing the default “Apps” filter ;-)
  1. Missing __manifest__.py example

It would help to include a small example like this:

{
'name': 'Estate',
'version': '0.1',
'summary': 'Test module',
'depends': ['base']
}
  1. Docker setup clarification
    For users running Odoo in Docker, it’s crucial to mention that two directories must be mounted:
volumes:
- /home/$USER/src/config:/etc/odoo
- /home/$USER/src/tutorials/:/mnt/extra-addons

And, most importantly, the /home/$USER/src/config directory must contain an odoo.conf file with:

[options]
addons_path = /mnt/extra-addons

This would make the tutorial much clearer for first-time users, especially those running Odoo in Docker.

eximius313 avatar Oct 22 '25 21:10 eximius313