Commit Graph

162 Commits

Author SHA1 Message Date
Valentin Chevalier
2c676ed846 [IMP] developer/howtos: Add missing information about debug mode
In chapter 3 of the developer core training, one is asked to click on a
button that is only shown in debug mode but there is no indication about
this mode in this chapter.

closes 

X-original-commit: 96d822bf87
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-06-27 09:59:58 +02:00
Julien Castiaux
97b7bdfd5e [IMP] rdtraining: tip about -i/-u for odoo-bin
It is never shown to the trainee that he can install/update a module
right from the CLI. Multiple developpers still use the app manager to
install/update their modules multiple months into the job.

closes 

X-original-commit: 3d2f067e6c
Signed-off-by: Victor Feyens (vfe) <vfe@odoo.com>
Signed-off-by: Julien Castiaux <juc@odoo.com>
2022-06-10 21:51:02 +02:00
Antoine Vandevenne (anv)
75e7f29fe1 [MOV] developer/api/odoo: rename odoo.rst into external_api.rst
The previous file name was not very relevant in regard to the content of
the page, and it conflicted with the `sys.path`.

closes 

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-05-20 14:44:52 +02:00
Antoine Vandevenne (anv)
4649c3f8d1 [MOV] content/*: move resource files into their related page's directory
Since , the guideline for the location of new
resource (images, downloadable files, RST includes...) files is to place
those inside the directory of the RST page that references them.

For example, if `doc1.rst` has a reference to `image.png` and to
`download.zip`, the file structure should look like this:

├── parent_doc/
│     └── doc1/
│     │     └── image.png
│     │     └── download.zip
│     └── doc1.rst
│     └── doc2.rst
├── parent_doc.rst

Before this commit, most of the resource files were still located inside
'media' directories holding all the resource files referenced by RST
pages located at the same level as these directories. In the example
above, a single 'media' directory would hold all the resource files
referenced by both `doc1.rst` and `doc2.rst`. Doing so prevented us from
figuring out easily which resource file was referenced by which RST page
and, thus, lead to unused resource files piling up in the repository. It
also made it more complicated to define codeowners regex rules because a
team could not simply be assigned to `/some_page.*` but needed to be
assigned to both `/some_page\.rst` and to the location of 'media'.

In order to help new content writers figure out the guideline when
taking examples from other RST pages, this commit retroactively applies
the guideline to existing resource files and 'media' directories. The
left-over resource files that are not referenced by any RST page are
removed.

task-2497965

Part-of: 
2022-05-20 14:44:52 +02:00
Beshoy Nabeih
a572e055a8 [FIX] developer/frontend: typo in the user menu registry example
closes 

X-original-commit: 6d30d81a76
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-05-19 15:18:59 +02:00
Altela Eleviansyah Pramardhika
d67a2492ce [FW][FIX] developer/howtos: Fixed typo from field to fields
closes 

Forward-port-of: 
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-05-19 15:18:56 +02:00
John Kirkwood (kij)
ad21e95e8b [IMP] developer: clarify options for many2one widget
Only `no_create` is required to hide both the 'Create "xxx"' and the
'Create and Edit...' dropdown menu options.

closes 

X-original-commit: 599a137ffc
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-05-19 14:14:58 +02:00
wan
3fb30d87d7 [REF] i18n/localization.rst: rework the entire localization tutorial
closes 

X-original-commit: 9db567159d
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
Signed-off-by: William André (wan) <wan@odoo.com>
Co-authored-by: William Andre <wan@odoo.com>
Co-authored-by: Ivan Yelizariev <iel@odoo.com>
2022-05-09 13:30:05 +02:00
Altela Eleviansyah Pramardhika
376ee43cf7 [FW][FIX] developer/howtos: missing parentheses in print statement
Added parentheses in a print function

closes 

Forward-port-of: 
Signed-off-by: Victor Feyens (vfe) <vfe@odoo.com>
2022-05-06 11:42:49 +02:00
Adrien Milis
1bee07e966 [FIX] developer/rd-training: fix commands
Changed commands that were still referring to Odoo 14.0 to 15.0

closes 

X-original-commit: b578f575d0
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-04-27 10:06:02 +02:00
Antoine Vandevenne (anv)
44a62e385f [FIX] developer/rdtraining: fix typos
closes 

X-original-commit: f8f5ed93e1
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-04-26 10:54:57 +02:00
Dossogne Bertrand
4d8c21fc11 [FIX] developer: fix duplicate action availability
The duplicate action is not available for list views

closes 

X-original-commit: ce1961ebaf
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-04-25 10:57:51 +02:00
Dossogne Bertrand
5ba9583788 [FIX] developer: fix duplicate availability
The duplicate action is not available for list views

closes 

X-original-commit: 9cf425d886
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-04-22 17:16:06 +02:00
Benoit Socias
af27e20e02 [IMP] rdtraining: clarify transition sentence to view inheritance
The "View Inheritance" section is introduced by a sentence that can be
understood as "do this task then we'll be ready to go the next section"
instead of "in the next section we will see how to do this task".
This can confuse the reader into thinking that some knowledge was not
acquired in the previous parts.

This commit makes it clear that the task described in the transition
sentence will be achieved in the next part.

task-2822582

closes 

X-original-commit: 5a39ba7d24
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
Signed-off-by: Benoit Socias (bso) <bso@odoo.com>
2022-04-14 13:43:55 +02:00
Benoit Socias
7462b89f57 [IMP] rdtraining: add note about Settings requiring at least one app
At the point when the developer mode is introduced in the training, it is
confusing because the documentation page describes the option inside the
Settings page, but that page only appears if at least one application is
installed. (Otherwise, the Settings app shows the Users instead)

This commit adds a note so that the reader does not start looking for a
screen that cannot be reached at that point.

task-2822582

X-original-commit: 2ebb7fe802
Part-of: 
2022-04-14 13:43:54 +02:00
Altela Eleviansyah Pramardhika
c4ffa7a8cd [FW][FIX] developer/rdtraining: fix typo
Fixed `name = field.Char(required=True)` to
`name = fields.Char(required=True)`.

closes 

Forward-port-of: 
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-04-11 12:39:57 +02:00
Antoine Vandevenne (anv)
9cb3eaa2ef [REL] freeze saas-15.3 branch
closes 

Related: 
Related: 
Related: 
2022-04-11 12:37:49 +02:00
poma-odoo
4eb09d95f2 [IMP] developer/views: add and remove tags for position=attributes
The tags`add`, `remove` and `separator` are not included in the
documentation.

closes 

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
Co-authored-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-03-29 11:59:50 +02:00
Thibault Francois
e6d9a9dac2 [IMP] CLI: adapt cloc doc to new behavior
since https://github.com/odoo/odoo/pull/85854 cloc
also count stylesheet file and frontend file in
imported module

closes 

X-original-commit: d2de65a15a
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-03-22 12:00:48 +01:00
Bruno Boi
0c0a7086ac [IMP] hooks: usePosition new API
closes 

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-03-21 10:15:16 +01:00
0b11001111
cadf860b42 [IMP] developer: extend internationalization guide
In order for javascript translations to become active, the corresponding
addon needs to follow a certain naming scheme or register explicitly.
This commit updates the internationalization guide with a respective
hint.

Fixes 

closes 

X-original-commit: 112b6c1267
Signed-off-by: Martin Trigaux (mat) <mat@odoo.com>
2022-03-18 17:05:10 +01:00
bve-odoo
279dc5a623 [FIX] dev/misc/cmdline: update url werkzeug
URL was pointing to a dead end.
Update from
http://werkzeug.pocoo.org/docs/contrib/fixers/#werkzeug.contrib.fixers.ProxyFix
to
https://werkzeug.palletsprojects.com/en/0.16.x/middleware/proxy_fix/#module-werkzeug.middleware.proxy_fix
new URL as we are using 0.16.1

closes 

X-original-commit: 7ce175ff55
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-03-17 11:48:40 +01:00
Antoine Vandevenne (anv)
7316152764 [IMP] developer/cli: mention the different ways of calling the CLI
All examples on the page suggest calling the CLI with "odoo-bin" while
it is recommended to call it with "odoo" when Odoo was installed from a
distribution package. It also failed to mention the location of
"odoo-bin" relative to the source files.

The chance is also taken to rename the somewhat unclear page title to
something more clear and generic.

closes 

X-original-commit: c018a53686
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-03-14 11:28:56 +00:00
Antoine Vandevenne (anv)
7b9bb78801 [IMP] developer/api/extract_api: rework page to get rid of switchers
task-2787415

closes 

X-original-commit: 85b7200944
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-03-11 14:44:47 +00:00
Antoine Vandevenne (anv)
4721c7291f [IMP] developer/api/odoo: rework page to use examples and content tabs
task-2787415

X-original-commit: 1afdec3784
Part-of: 
2022-03-11 14:44:46 +00:00
nle-odoo
8036fd51b5 [FIX] developer/mixins: mail.thread method names
In d46e358d3e88aea9f9289c4845c6c87ab9491c55 some mail.thread method
names were changed: it should be changed in documentation too.

closes 

X-original-commit: b24560e224
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-03-10 14:59:46 +00:00
Laurent Stukkens
ee52601986 [ADD] developper: add gantt dependency fields
task-2691454

closes 

Signed-off-by: Victor Feyens (vfe) <vfe@odoo.com>
2022-03-03 11:35:42 +00:00
Victor Feyens
d4367c4d9a [FIX] developer/http: adapt to recent httppocalypse changes
See https://github.com/odoo/odoo/pull/78857

closes 

Signed-off-by: Victor Feyens (vfe) <vfe@odoo.com>
2022-02-28 15:25:48 +00:00
Vincent Schippefilt
b49da1df09 [ADD] orm/changelog: Add a changelog page for the ORM changes
Introduce changelog of the ORM by version, link to first change documented

closes 

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-02-21 16:27:59 +00:00
Mathieu Duckerts-Antoine
9f179bd49d [IMP] hooks: useAutofocus new API
Recently, the API of useAutofocus has been simplified (see 4308de6aab).
Here we adapt its documentation.

closes 

Signed-off-by: Mathieu Duckerts-Antoine <dam@odoo.com>
2022-02-11 16:06:42 +00:00
Mathieu Duckerts-Antoine
2269ee51e8 [REF] notifications: removal of param messageIsHtml
closes 

Signed-off-by: Victor Feyens (vfe) <vfe@odoo.com>
2022-02-10 13:22:39 +00:00
Mathieu Duckerts-Antoine
484d245556 [IMP] hooks: document useAutofocus
Part-of: 
2022-02-10 13:22:38 +00:00
Antoine Vandevenne (anv)
6172c98159 [ADD] developer/reference/frontend: add an icons library page
task-2704984

closes 

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-02-08 14:26:42 +00:00
Antoine Vandevenne (anv)
cf6ca0fbb2 [IMP] contributing/doc, install: add an extension for content tabs
In many places in the docs, we need to document several flows that
differ only by a few details. For example, the steps to install Odoo
from the sources are almost identical for Windows, Linux, and Mac OS.
In other places, we'd want to suggest a command in different
environments or programming languages, etc.

This commit thus adds an extension for content tabs (tabs within the
content) to help reduce content repetition in the documentation. As a
proof of concept, the "Packaged installers" and "Source install"
sections of the "Installing Odoo" page are reworked to present their
content within tabs whenever it helps clarify the instructions.

A new python dependency is added as of this commit: `sphinx-tabs`

task-2713983

closes 

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
Co-authored-by: Lucie Van Nieuwenhuyse (luvn) <luvn@odoo.com>
2022-02-07 16:44:01 +00:00
Demesmaeker
8966e001c2 [IMP] integration_testing: add information about JS touring
Adding basic information about `How to make a test tour`.

task-2742841

closes 

X-original-commit: dbd5a1e1bb
Signed-off-by: Morgane Demesmaeker <edm@odoo.com>
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-02-02 15:55:41 +00:00
Niranjan Abhyankar
ce9cc2f48b [FIX] developer/javascript_cheatsheet: fix a typo
closes 

X-original-commit: d9e2ab6feb
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-02-02 13:46:10 +00:00
boan-odoo
64fd4bbd0a [IMP] rdtraining: add links from enterprise wiki
Select links and pieces of information from Odoo Enterprise wiki
were copied over at the end Chap. 2 of the functional training.

These would be useful to have during the tutorial instead of at
the end of it.

closes 

X-original-commit: a9bc16bec8
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
Co-authored-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-02-02 13:38:02 +00:00
Antoine Vandevenne (anv)
e4c963d7b6 [FIX] orm: remove autoattribute directive for BaseModel._sequence
The attribute was dropped with PR 

closes 

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-02-02 13:27:38 +00:00
wan
0222285869 [ADD] extensions: add a custom example admonition
closes 

X-original-commit: 434bb66492
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-01-28 11:20:03 +00:00
Jennafer
3d74c4584b [FW][FIX] rdtraining: use "deprecate" rather than "depreciate"
Fixed one typo - "depreciated" to "deprecated"

closes 

Forward-port-of: 
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-01-26 17:53:23 +00:00
Yajo
2c72491158 [FIX] discuss, cmdline: update for static outgoing mail addresses
This changed for Odoo 15.0 in  and the docs didn't
reflect that change.

MT-52 @moduon

closes 

X-original-commit: 084fb777f9
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-01-13 12:09:21 +00:00
Stan
194f215662 [IMP] qweb: mention the two possible syntaxes for t-attf
closes 

X-original-commit: cdb8d51131
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-01-12 09:56:04 +00:00
luvi
331b7b6285 [ADD] developer: actionswiper doc added
This commit adds the developer documentation for a
component recently added to the web_enterprise module.
It also includes examples and a screenshot used in the
documentation.

closes 

X-original-commit: 7763c22db4
Signed-off-by: Géry Debongnie <ged@odoo.com>
Signed-off-by: Luca Vitali <luvi@odoo.com>
2021-12-21 07:42:52 +00:00
Christophe Monniez
aa1c6b3f07 [IMP] install/setup: install dependencies from debian packages
This commit changes the way that Odoo python dependencies should be
installed.

Before this commit, the described way to install Odoo dependencies was
by using the `pip` utility.

Now, we explicitly recommend to use a Debian based system and install
Odoo dependencies from their packaging tool.

The main reasons are:
* Odoo productions instances are, most of the time, run on Debian based
  systems with those package already installed
* That way, a developer cannot mistakenly use a feature from a
  dependency that does not exists on those production environments
* Avoid mixes of python packages on the developer/user 's system

closes 

Signed-off-by: Castillo Jonathan (jcs) <jcs@odoo.com>
2021-12-17 12:28:55 +00:00
Julien Castiaux
e410776f24 [FIX] developer/reference/javascript_reference
The "qweb key of the manifest" file was still mentionned even if it has
been replaced by the assets bundles.

See related task: 2352566

closes 

X-original-commit: dc832e1cc8
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2021-12-17 11:37:39 +00:00
Jairo Llopis
4dc1223caf [IMP] developer/modules: deprecate 'active' and detail 'auto_install'
1. `active` is just a deprecated field that means exactly the same as
   `auto_install`.
2. `auto_install` can be a list.

See 6cb3140ea8/odoo/modules/module.py (L348-L352)

Original PR: https://github.com/odoo/documentation/pull/1109

closes 

X-original-commit: 53cb375406
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
Co-authored-by: Antoine Vandevenne (anv) <anv@odoo.com>
2021-12-16 11:00:04 +00:00
poma-odoo
c1e85cb5f0 [FW][FIX] developer/rdtraining: comply with the guidelines for report naming
The suggested folder structure does not comply with guidelines:
https://www.odoo.com/documentation/15.0/developer/misc/other/guidelines.html#file-naming

> Concerning printable reports which contain mainly data preparation and Qweb templates naming is
the following :

    addons/plant_nursery/
    |-- report/
    |   |-- plant_order_reports.xml (report actions, paperformat, ...)
    |   |-- plant_order_templates.xml (xml report templates)

closes 

Forward-port-of: 
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2021-12-16 09:43:11 +00:00
Ivan Yelizariev
2c4bfb12c2 [IMP] cmdline: add note about --dev=xml
closes 

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2021-12-16 09:33:44 +00:00
Antoine Vandevenne (anv)
915f1805fd [IMP] developer/*: replace occurrences of "access rule" by "record rule"
Both the functional and technical name of the `ir.rule` model is "Record
Rule". This commit makes sure that all occurrences of "Access Rule" are
replaced by the correct name "Record Rule" as it was easily confused
with "Access Rights".

Original PR: https://github.com/odoo/documentation/pull/1118

closes 

X-original-commit: a692dbdc9c
Signed-off-by: Victor Feyens (vfe) <vfe@odoo.com>
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2021-12-16 09:27:29 +00:00
Adrien Minne
83a3eb5648 [FIX] rdtraining: fix wrong suggested folder for views
The training suggests to put the views in the data/ folder instead of the views/ folder

closes 

X-original-commit: 9d45b861c0
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2021-12-15 08:53:05 +00:00