Commit Graph

269 Commits

Author SHA1 Message Date
Mahmoud Metwally
6398a0248c [FW][FIX] howtos/company: fix typos
closes odoo/documentation#4179

Forward-port-of: odoo/documentation#4147
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2023-04-17 17:40:37 +02:00
Mahmoud Metwally
f5850af1a1 [FW][FIX] developer/web_services: fix typo
closes odoo/documentation#4158

Forward-port-of: odoo/documentation#4146
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2023-04-14 11:36:15 +02:00
Tiffany Chang (tic)
def1f89786 [REF] developer: rewrite sql view as a howto
SQL view was formerly part of the dashboard tutorial which is now
obsolete. Since creating a SQL view as a tutorial does not make sense
anymore, it has been converted into a simple howto.

closes odoo/documentation#4033

Task: 3226581
X-original-commit: 7124542ed9
Signed-off-by: Tiffany Chang <tic@odoo.com>
2023-04-05 16:46:41 +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
Benoit Socias
269ac1e7e0 [IMP] tutorials: add warning about mutable global variables
The whole concept of multi-tenancy is not really approached within the
tutorial.

This commit adds a warning about never using mutable global variables
within odoo to seed the idea in the reader's mind.

task-3059110

closes odoo/documentation#3989

X-original-commit: 1ce7166f49
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
Signed-off-by: Benoit Socias (bso) <bso@odoo.com>
2023-04-03 13:50:07 +02:00
Jonathan Castillo (jcs)
70ab16d22c [FIX] dev/tuto: grammar mistake in 02_setup
task-3238089

closes odoo/documentation#3847

X-original-commit: 6866cfa361
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
Signed-off-by: Castillo Jonathan (jcs) <jcs@odoo.com>
2023-03-20 15:56:42 +01:00
Antoine Vandevenne (anv)
8c0dbd57db [ADD] extensions/cards: add an extension to implement cards
The extension adds two new directive:
- `cards` is the row container for one or more `card` directives.
- `card` is the implementation of a Bootstrap card that accepts a
  `target` argument for the href of the card, a `large` option to render
  the card on two columns, a `tag` option to display a single arbitrary
  tag on the card, and arbitrary content that is shown in the card
  body.

task-3141419

closes odoo/documentation#3688

X-original-commit: 34bc63d2bc
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2023-02-28 19:04:42 +01: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
Antoine Vandevenne (anv)
eef59aa120 [MOV] developer/api/iap: move "In-App Purchase" to the howtos dir
task-2991663

X-original-commit: b817e16a4c
Part-of: odoo/documentation#3659
2023-02-23 16:23:22 +01:00
Antoine Vandevenne (anv)
8c32e86971 [MOV] developer/iot: move "Internet of things" the howtos dir
task-2991663

