The documentation is unclear about the unit used for the --limit-memory-soft
and --limit-memory-hard options of odoo-bin. The unit used is bytes, but
it isn't mentioned and the default unit is shown in mebibytes, causing
confusion.
closesodoo/documentation#5789
X-original-commit: 9fadc3355d
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
The link pointing to domain.js file was broken.
The xml id on the line before that is also broken but it will be fixed with PR#5699.
closesodoo/documentation#5702
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
Co-authored-by: Armin FalDiS <armin.fallah96@gmail.com>
Co-authored-by: Armin FalDiS <fara@odoo.com>
This PR moves the introduction about the different installation methods and editions found on the
install/install.rst page directly under the main install/ page. It creates three pages, one per
installation method documented on the install/install.rst page (Docker being documented on
docker.com and maintained by us), and moves the related content there. In addition, it fixes various
typos/grammar issues and improves the content according to the documentation guidelines. Various
references and links across the documentation had to be fixed accordingly.
task-3459070
closesodoo/documentation#5526
X-original-commit: 42a8f492e7
Signed-off-by: Xavier Platteau (xpl) <xpl@odoo.com>
Commit f36c612d13 changed the model name
in Chapter 4 without updating the other occurences.
closesodoo/documentation#5505
X-original-commit: b6f923d111
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
Using `<` inside XML elements will result in a parsing error,
an entity reference should be used instead: `<`.
closesodoo/documentation#5159
Signed-off-by: Levi Siuzdak (sile) <sile@odoo.com>
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
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?)
closesodoo/documentation#5137
X-original-commit: f36c612d13
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
Examples rely on `kolo/xmlrpc` as well as on the standard library package `log` to panic on error, matching snippets in other languages (which tend to raise exceptions).
As with other languages, only the RPC interaction is spelled out.
closesodoo/documentation#5064
Signed-off-by: Xavier Morel (xmo) <xmo@odoo.com>
Reflects the fact that assets_qweb bundle is no longer used in 16.0
closesodoo/documentation#5094
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
In chapter 13 the `property_ids` field is defined as the inverse of a
`user_id` field. But in chapter 8 when the salesperson field is added,
no such name is given to it.
This commit adapts the description to reference the general concept of
the field used to link to the salesperson instead of an actual field
identifier.
task-3381757
closesodoo/documentation#4905
X-original-commit: 3a131c829a
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
The attributes of fields of list views do not mention the `optional`
attribute while it is used by chapter 12 of the R&D Training.
This commit describes this `optional` attribute.
task-3380953
closesodoo/documentation#4904
X-original-commit: 5a446f5c59
Signed-off-by: Benoit Socias (bso) <bso@odoo.com>
The deploy documentation is assuming that `/etc/odoo.conf` is the
default config file, which is not the case.
With this commit, the configuration file references the cli
documentation.
closesodoo/documentation#4804
X-original-commit: 8aed7988ba
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
Signed-off-by: Christophe Monniez (moc) <moc@odoo.com>
This commit improves the structure of the accounting documentation by
- reducing the levels necessary to reach the information
- grouping some docs
- moving content to their parent category page (content in all levels)
- renaming some sections to reflect the structure of the app better
task-3330093
closesodoo/documentation#4470
Signed-off-by: Castillo Jonathan (jcs) <jcs@odoo.com>
A complete guide on how to create a custom website theme for Odoo
closesodoo/documentation#4399
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
Signed-off-by: Castillo Jonathan (jcs) <jcs@odoo.com>
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.
closesodoo/documentation#4402
X-original-commit: 276f981703
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
A few links were already outdated. Either the referenced code was no
longer on the same line, or the file didn't exist anymore.
This commit freezes all links targeting a specific line on the odoo/odoo
repository by selecting a specific commit.
Part-of: odoo/documentation#3994
Commits pushed on the odoo/tutorials repository are not automatically
forward-ported, which makes it cumbersome to keep all SaaS branches up
to date.
Because of this, and because Odoo developers are very unlikely to follow
tutorials specific to a SaaS branch, links to odoo/tutorials now target
the current major branch, or master if applicable. SaaS branches have
also been deleted from the odoo/tutorials repository.
Part-of: odoo/documentation#3994
This commit splits the 7 chapters of the JS tutorial in two
smaller and more focused tutorials:
- a basic one (Discover the JS framework)
- and an advanced one (Master the odoo web framework)
closesodoo/documentation#4243
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
SQL view was formerly part of the dashboard tutorial which is now
obsolete. Since creating a SQL view as a tutorial does not make sense
anymore, it has been converted into a simple howto.
closesodoo/documentation#4031
Task: 3226581
Signed-off-by: Tiffany Chang <tic@odoo.com>
Since odoo/enterprise#31641 the dashboard view no longer exists since it
is now replaced with spreadsheet_dashboard, therefore we remove it from
the backend Views documentation.
Task: 3226581
Part-of: odoo/documentation#4031
The JavaScript cheatsheet is outdated, we therefore remove it and
replace it by multiple howtos:
- Create a view from scratch
- Extending an existing view
- Create a field from scratch
- Extend an existing field
- Create a client action
There is other subjects to introduce as the web framework is big. Other
future contributions will cover them.
closesodoo/documentation#3969
Signed-off-by: Dardenne Florent (dafl) <dafl@odoo.com>
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
closesodoo/documentation#3988
X-original-commit: 1ce7166f49
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
Signed-off-by: Benoit Socias (bso) <bso@odoo.com>
The extension adds two new directive:
- `cards` is the row container for one or more `card` directives.
- `card` is the implementation of a Bootstrap card that accepts a
`target` argument for the href of the card, a `large` option to render
the card on two columns, a `tag` option to display a single arbitrary
tag on the card, and arbitrary content that is shown in the card
body.
task-3141419
closesodoo/documentation#3685
X-original-commit: 72e636da5f
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
This commit also replaces references to the "Building a module"
tutorial by references to the "Getting started" tutorial.
task-2991663
Part-of: odoo/documentation#3655
Those components were added during the Owl rewrite of the webclient
that happened in 16.0. Unfortunately, there was still no documentation
for them.
This commits fixes that by adding documentation for the Notebook and
the Colorlist components.
closesodoo/documentation#3580
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
RST cleanup to comply with the RST guidelines. This is required so we
can use "make test", as there are currently hundreds of errors. For now,
it is unusable because of the oldest code in this repo.
closesodoo/documentation#3581
Signed-off-by: Castillo Jonathan (jcs) <jcs@odoo.com>
Since 16.0, the documentation for this component was no longer
correct, since the component was moved to web during the refactor
of the webclient views. This commit also adds documentation of
props that were introduced during the refactor, already present
in 16.0.
closesodoo/documentation#3504
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
