Commit Graph

181 Commits

Author SHA1 Message Date
Elias
e4b1f63a7d [FIX] developer/howtos/rdtraining: Update warning message
Update warning output for missing access rules.
Also reflect up-to-date contents of res.country.state.csv.

closes odoo/documentation#2824

X-original-commit: e21dbd01c9
Signed-off-by: Victor Feyens (vfe) <vfe@odoo.com>
2022-10-18 12:37:43 +02:00
Xavier-Do
745ab72b10 [ADD] developer/reference: add a reference page on performance
closes odoo/documentation#2792

X-original-commit: 4d8e3f9785
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
Signed-off-by: Xavier Dollé (xdo) <xdo@odoo.com>
Co-authored-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-10-06 12:47:51 +02:00
Aleksander
b6b8e31376 [FW][IMP] howtos/rdtraining: give the meaning of "ACL"
closes odoo/documentation#2777

Forward-port-of: odoo/documentation#2774
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-09-30 12:52:42 +02:00
Claire Bretton (clbr)
38eb13f6dd [IMP] developer/howtos/rdtraining: Add missing information about module category.
Adds explanations and directive for module category creation, so it can be used correctly at res.groups creation.

closes odoo/documentation#2728

X-original-commit: 338fe297b0
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-09-16 16:26:44 +02:00
Max
cd9fae9c97 [FW][IMP] developer/backend: correct filters attribute for calendar view fields
closes odoo/documentation#2723

Forward-port-of: odoo/documentation#2692
Signed-off-by: Victor Feyens (vfe) <vfe@odoo.com>
2022-09-15 17:28:50 +02:00
Julien Castiaux
5180b7c9dc [IMP] developer/api/external_api: XML-RPC in PHP8
Starting PHP8, the XML-RPC extension is not available by default
anymore and must be installed separately.

closes odoo/documentation#2718

Task: 2613818
X-original-commit: 79e58e3db1
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-09-14 15:18:13 +02:00
Julien Castiaux
8c4425e8c9 [IMP] content/developer/webservices
It is hard to find and learn about RPC in Odoo, users hardly know about
JSON-RPC as the only place where we talk about it in deep down in the
*How to make a Module* tutorial.

In the commit, we isolated the tutorial about RPC in a dedicated file,
that file is better referenced thanks to cross-references in some others
places that are talking about RPC

Task: 2884559
X-original-commit: 83c2e6de0b
Part-of: odoo/documentation#2718
2022-09-14 15:18:12 +02:00
std-odoo
0180e11b45 [IMP] mail: add documentation about the SSL SMTP authentication
Purpose
=======
Add the documentation about the SSL SMTP authentication
(2 new binary arguments) and also about the new from
filter binary argument.

The goal of those new arguments is to improve the score
of the emails sent by Odoo.

Task 2367946
See odoo/odoo/pull/61853
See odoo/upgrade/pull/1903

closes odoo/documentation#2705

X-original-commit: 2a01b21800
Signed-off-by: Victor Feyens (vfe) <vfe@odoo.com>
2022-09-12 15:31:56 +02:00
poma-odoo
3636f28492 [FW][FIX] developer/frontend: small typos
closes odoo/documentation#2608

Forward-port-of: odoo/documentation#2584
Signed-off-by: Victor Feyens (vfe) <vfe@odoo.com>
2022-08-18 16:45:59 +02:00
Antoine Vandevenne (anv)
128de0e545 [IMP] rdtraining: mention that the second part needs to be completed too
closes odoo/documentation#2539

X-original-commit: 9279fb80a7
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-08-01 16:39:18 +02:00
Victor Feyens
0fc36c18e4 [CLN] rdtraining: remove reference to unexisting file
The referenced `bypass.py` file isn't specified anywhere in
the training documentation or code content.

The paragraph is removed to avoid meaningless searches and
confusing trainees.

This commit also adds a missing parenthese in the preceding
code content.

Fixes #2488

closes odoo/documentation#2521

X-original-commit: 1c4abe4e07
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-07-25 14:13:55 +02:00
Benoit Socias
78945bf22e [IMP] rdtraining: update float utils information
The warning about float utils does not state where to find them, and
they are preceded by an example in the code that infringes the warning's
recommendation.

This commit indicates where to find the float utils and replaces the
example by one that uses them.

task-2925402

closes odoo/documentation#2511

X-original-commit: b8ee134a28
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-07-20 13:36:49 +02:00
Victor Feyens
2ed6704b88 [FIX] accounting_localization: use relative paths in csv-table's option
The `file` option for the `csv-table` directive expects relative file
paths rather than absolute file paths since Sphinx 4. Since this was the
only usage of the `ODOO_ABSPATH` placeholder, it is removed with this
commit.

Task - 2898477

closes odoo/documentation#2483