X-original-commit: 2701d91db0
Part-of: odoo/documentation#3659
2023-02-23 16:23:22 +01:00
Antoine Vandevenne (anv)
05d870b7b7 [IMP] tutorials/*: hide outdated tutorials
*: backend, web, website

task-2991663

X-original-commit: 9561c9abf8
Part-of: odoo/documentation#3659
2023-02-23 16:23:21 +01:00
Antoine Vandevenne (anv)
7248a22796 [MOV] howto/web: move "Customizing the webclient" to the tutorials dir
task-2991663

X-original-commit: 2d469bccbc
Part-of: odoo/documentation#3659
2023-02-23 16:23:21 +01:00
Antoine Vandevenne (anv)
72856d10ac [MOV] howto/website: move "Building a website" to the tutorials dir
task-2991663

X-original-commit: 58f2174c49
Part-of: odoo/documentation#3659
2023-02-23 16:23:21 +01:00
Antoine Vandevenne (anv)
279ce8acdd [MOV] howtos/backend: move "Building a module" to the tutorials dir
task-2991663

X-original-commit: 642c4839f7
Part-of: odoo/documentation#3659
2023-02-23 16:23:21 +01:00
Antoine Vandevenne (anv)
8aa734e7c2 [MOV] howtos/discover_js_framework/*: move "Discover the JS Framework" to the tutorials dir
task-2991663

X-original-commit: 9c5ea316ff
Part-of: odoo/documentation#3659
2023-02-23 16:23:20 +01:00
Antoine Vandevenne (anv)
d21774e4f4 [MOV] tutorials/getting_started/*: promote advanced chapters to independent tutorials
task-2991663

X-original-commit: a8c78a80ba
Part-of: odoo/documentation#3659
2023-02-23 16:23:20 +01:00
Antoine Vandevenne (anv)
953ae02e49 [MOV] howto/rdtraining: move "Getting started" to the tutorials dir
This commit also replaces references to the "Building a module"
tutorial by references to the "Getting started" tutorial.

task-2991663

X-original-commit: 4f4e346953
Part-of: odoo/documentation#3659
2023-02-23 16:23:20 +01:00
Antoine Vandevenne (anv)
a7797bcb55 [ADD] developer/tutorials: add a directory for developer tutorials
task-2991663

X-original-commit: 73ce4d6cd8
Part-of: odoo/documentation#3659
2023-02-23 16:23:20 +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
Amelia Williams
23dacbb122 [FIX] 02_setup: remove gramatical error
closes odoo/documentation#3582

X-original-commit: 18b000602b
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2023-02-15 13:34:20 +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
Mahmoud Metwally
30a5ee74b8 [FW][FIX] developer/howtos: typos and phrasing
closes odoo/documentation#3556

Forward-port-of: odoo/documentation#3541
Signed-off-by: Victor Feyens (vfe) <vfe@odoo.com>
2023-02-13 15:18:46 +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
Jonathan Castillo (jcs)
28302a1073 [IMP] accounting: update how to get api keys for silverfin integration
task 2918697

closes odoo/documentation#3427

X-original-commit: 9a0bf7bb0e
Signed-off-by: Castillo Jonathan (jcs) <jcs@odoo.com>
2023-01-27 14:20:51 +01:00
Mathieu (mano)
78ae5d6185 [IMP] toctrees: redesign and new card component
The goal of this commit is to propose a first step towards a new
`.. card::` directive for the toctrees. This is a first design
proposition for this new card component in raw html for the fallback
page `howtos.rst`

The long term objective is to redesign the toctrees by implementing card
components, clearer toctree list design and custom html pages.

Related to task-3059229

closes odoo/documentation#3407

X-original-commit: 64363d8640
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2023-01-26 18:13:49 +01:00
fdardenne
906ec0988d [FIX] developer: remove merge text in chapter 6
closes odoo/documentation#3351

X-original-commit: a70665ef34
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2023-01-18 16:40:43 +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
Mahmoud Metwally
14be609d38 [FIX] rdtraining: fix writing errors
closes odoo/documentation#3276

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2023-01-04 11:35:54 +01:00
Antoine Vandevenne (anv)
f778ba89af [ADD] contributing/development: add a guide to contribute to the codebase
In addition, this commit extracts the git guidelines from the coding
guidelines. This helps link the git guidelines and unclutter the coding
guidelines, which should focus on only the programming languages.

task-2897123

Part-of: odoo/documentation#3265
2023-01-03 20:14:55 +01:00
Julien Castiaux
ca445c86c8 [IMP] core: additionnal country db for geoip
closes odoo/documentation#2151

Task: 2848206
Related: odoo/enterprise#27399
Related: odoo/odoo#91337
Signed-off-by: Julien Castiaux <juc@odoo.com>
Co-authored-by: Lau-Odoo <46811180+Lau-Odoo@users.noreply.github.com>
Co-authored-by: Antoine Vandevenne (anv) <anv@odoo.com>
2023-01-03 13:15:55 +01:00
oco-odoo
a88ce0cb9e [IMP] accounting: full documentation of the new report engine
Engine report for accounting.

closes odoo/documentation#3226

Taskid: 3042880
X-original-commit: bf2d3d9ed2
Signed-off-by: Castillo Jonathan (jcs) <jcs@odoo.com>
2022-12-21 18:38:49 +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
fdardenne
90313bc380 [IMP] developer: JavaScript tutorial: enhance chapter 1
This commit adds several small information on chapter 1 of the training
 owl:

- 1.1 How to get to the playground controller
- 1.2 Add a reference on sub component
- 1.4 How to activate the dev mode in owl

closes odoo/documentation#3194

X-original-commit: 1bd7e803e0
Signed-off-by: Dardenne Florent (dafl) <dafl@odoo.com>
2022-12-15 08:37:50 +01:00
Horacio Tellez
eb8184542b [FIX] rdtraining: remove outdated line about journal_id in chapter 14
In chapter 14 there was a line pointing to how to deduce a default journal for an `account.move` record.
This is no longer needed as the journal is automatically deduced using the `move_type`. Also, the link
point to an outdated line of code that causes an error.

closes odoo/documentation#3183

X-original-commit: 67a75a3e11
Signed-off-by: Horacio Tellez Perez (hote) <hote@odoo.com>
2022-12-12 09:30:37 +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
fdardenne
8a0df31fc5 [IMP] developer: JavaScript tutorial: chapter 2
This commit adds the chapter 2 of the JavaScript tutorial.

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

closes odoo/documentation#3164

X-original-commit: c5c6daef22
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
Signed-off-by: Dardenne Florent (dafl) <dafl@odoo.com>
Co-authored-by: Géry Debongnie <ged@odoo.com>
Co-authored-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-12-08 18:58:06 +01:00