Commit Graph

184 Commits

Author SHA1 Message Date
Denis Ledoux
68cb95ee91 [FIX] qweb: type "overrinding"
overrinding -> overriding

closes odoo/documentation#6051

X-original-commit: d141144be5
Signed-off-by: Victor Feyens (vfe) <vfe@odoo.com>
2023-10-06 18:20:48 +00:00
Louis Baudoux
0d7e6cb0b8 [FIX] extract_api: remove bill_reference from expense fields
The bill reference is no longer detected since a few months because it
had poor results and wasn't very useful.

closes odoo/documentation#6004

X-original-commit: cade61dd56
Signed-off-by: Louis Baudoux (lba) <lba@odoo.com>
2023-10-05 14:14:56 +00:00
Louis Baudoux
0404cce0ba [REM] extract_api: remove documentation of get_result_batch
For security reasons, we had to drop the support of those routes.

X-original-commit: 24c7b2506e
Part-of: odoo/documentation#6004
2023-10-05 14:14:56 +00:00
Leloup Loïc (lole)
247b3dcf69 [IMP] cli: add unit to memory options
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.

closes odoo/documentation#5790

X-original-commit: 9fadc3355d
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2023-09-11 08:55:49 +00:00
Xavier (XPL)
7da1a48184 [REF] install: move intro to main install page and split by install type
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

closes odoo/documentation#5537

