Commit Graph

103 Commits

Author SHA1 Message Date
Victor Feyens
87a76ebdce [FIX] developer/guidelines: do not mention deprecated xml tags
act_window & report xml tags have been deprecated by
6835aeb0de
two years ago, we should avoid mentioning them in the guidelines.

Furthermore, in 17.0 they won't be available anymore.

closes odoo/documentation#2858

X-original-commit: 758463edd4
Signed-off-by: Victor Feyens (vfe) <vfe@odoo.com>
2022-10-25 19:13:41 +02:00
Jonathan Castillo (jcs)
eae71e6eda [IMP] *: Remove "SaaS" to keep only the "Odoo Online" appellation
task-3034812

closes odoo/documentation#2833

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
Signed-off-by: Castillo Jonathan (jcs) <jcs@odoo.com>
2022-10-21 13:51:54 +02:00
Xavier-Do
4d8e3f9785 [ADD] developer/reference: add a reference page on performance
closes odoo/documentation#1180

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
Co-authored-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-10-06 11:21:48 +02:00
Max
980edde1e5 [IMP] developer/backend: correct filters attribute for calendar view fields
closes odoo/documentation#2692

Signed-off-by: Victor Feyens (vfe) <vfe@odoo.com>
2022-09-15 14:15:45 +02:00
poma-odoo
d204fe743f [FIX] developer/frontend: small typos
closes odoo/documentation#2584