X-original-commit: 60adfacbc9
Signed-off-by: Victor Feyens (vfe) <vfe@odoo.com>
2022-07-14 22:21:58 +02:00
Antoine Vandevenne (anv)
291a3db45c [IMP] developer/rdtraining: simplify the development environment setup
In an attempt to help new developers install Odoo with a
straightforward procedure, Chapter 2 of the "Getting started" tutorial
included copy-pastes of parts of the "Installing Odoo" page. This proved
to be inefficient because it required maintaining documentation on the
installation procedure in several places and misled the readers by
suggesting installing the Python requirements *after* installing
PostgreSQL.

With this commit, the page on Chapter 2 is refreshed to be clearer to
the readers and redirect them to the "Installing Odoo" page when
necessary.

task-2908434

closes odoo/documentation#2460

X-original-commit: f75cbca98c
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-07-13 16:48:00 +02:00
Antoine Vandevenne (anv)
88fa15e327 [MOV] developer/reference: move up the standard_modules directory
With the renaming of the "Backend" and "Frontend" directories to "Python
framework" and "JavaScript framework", and since we may want to document
modules that mainly rely on JavaScript, it makes sense to move the
"Standard modules" one level up from under "Python framework" directly
under "Reference".

closes odoo/documentation#2457

X-original-commit: 62e80093bd
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-07-13 16:47:58 +02:00
Antoine Vandevenne (anv)
db835469a1 [IMP] developer: rename reference directories to "Py/Js framework"
It was confusing to label the directory for pages related to the Python
framework "Backend" as, in Odoo, the backend is the web client, and the
frontend is the portal/website. It also led to the "Standard modules"
directory to be placed within the "Backend" directory as of `saas-15.1`
to indicate that they were part of the backend too, but that was a
mistake. Indeed, most standard modules comprise JavaScript methods, and
we could want to document these in the reference at some point.

X-original-commit: 8046f742bc
Part-of: odoo/documentation#2457
2022-07-13 16:47:57 +02:00
Antoine Vandevenne (anv)
f30e84c92a [IMP] developer/javascript: unify the styling of API references
Now that a new styling for API references was added with commit 934f45c,
we can remove the extra CSS that was crafted specifically for JavaScript
API references with commit 05a0a49a. While we're at it, this commit also
applies the new styling to definition lists that were missing it, like
it was done for the page on views with commit 120ae785.

closes odoo/documentation#2376

X-original-commit: 31a9d4a340
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-07-04 18:11:03 +02:00
Antoine Vandevenne (anv)
12ff9f118b [MOV] developer/misc: move all pages to a more logical location
Before this commit, the "Developer/Misc" directory of the doc, and
more particularly the "Developer/Misc/Other" sub-directory, was used as
a garbage dump where we moved all the pages that didn't fit elsewhere.
Due to that, interesting and important pages, such as the Coding
Guidelines, were buried in that directory never to be read again by Odoo
developers.

This commit moves most pages under "Misc" one or two levels up to be
located directly under "Developer" hence making them more accessible. A
new "Contributing/Development" directory is added to host the Coding
Guidelines page and soon many other pages.

task-2897143

closes odoo/documentation#2371

X-original-commit: 109817311e
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-07-04 16:18:16 +02:00
Antoine Vandevenne (anv)
8aeee6c1c6 [IMP] developer/views: apply the new API references style
The documentation of view attributes was lacking visual structure to
help the reader figure out which attribute relates to which parent
element. Since this documentation was relying on RST block quotes to
represent the hierarchy of view attributes, we can apply the same new
styling that was added with commit 934f45cf and designed for autodoc,
and which relies on the exact same HTML structure as block quotes.

task-2755298

closes odoo/documentation#2340

X-original-commit: e2a3ca0631
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-06-29 09:14:52 +02:00
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 odoo/documentation#2302

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 odoo/documentation#2185

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 odoo/documentation#2067

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 odoo/documentation#903, 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: odoo/documentation#2067
2022-05-20 14:44:52 +02:00
Beshoy Nabeih
a572e055a8 [FIX] developer/frontend: typo in the user menu registry example
closes odoo/documentation#2038

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 odoo/documentation#2035

Forward-port-of: odoo/documentation#2023
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 odoo/documentation#2015

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 odoo/documentation#1968

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 odoo/documentation#1930

Forward-port-of: odoo/documentation#1923
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 odoo/documentation#1879

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 odoo/documentation#1866

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 odoo/documentation#1859

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 odoo/documentation#1852

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 odoo/documentation#1830

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: odoo/documentation#1830
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 odoo/documentation#1823

Forward-port-of: odoo/documentation#1816
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 odoo/documentation#1791

Related: odoo/odoo#87949
Related: odoo/design-themes#558
Related: odoo/enterprise#25888
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 odoo/documentation#1741

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 odoo/documentation#1734

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 odoo/documentation#1598

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 odoo/documentation#1676

closes odoo/documentation#1727

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 odoo/documentation#1709

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 odoo/documentation#1699

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 odoo/documentation#1692

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: odoo/documentation#1692
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 odoo/documentation#1686

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 odoo/documentation#1529

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 odoo/documentation#1640

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 odoo/documentation#1508

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 odoo/documentation#1572

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 odoo/documentation#1557

Signed-off-by: Victor Feyens (vfe) <vfe@odoo.com>
2022-02-10 13:22:39 +00:00