X-original-commit: da2a48b9fd
Signed-off-by: Xavier Platteau (xpl) <xpl@odoo.com>
2023-08-18 11:10:05 +02:00
imanie383
dfa9234eed [FW][FIX] reference/owl_components: fix typo
Making edits for Owl Components Doc : [Link](https://www.odoo.com/documentation/16.0/developer/reference/frontend/owl_components.html#example-multi-level-dropdown-nested)

![image](https://github.com/odoo/documentation/assets/35231827/b2dd4b87-941c-4241-b0f5-e91ca69b3633)

closes odoo/documentation#5469

Forward-port-of: odoo/documentation#5459
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2023-08-11 19:00:48 +02:00
Levi Siuzdak (sile)
eab4bb492b [IMP] developer: add notes on entity references & fix illegal XML
Using `<` inside XML elements will result in a parsing error,
an entity reference should be used instead: `&lt;`.

closes odoo/documentation#5180

X-original-commit: a7743d513b
Signed-off-by: Levi Siuzdak (sile) <sile@odoo.com>
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2023-07-24 18:18:01 +02:00
Henrique Dias
83aaa84f4c [FW][ADD] rpc: Go examples
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.

closes odoo/documentation#5126

Forward-port-of: odoo/documentation#5064
Signed-off-by: Xavier Morel (xmo) <xmo@odoo.com>
2023-07-14 12:12:50 +02:00
Marc Durepos
ca2cf223ff [FIX] Remove reference to assets_qweb in assets.rst
Reflects the fact that assets_qweb bundle is no longer used in 16.0

closes odoo/documentation#5105

X-original-commit: c85031b3fc
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2023-07-13 17:13:59 +02:00
Benoit Socias
62d8f8bff5 [IMP] developer/views: add optional attribute for fields of list views
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

closes odoo/documentation#4906

X-original-commit: 5a446f5c59
Signed-off-by: Benoit Socias (bso) <bso@odoo.com>
2023-06-27 14:52:21 +02:00
Christophe Monniez
5eaf854e7f [FIX] deploy: reference the config parameter
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.

closes odoo/documentation#4805

X-original-commit: 8aed7988ba
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
Signed-off-by: Christophe Monniez (moc) <moc@odoo.com>
2023-06-20 17:17:51 +02:00
Antoine Vandevenne (anv)
f868d98593 [FIX] reference/services: mark optional the params parameter of rpc
closes odoo/documentation#4280

X-original-commit: c1b38dc1f3
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2023-04-27 19:55:11 +02:00
Artygo8
a3b3d254f7 [IMP] reference/extract: update documentation
task-3071317

closes odoo/documentation#4222

X-original-commit: 07eef81a95
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
Signed-off-by: Arthur Gossuin (goa) <goa@odoo.com>
2023-04-21 16:16:16 +02:00
Tiffany Chang (tic)
04fff2b41f [REM] developer: remove references to web_dashboard view
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
X-original-commit: e2c880aafe
Part-of: odoo/documentation#4033
2023-04-05 16:46:41 +02:00
fdardenne
79af1733d8 [IMP] create JavaScript howtos
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.

closes odoo/documentation#4016

X-original-commit: 7e4435deb8
Signed-off-by: Dardenne Florent (dafl) <dafl@odoo.com>
2023-04-05 11:17:00 +02:00
Antoine Vandevenne (anv)
a6cb76f2ad [MOV] developer/cli: move "Command-line interface (CLI)" to the reference dir
task-2991663

closes odoo/documentation#3659

X-original-commit: 3dc6bb83c1
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2023-02-23 16:23:23 +01:00
Antoine Vandevenne (anv)
7ae53723af [MOV] developer/api/extract_api: move "Extract API" to the reference dir
task-2991663

X-original-commit: 73f976e679
Part-of: odoo/documentation#3659
2023-02-23 16:23:23 +01:00
Antoine Vandevenne (anv)
cb473f6848 [MOV] developer/api/external_api: move "External API" to the reference dir
task-2991663

X-original-commit: 95ed856446
Part-of: odoo/documentation#3659
2023-02-23 16:23:22 +01:00
luvi
9414d77276 [ADD] web: add core components documentation
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.

closes odoo/documentation#3585

X-original-commit: 7a9d807bcc
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
Signed-off-by: Luca Vitali <luvi@odoo.com>
2023-02-15 15:48:36 +01:00
Jonathan Castillo (jcs)
7ae76bad42 [FIX] *: RST cleanup
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.

closes odoo/documentation#3584

Signed-off-by: Castillo Jonathan (jcs) <jcs@odoo.com>
2023-02-15 14:38:43 +01:00
luvi
4a220d61fe [ADD] web: add SelectMenu documentation
This commit adds the documentation for the SelectMenu component, introduced
in saas-16.1. This documentation gives some example of its usage.

An image is also added, to better illustrate the grouping functionality.

closes odoo/documentation#3573

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2023-02-14 15:41:58 +01:00
luvi
1239eb767a [FIX] web: fix wrong ActionSwiper documentation
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.

closes odoo/documentation#3506

X-original-commit: fc79df42fd
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2023-02-08 16:51:37 +01:00
Mahmoud Metwally
d1e5eaae3a [FW][FIX] developer/javascript_reference: typos and phrasing
closes odoo/documentation#3475

Forward-port-of: odoo/documentation#3470
Signed-off-by: Victor Feyens (vfe) <vfe@odoo.com>
2023-02-02 20:26:13 +01:00
Xavier BOL (xbo)
7e1eabfddb [IMP] backend: add groups_draggable option in kanban view
Related PR: odoo/odoo#97447

task-2941335

closes odoo/documentation#3335

X-original-commit: f51633fdd5
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
Signed-off-by: Xavier Bol (xbo) <xbo@odoo.com>
2023-01-16 19:32:47 +01:00
stefanorigano (SRI)
9571a32131 [IMP] scss: update, improve preexisting content
Add a new content focused on SCSS and user-interface.

- SCSS coding guidelines: regroup information already available (eg [1])
  or based on "oral tradition".
  The aim is not to establish new rules, ~99% of the current codebase
  is already compliant.

- SCSS inheritance: explain how SCSS assets management works in odoo.
  For example, people still find confusing that overrides are defined
  *before* the variable to customize.

- SCSS optimization tips: suggestions to lean SCSS code. Based on SCSS
  optimization task's know-how [2].

- CSS variables: explain how this feature is commonly used in odoo to
  adapt layout & design without raw CSS overrides.

- UI Icons: Add link to fontAwesome4 library . Replace the picture of
  odoo icons with the actual font (90kb image VS 15Kb font)

[1] https://github.com/odoo/odoo/wiki/SCSS-coding-guidelines
[2] https://www.odoo.com/web#id=2704984&menu_id=4720&cids=1&model=project.task&view_type=form

task-3090800

closes odoo/documentation#3327

X-original-commit: 2ca32b40bc
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2023-01-13 17:33:02 +01:00
fdardenne
8a30786495 [IMP] developer: JavaScript tutorial: chapter 3-7
This commit adds the chapter 3,4,5,6 and 7 of the JavaScript web
framework tutorial.

This new tutorial allows people to discover Owl and the building blocks
of the Odoo JavaScript framework.

closes odoo/documentation#3325

X-original-commit: 54628b4f5b
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
Co-authored-by: Géry Debongnie <ged@odoo.com>
Co-authored-by: Antoine Vandevenne (anv) <anv@odoo.com>
2023-01-12 19:08:49 +01:00
Horacio Tellez
d8c9f6afa4 [FIX] developer: typo on a code example in the framework overview
There was a variable being used that was undeclared.

closes odoo/documentation#3316

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2023-01-11 15:39:02 +01:00
Xavier BOL (xbo)
b909a21d1f [IMP] backend: add default_group_by option in list view
Related PR: odoo/odoo#109281

task-3084850

closes odoo/documentation#3311

Related: odoo/enterprise#35504
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2023-01-10 15:43:05 +01:00
luvi
ad6cde3181 [IMP] web: update usePosition API
This commit updates the documentation of the position hook, to add
the latest variant "fit". This variant was introduced recently in
commit (1), when using it in the SelectMenu component.

(1): c21c415f38

closes odoo/documentation#3261

Signed-off-by: Luca Vitali <luvi@odoo.com>
2023-01-09 12:22:44 +01:00
luvi
bca9ac151f [ADD] web: add useSpellCheck hook documentation
This commit brings the documentation for the useSpellCheck hook,
introduced in commit (1). The documentation contains some example
and details on how to use the hook properly.

(1): 130719e584

Part-of: odoo/documentation#3261
2023-01-09 12:22:44 +01:00
Jorge Pinna Puissant
68a35753c6 [IMP] * : kanban, unify dropdown definition in archs
This commit add the documentation for the new 'kanban-menu' template
(the ellipsis dropdown menu).

No that, this commit add also the documentation for the 'kanban-tooltip'
template.

closes odoo/documentation#3284

Task-id: 3096776
Related: odoo/odoo#107589
Related: odoo/enterprise#34962
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2023-01-05 15:37:07 +01:00
Mahmoud Metwally
1a95d1cd6f Update qweb.rst
closes odoo/documentation#3289

X-original-commit: 8cde1f7b74
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2023-01-04 15:48:18 +01:00
FrancoisGe
e045da51b3 [IMP] web: adds the header to the list view
This commit adds the documentation related to the <header> tag to the list view.

closes odoo/documentation#3044

Related: odoo/odoo#106519
Related: odoo/enterprise#34387
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-12-16 18:40:01 +01:00
Valentin Vallaeys (vava)
2ce56e4fb1 [FIX] developer: better definition for oe_inline
closes odoo/documentation#3173

X-original-commit: b2d0ab29a5
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-12-09 21:01:00 +01:00
Antoine Vandevenne (anv)
b3a1f27461 [IMP] conf.py, *: interpolate the version and releases in the content
This commit replaces hard-coded occurrences of the version and of the
last, current and next releases' version with placeholders interpolated
at build time to avoid manually updating these after each freeze.

task-2917614

closes odoo/documentation#3170

X-original-commit: fa2d0f6363
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-12-09 13:03:46 +01:00
Jorge Pinna Puissant
d0ae1cbce0 [IMP] views: setting view
This commit, add the documentation of the new DSL created exclusively
for the settings.

closes odoo/documentation#3092

Task-id: 3081367
Signed-off-by: Jorge Pinna Puissant (jpp) <jpp@odoo.com>
2022-12-07 11:49:50 +01:00
Victor Feyens
2d1361c026 [FIX] developer/*: code blocks linting & fixes
invalid xml
invalid python
correct indentation

closes odoo/documentation#3029

X-original-commit: b2121b7891
Signed-off-by: Victor Feyens (vfe) <vfe@odoo.com>
2022-11-25 10:52:04 +01:00
Victor Feyens
2b75fb4bbb [FIX] developer/*: consistent code-block language specification
X-original-commit: 387cf15e7f
Part-of: odoo/documentation#3029
2022-11-25 10:52:04 +01:00
Ivan Kropotkin
6c7ee83bc4 [FW][FIX] developer/reference: code example
closes odoo/documentation#3028

Forward-port-of: odoo/documentation#2943
Signed-off-by: Victor Feyens (vfe) <vfe@odoo.com>
2022-11-24 19:25:27 +01:00
Victor Feyens
17fa2e0333 [FIX] developer/mobile: use spaces and not tabs for indentation
closes odoo/documentation#2984

Signed-off-by: Victor Feyens (vfe) <vfe@odoo.com>
2022-11-18 18:04:50 +01:00
Victor Feyens
197dbea3d2 [FIX] *: unbalanced literal markups
Part-of: odoo/documentation#2984
2022-11-18 18:04:50 +01:00
Victor Feyens
c2f8d4bd44 [FIX] *: remove trailing whitespaces
Part-of: odoo/documentation#2984
2022-11-18 18:04:50 +01:00
Victor Feyens
c60bc5f919 [FIX] *: enforce 1 newline on files end
Part-of: odoo/documentation#2984
2022-11-18 18:04:49 +01:00
Chong Wang (cwg)
d4923d6350 [IMP] orm/changelog: store translations in jsonb
closes odoo/documentation#2901

X-original-commit: f2fd03b8fc
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-11-03 16:43:31 +01:00
Xavier Morel
18c2c74848 [REM] reference: long deprecated SavepointCase
closes odoo/documentation#2844

Related: odoo/enterprise#33244
Related: odoo/odoo#98138
Signed-off-by: Victor Feyens (vfe) <vfe@odoo.com>
2022-10-26 19:03:50 +02:00
Victor Feyens
ac813f2b5b [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#2862

X-original-commit: 758463edd4
Signed-off-by: Victor Feyens (vfe) <vfe@odoo.com>
2022-10-25 21:20:53 +02:00
niyasraphy
894e1be9c6 [IMP] report_barcode function: parameter type to barcode_type
ee324e8374

closes odoo/documentation#2847

X-original-commit: 3f34c3874c
Signed-off-by: Victor Feyens (vfe) <vfe@odoo.com>
2022-10-24 18:59:30 +02:00
Jonathan Castillo (jcs)
ab1a7d0a69 [IMP] *: Remove "SaaS" to keep only the "Odoo Online" appellation
task-3034812

closes odoo/documentation#2839

X-original-commit: 9b69e0d77e
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
Signed-off-by: Castillo Jonathan (jcs) <jcs@odoo.com>
2022-10-21 20:00:56 +02:00
Xavier Morel
219a7cc82f [ADD] reference/orm: grouped method
closes odoo/documentation#2783

Related: odoo/odoo#101522
Signed-off-by: Victor Feyens (vfe) <vfe@odoo.com>
2022-10-21 13:06:06 +02:00
Victor Feyens
9a5b5b0614 [FIX] *: Odoo 16 requires postgresql 12
Update the minimal version in the installation doc
Make all postgresql docs references target the v12 documentation
Fix some non http links on the way

closes odoo/documentation#2822

X-original-commit: 93b383e95d
Signed-off-by: Victor Feyens (vfe) <vfe@odoo.com>
2022-10-18 12:19:30 +02:00