Commit Graph

65 Commits

Author SHA1 Message Date
Valentin Chevalier 96d822bf87 [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#2286

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-06-24 17:47:24 +02:00
Julien Castiaux 3d2f067e6c [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#2181

Signed-off-by: Victor Feyens (vfe) <vfe@odoo.com>
2022-06-10 16:56:54 +02:00
Antoine Vandevenne (anv) 0fc521886f [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#2026

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-05-20 14:03:48 +02:00
Antoine Vandevenne (anv) 91c20a2c03 [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#2026
2022-05-20 14:03:47 +02:00
Altela Eleviansyah Pramardhika b883c3c99c [FW][FIX] developer/howtos: Fixed typo from field to fields
closes odoo/documentation#2028

Forward-port-of: odoo/documentation#2023
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-05-19 14:23:47 +02:00
Altela Eleviansyah Pramardhika da0a76e8ca [FW][FIX] developer/howtos: missing parentheses in print statement
Added parentheses in a print function

closes odoo/documentation#1926

Forward-port-of: odoo/documentation#1923
Signed-off-by: Victor Feyens (vfe) <vfe@odoo.com>
2022-05-06 11:08:50 +02:00
Antoine Vandevenne (anv) f8f5ed93e1 [FIX] developer/rdtraining: fix typos
closes odoo/documentation#1862

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-04-25 12:07:45 +02:00
Dossogne Bertrand 19eddfdd3f [FIX] developer: fix duplicate action availability
The duplicate action is not available for list views

closes odoo/documentation#1855

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

closes odoo/documentation#1847

X-original-commit: 9cf425d886
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-04-22 18:11:24 +02:00
Benoit Socias 5a39ba7d24 [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#1826

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-04-13 12:52:44 +02:00
Benoit Socias 2ebb7fe802 [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

Part-of: odoo/documentation#1826
2022-04-13 12:52:43 +02:00
Altela Eleviansyah Pramardhika d78e1ecb59 [FIX] developer/rdtraining: fix typo
Fixed `name = field.Char(required=True)` to
`name = fields.Char(required=True)`.

closes odoo/documentation#1816

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-04-11 09:59:11 +02:00
0b11001111 112b6c1267 [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#1710

Signed-off-by: Martin Trigaux (mat) <mat@odoo.com>
2022-03-18 15:09:10 +01:00
bve-odoo c90d977653 [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#1705

X-original-commit: 7ce175ff55
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-03-17 11:48:56 +01:00
Antoine Vandevenne (anv) c123d0b978 [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#1695

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

closes odoo/documentation#1688

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-03-11 14:14:17 +00:00
Antoine Vandevenne (anv) 1afdec3784 [IMP] developer/api/odoo: rework page to use examples and content tabs
task-2787415

Part-of: odoo/documentation#1688
2022-03-11 14:14:17 +00:00
nle-odoo beda3f95ff [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#1682

X-original-commit: b24560e224
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-03-10 15:00:05 +00:00
Demesmaeker a52f601bfb [FIX] integration_testing: fix wrong step utils used in tour
closes odoo/documentation#1519

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-02-02 13:29:46 +00:00
Niranjan Abhyankar d9e2ab6feb [FIX] developer/javascript_cheatsheet: fix a typo
closes odoo/documentation#1226

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-02-02 13:09:52 +00:00
Demesmaeker 827270c513 [IMP] integration_testing: add information about JS touring
Adding basic information about `How to make a test tour`.

task-2742841

closes odoo/documentation#1516

X-original-commit: f6c1723fe0
Signed-off-by: Morgane Demesmaeker <edm@odoo.com>
2022-02-02 12:01:37 +00:00
wan 2bf697bda4 [ADD] extensions: add a custom example admonition
closes odoo/documentation#1501

X-original-commit: acda12669d
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-01-28 10:42:56 +00:00
Jairo Llopis 6a995b48ff [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 https://github.com/odoo/odoo/blob/6cb3140ea8f62a265b76ae494295f466ca6a00c4/odoo/modules/module.py#L348-L352

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

closes odoo/documentation#1428

X-original-commit: 03a54e5b37
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
Co-authored-by: Antoine Vandevenne (anv) <anv@odoo.com>
2021-12-16 10:43:09 +00:00
Antoine Vandevenne (anv) 46cb0b8e9b [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 odoo/documentation#1421

Signed-off-by: Victor Feyens (vfe) <vfe@odoo.com>
2021-12-15 13:08:40 +00:00
Chris Parker c9d538082a [FIX] api/odoo: reflect the correct location of menu actions
closes odoo/documentation#1410

X-original-commit: beb92c9f18
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2021-12-14 12:08:55 +00:00
Raf Geens 77dd769b08 [FIX] testing: Explain "new" tagging syntax
Syntax was added to explicitly specify a module, class or function with
`--test-tags`: https://github.com/odoo/odoo/commit/b729a11a121e53857063be00308904ed4d8dd2a0

The documentation was not updated to reflect this, leading to confusion
as people tried to reconcile the documentation with the actual behavior,
without necessarily having seen `odoo-bin --help` which is explicit
about it.

closes odoo/documentation#1279

X-original-commit: 23d0a7a062
Signed-off-by: Victor Feyens (vfe) <vfe@odoo.com>
2021-11-03 15:04:43 +00:00
Julien Van Roy da0eeed38f [FIX] developer/reference: fix missing slash in javascript/qweb, debugging section
closes odoo/documentation#1213

X-original-commit: 7fbf1c3ef2
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2021-10-22 13:15:10 +00:00
Antoine Vandevenne (anv) 59df6b90ae [FIX] extract_api: bring back extract_api doc lost with be1653cc
closes odoo/documentation#1197

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2021-10-19 11:20:35 +00:00
Donatienne Pirlot (dopi) fbb03fce4f [REM] developer/upgrade: remove outdated page
task-2613841

closes odoo/documentation#1081

X-original-commit: eee063a8b1
Signed-off-by: Antoine Vandevenne (anv) <AntoineVDV@users.noreply.github.com>
2021-08-03 14:26:29 +00:00
AdrienPr 28359b6bd6 [FIX] dev/howtos/themes: correct wrong code example
Since the update of the themes tutorial, the id of the snippet template was modified
but this part of the tutorial wasn't updated accordingly.

This commit updates the referenced template id to make sure the tutorial works
as expected.

Finetuning of https://github.com/odoo/odoo/commit/08d44d444490713ca39618a67f441bbd84b8b900
2021-07-22 14:43:16 +02:00
Antoine Vandevenne (anv) 6594686062 [MERGE] Forward-port of branch 13.0 to 14.0 2021-07-20 12:55:24 +02:00
Valentin Chevalier d30cb941c5 [IMP] guidelines: remove a deprecated tag
The 'oldname' tag has been deprecated for a few years
2021-07-09 10:51:13 +02:00
Antoine Vandevenne (anv) be1653cc51 [MERGE] Forward-port of branch 13.0 to 14.0 2021-07-07 15:39:35 +02:00
Fabien Pinckaers 16418c020b [IMP] *: introduce tables of contents in top-level app pages 2021-07-07 14:56:38 +02:00
Ivan Yelizariev 5b59088a71 [IMP] rdtraining: no need to add web to dependencies
`web` is not used directly and is installed automatically anyway.
Having both `web` and `base` looks excessively, so coaches usually ask to delete
`base`. But more correct solution is adding `base` only. Completly skipping
dependencies is not good either -- see https://github.com/odoo/documentation/commit/76e05ccfb8413966d44f81a74da51d049f0a3996
2021-06-21 15:00:35 +02:00
Antoine Vandevenne (anv) b30f28a3c4 [MERGE] Forward-port of branch 13.0 to 14.0 2021-06-09 12:22:50 +02:00
Antoine Vandevenne (anv) 251438d569 [MERGE] Forward-port of branch 12.0 to 13.0 2021-06-09 12:10:06 +02:00
Antoine Vandevenne (anv) 1d3375f1a8 [IMP] *: exclude empty TOC pages from search results
When searching for a string that can be found in a TOC page's content,
that page is listed in the search results. This is not a wanted behavior
because TOC pages without the 'show-content' metadata directive are not
supposed to be accessible.

This commit adds a 'nosearch' metadata directive to all TOC pages
without a 'show-content' metadata directive, hence removing them from
search results.

task-2527419
2021-06-09 11:55:34 +02:00
Victor Feyens 7c3106e95c [IMP] dev/howtos: hide deprecated and outdated tutorial
Now that the new rd&training is deployed, we shouldn't highlight this page anymore

Fixes #1017
2021-06-09 11:45:39 +02:00
Gabo 525d05e068 [FIX] developer/howtos: wizard example 2021-06-09 10:14:17 +02:00
Ivan Yelizariev 8b201ca924 [IMP] developer/*: clarify --test-tags
Corresponding PRs to odoo/odoo:

https://github.com/odoo/odoo/pull/71130
https://github.com/odoo/odoo/pull/71331

---

task-2431630
2021-06-07 09:39:06 +02:00
Ivan Yelizariev // IEL b33ce0a6ca [FIX] dev: remove confusing phrase "US states"
the file contains other countries states too
2021-06-03 17:52:53 +02:00
Victor Feyens a1e7024fa0 [MERGE] Forward-port of branch 13.0 to 14.0 2021-05-31 15:16:09 +02:00
Victor Feyens 40afc9d9f0 [MERGE] Forward-port of branch 12.0 to 13.0 2021-05-31 14:54:23 +02:00
Victor Feyens e96bc804d3 [FIX] content/developer/*: typos
Found with codespell
2021-05-31 14:44:18 +02:00
Bruno Boi dee28c59a1 [IMP] developer/reference: add a gantt view option
new option: disable_drag_drop
2021-05-28 15:56:49 +02:00
Ivan Yelizariev 76e05ccfb8 [IMP] manifest: add note about 'base' module in depends 2021-05-28 12:49:27 +02:00
Ivan Yelizariev 90b848eb45 [REM] dev guidelines: remove obsolete requirements from python 2 2021-05-26 13:11:06 +02:00
Victor Feyens e11f010783 [IMP] developer/orm: add tip on related field dependencies 2021-05-26 10:52:37 +02:00
Ivan Yelizariev 4d0f63e3eb [FIX] developer/orm: related fields default values
* readonly is True for related fields.

Since Odoo 12: https://github.com/odoo/odoo/commit/52a8ed3c0c72b21baf589bc9b91a030d9da661a8

This commit also highlights all the default values of related fields, fixing
the misleading message about related computed in sudo mode (since it can
be disabled with compute_sudo or related_sudo = False)

---

task-2451749
2021-05-26 10:52:37 +02:00