odoo / odoo/documentation

Misleading description of creating new module

Open
#14,980 0 comments 0 reactions 1 assignee View on GitHub

@AntoineVDV is already working on this.

Since Oct 23, 2025.

Dominant language
reStructuredText
Stars
1.3k
Forks
12.1k
PR merge metrics
No merged PRs in 30d

Description

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.

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.