Commit Graph

4 Commits

Author SHA1 Message Date
chyde-clearwater
f36c612d13 [IMP] tutorials/getting_started: disambiguate example model name
I removed the dot notation in the  "_name" variable for the example
model. AKA, "test.model" is now named "test_model".

Dot notation implies a data structure relationship between a <model> and
it's parent (or class etc) <test> (like test.model() or Test.model).
There is no relationship like this between a <test> and <model> - it's
just one thing: a <test model>.

The seeming "benefit" of the ORM translating dots to underscores doesn't
justify this naming convention.  Yes, I know it's a string, but still,
this seems confusing for newbies and adds unnecessary complexity (why
name the same thing differently in different places?)

closes odoo/documentation#5131

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2023-07-18 09:59:59 +02:00
Antoine Vandevenne (anv)
b48ffacd8c [IMP] tutorials/getting_started: rework the environment setup guide
This commit replaces a big chunk of the instructions relative to the
environment setup with a reference to the equivalent steps listed in the
contribution guide. It also moves the content of the "Create your first
PR" section from chapter 16 to chapter 2, as readers were struggling
with the Git configuration required to push their work to GitHub as they
progressed through the tutorial.

closes odoo/documentation#4380

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2023-05-10 14:03:00 +02:00
Benoit Socias
1ce7166f49 [IMP] tutorials: add warning about mutable global variables
The whole concept of multi-tenancy is not really approached within the
tutorial.

This commit adds a warning about never using mutable global variables
within odoo to seed the idea in the reader's mind.

task-3059110

closes odoo/documentation#3970

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2023-04-03 10:38:51 +02:00
Antoine Vandevenne (anv)
433e5607ac [MOV] howto/rdtraining: move "Getting started" to the tutorials dir
This commit also replaces references to the "Building a module"
tutorial by references to the "Getting started" tutorial.

task-2991663

Part-of: odoo/documentation#3629
2023-02-21 16:06:47 +01:00