Signed-off-by: Victor Feyens (vfe) <vfe@odoo.com>
2022-08-18 14:17:41 +02:00
Antoine Vandevenne (anv)
bdafd7c1bf [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.

closes odoo/documentation#2445

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-07-12 16:29:56 +02:00
Antoine Vandevenne (anv)
31a9d4a340 [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#2367

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-07-04 15:22:27 +02:00
Antoine Vandevenne (anv)
e2a3ca0631 [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#2336

X-original-commit: 7f95e9e2e0
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-06-28 18:32:10 +02:00
Antoine Vandevenne (anv)
5a7048eb0a [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#2064

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-05-20 14:10:01 +02:00
Antoine Vandevenne (anv)
17df8c547a [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#2064
2022-05-20 14:10:01 +02:00
Beshoy Nabeih
6d30d81a76 [FIX] developer/frontend: typo in the user menu registry example
closes odoo/documentation#1975

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-05-19 13:05:59 +02:00
John Kirkwood (kij)
599a137ffc [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#1545

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-05-18 12:36:48 +02:00
wan
2da1f72389 [REF] i18n/localization.rst: rework the entire localization tutorial
closes odoo/documentation#1334

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
Co-authored-by: William Andre <wan@odoo.com>
Co-authored-by: Ivan Yelizariev <iel@odoo.com>
2022-05-06 17:47:12 +02:00
Dossogne Bertrand
b4b3171237 [FIX] developer: fix duplicate action availability
The duplicate action is not available for list views

closes odoo/documentation#1856

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

closes odoo/documentation#1848

X-original-commit: 9cf425d886
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-04-22 17:42:34 +02:00
Antoine Vandevenne (anv)
7a8640d21c [IMP] developer/api/odoo: rework page to use examples and content tabs
task-2787415

X-original-commit: 1afdec3784
Part-of: odoo/documentation#1689
2022-03-11 14:45:06 +00:00
nle-odoo
3db6dc174c [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#1683

X-original-commit: b24560e224
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-03-10 15:00:00 +00:00
Demesmaeker
3c526a2bc6 [IMP] integration_testing: add information about JS touring
Adding basic information about `How to make a test tour`.

task-2742841

closes odoo/documentation#1517

X-original-commit: 827270c513
Signed-off-by: Morgane Demesmaeker <edm@odoo.com>
2022-02-02 13:51:54 +00:00
Niranjan Abhyankar
7ebbd348d8 [FIX] developer/javascript_cheatsheet: fix a typo
closes odoo/documentation#1518

X-original-commit: d9e2ab6feb
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-02-02 13:46:19 +00:00
wan
434bb66492 [ADD] extensions: add a custom example admonition
closes odoo/documentation#1503

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-01-28 11:05:14 +00:00
Stan
cdb8d51131 [IMP] qweb: mention the two possible syntaxes for t-attf
closes odoo/documentation#1454

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-01-12 09:43:14 +00:00
Julien Castiaux
dc832e1cc8 [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 odoo/documentation#1359

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2021-12-17 11:06:11 +00:00
Jairo Llopis
53cb375406 [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 odoo/documentation#1429

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:46:36 +00:00
Antoine Vandevenne (anv)
a692dbdc9c [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#1422

X-original-commit: 46cb0b8e9b
Signed-off-by: Victor Feyens (vfe) <vfe@odoo.com>
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2021-12-16 09:15:49 +00:00
Tymoteusz Motylewski
a8fe35665b [IMP] backend/testing: add link to unittest python library
closes odoo/documentation#1414

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2021-12-14 12:08:51 +00:00
Géry Debongnie
8c1003e363 [IMP] developer: small rework of assets page (frontend)
This commit applies some remarks by Antoine.

closes odoo/documentation#1327

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2021-11-19 13:24:53 +00:00
luvi
1f84bab97d [ADD] developer: scroller service added
This commit adds the documentation related to
the scroller service. This service is used for
the webclient to handle clicks on links and there
were no documentation related until now.

closes odoo/documentation#1313

Signed-off-by: Géry Debongnie (ged) <ged@openerp.com>
2021-11-19 11:36:52 +00:00
Géry Debongnie
d761910466 [IMP] developer: list content of browser object (js)
closes odoo/documentation#1310

Signed-off-by: Géry Debongnie (ged) <ged@openerp.com>
2021-11-15 09:25:07 +00:00
Bruno Boi
43d838d826 [IMP] developer: more info for usePosition JS hook
closes odoo/documentation#1305

Signed-off-by: Bruno Boi <boi@odoo.com>
2021-11-10 14:21:21 +00:00
Simon Genin (ges)
bbc85e148e [ADD] developer: add js http service
closes odoo/documentation#1293

Signed-off-by: Simon Genin (ges@odoo) <ges@odoo.com>
2021-11-09 16:56:01 +00:00
Géry Debongnie
624131f712 [IMP] developer: document formatters/parsers registries
and add entry for effects registry as well

closes odoo/documentation#1300

Signed-off-by: Géry Debongnie (ged) <ged@openerp.com>
2021-11-08 16:00:37 +00:00
Géry Debongnie
8c79319011 [IMP] developer: rewrite the page on assets
closes odoo/documentation#1299

Signed-off-by: Géry Debongnie (ged) <ged@openerp.com>
2021-11-08 15:56:49 +00:00
Géry Debongnie
11171da6b1 [IMP] developer: add section on router service
closes odoo/documentation#1292

Signed-off-by: Géry Debongnie (ged) <ged@openerp.com>
2021-11-05 14:15:36 +00:00
Géry Debongnie
d551193391 [IMP] developer: add missing links in js doc
and slightly improve effect registry page

closes odoo/documentation#1296

Signed-off-by: Géry Debongnie (ged) <ged@openerp.com>
2021-11-05 10:12:35 +00:00
Raf Geens
43193d6749 [FIX] testing: Explain "new" tagging syntax
Syntax was added to explicitly specify a module, class or function with
`--test-tags`: b729a11a12

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#1281

X-original-commit: 77dd769b08
Signed-off-by: Victor Feyens (vfe) <vfe@odoo.com>
Signed-off-by: Raf Geens <raf@odoo.com>
2021-11-05 08:57:44 +00:00
Géry Debongnie
894165a949 [IMP] developer: normalize reference in js doc
The preferred format for (frontend) references is now:
"frontend/filename/section", or something close to that.

closes odoo/documentation#1291

Signed-off-by: Géry Debongnie (ged) <ged@openerp.com>
2021-11-04 13:43:37 +00:00
Géry Debongnie
b48f0cbad8 [IMP] developer: rework section on debug mode
closes odoo/documentation#1280

Signed-off-by: Géry Debongnie (ged) <ged@openerp.com>
2021-11-03 20:01:46 +00:00
Géry Debongnie
da4dae597e [IMP] developer: add sections on pyjs and domains
closes odoo/documentation#1248

Signed-off-by: Géry Debongnie (ged) <ged@openerp.com>
2021-11-03 19:48:26 +00:00
Géry Debongnie
f206233ebc [MOV] developer: move section on patching javascript
This commit is a move, but the content was also slightly
updated/reformatted.

closes odoo/documentation#1244

Signed-off-by: Géry Debongnie (ged) <ged@openerp.com>
2021-11-03 17:48:14 +00:00
Géry Debongnie
91f97aff54 [IMP] developer: add Dropdown documentation
joint work with Bruno (boi)

closes odoo/documentation#1247

Signed-off-by: Géry Debongnie (ged) <ged@openerp.com>
2021-11-03 16:26:55 +00:00
Simon Genin (ges)
d72c3fdd8b [ADD] developer: effect service
closes odoo/documentation#1210

Signed-off-by: Simon Genin (ges@odoo) <ges@odoo.com>
2021-11-03 09:00:43 +00:00
Géry Debongnie
1e6c12be30 [IMP] developer: improve section on env
- add a link to services
- add a note that the env is quite powerful
- reformat the table with the list-table role, to make it easier to edit

closes odoo/documentation#1249

Signed-off-by: Victor Feyens (vfe) <vfe@odoo.com>
2021-11-03 08:36:04 +00:00
Géry Debongnie
4082906776 [IMP] developer: reorder and improve notification service
closes odoo/documentation#1265

Signed-off-by: Victor Feyens (vfe) <vfe@odoo.com>
2021-11-03 08:25:52 +00:00
Géry Debongnie
b4fce0a13d [IMP] developer: add section on cookie service
and slightly improve notification information

closes odoo/documentation#1241

Signed-off-by: Géry Debongnie (ged) <ged@openerp.com>
2021-11-02 19:55:52 +00:00
Géry Debongnie
f564487e56 [IMP] developer: add section on debug mode (js)
closes odoo/documentation#1250

Signed-off-by: Géry Debongnie (ged) <ged@openerp.com>
2021-11-02 19:12:36 +00:00
Géry Debongnie
ce96d6c584 [IMP] developer: use js domain for registry page
This commit update the registry documentation to use the js domain
directives instead of trying to format functions with code blocks.

I am not impressed with the way it looks, but in any cases, it is
certainly better to properly structure the documentation.

closes odoo/documentation#1245

Signed-off-by: Géry Debongnie (ged) <ged@openerp.com>
2021-11-02 14:32:57 +00:00
Géry Debongnie
a2a389688c [FIX] developer: document assets key in manifest, remove old info
This commit adds a pretty important missing piece of information: the
assets key in the manifest. At the same time, we remove two keys that
are no longer in use.

closes odoo/documentation#1251

Signed-off-by: Victor Feyens (vfe) <vfe@odoo.com>
2021-11-02 14:17:58 +00:00
Géry Debongnie
06b6c18972 [MOV] developer: move assets doc into frontend
Now that the reference is split into backend/frontend, it makes more
sense to have the assets page into the frontend section.

closes odoo/documentation#1243

Signed-off-by: Géry Debongnie (ged) <ged@openerp.com>
2021-11-02 13:42:38 +00:00
Géry Debongnie
a76e505892 [IMP] developer: rename addons/js => backend/frontend
The terminology did not really make sense for a lot of these sub pages.
This change should have been done long ago, but was probably delayed
because some people in Odoo call the web client the "backend", which is
really misleading.

This commit also renames the title "Reference Guides" to "Reference",
since this section does not contain any guides anyway.

Part-of: odoo/documentation#1243
2021-11-02 13:42:38 +00:00
Géry Debongnie
a8172fa67a [IMP] developer: add section on user menu registry (js)
closes odoo/documentation#1246

Signed-off-by: Victor Feyens (vfe) <vfe@odoo.com>
2021-11-02 11:07:54 +00:00