Commit Graph

91 Commits

Author SHA1 Message Date
Jonathan Castillo (jcs)
8553f68bb8 [MOV] accounting: restructuration of the accounting documentation
This commit improves the structure of the accounting documentation by
- reducing the levels necessary to reach the information
- grouping some docs
- moving content to their parent category page (content in all levels)
- renaming some sections to reflect the structure of the app better

task-3330093

closes 

X-original-commit: c68cc154ed
Signed-off-by: Castillo Jonathan (jcs) <jcs@odoo.com>
2023-05-22 11:43:14 +02:00
CVDE-odoo
26f00581c4 [ADD] developer/howto: guide for theming
A complete guide on how to create a custom website theme for Odoo

closes 

X-original-commit: 892fd3e2ac
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
Signed-off-by: Castillo Jonathan (jcs) <jcs@odoo.com>
2023-05-12 08:17:09 +02:00
Mahmoud Metwally
d69383d7ae [FW][FIX] howtos/company: fix typos
closes 

Forward-port-of: 
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2023-04-17 18:01:15 +02:00
Mahmoud Metwally
3117592e26 [FW][FIX] developer/web_services: fix typo
closes 

Forward-port-of: 
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2023-04-14 11:49:17 +02:00
Tiffany Chang (tic)
ab1563e7c7 [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 

Task: 3226581
X-original-commit: 7124542ed9
Signed-off-by: Tiffany Chang <tic@odoo.com>
2023-04-05 17:31:58 +02:00
fdardenne
56a5b0480e [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 

X-original-commit: 7e4435deb8
Signed-off-by: Dardenne Florent (dafl) <dafl@odoo.com>
2023-04-05 13:57:53 +02:00
Antoine Vandevenne (anv)
518db8b02a [MOV] developer/api/external_api: move "External API" to the reference dir
task-2991663

X-original-commit: 95ed856446
Part-of: 
2023-02-23 16:09:00 +01:00
Antoine Vandevenne (anv)
cc3ca497f3 [MOV] developer/api/iap: move "In-App Purchase" to the howtos dir
task-2991663

X-original-commit: b817e16a4c
Part-of: 
2023-02-23 16:09:00 +01:00
Antoine Vandevenne (anv)
b75a798ae6 [MOV] developer/iot: move "Internet of things" the howtos dir
task-2991663

X-original-commit: 2701d91db0
Part-of: 
2023-02-23 16:08:59 +01:00
Antoine Vandevenne (anv)
d783dd375a [MOV] howto/web: move "Customizing the webclient" to the tutorials dir
task-2991663

X-original-commit: 2d469bccbc
Part-of: 
2023-02-23 16:08:59 +01:00
Antoine Vandevenne (anv)
c2d7f03b8b [MOV] howto/website: move "Building a website" to the tutorials dir
task-2991663

X-original-commit: 58f2174c49
Part-of: 
2023-02-23 16:08:59 +01:00
Antoine Vandevenne (anv)
1292abc9e7 [MOV] howtos/backend: move "Building a module" to the tutorials dir
task-2991663

X-original-commit: 642c4839f7
Part-of: 
2023-02-23 16:08:58 +01:00
Antoine Vandevenne (anv)
899960a66d [MOV] howtos/discover_js_framework/*: move "Discover the JS Framework" to the tutorials dir
task-2991663

X-original-commit: 9c5ea316ff
Part-of: 
2023-02-23 16:08:58 +01:00
Antoine Vandevenne (anv)
018d708b44 [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: 
2023-02-23 16:08:58 +01:00
william-andre
cd81a97399 [REF] account: remove chart templates
The way of declaring charts of accounts has completely changed.

closes 

Related: 
Related: 
Related: 
Signed-off-by: William André (wan) <wan@odoo.com>
2023-02-17 19:30:29 +01:00
Jonathan Castillo (jcs)
65d71dd7be [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 

X-original-commit: 7ae76bad42
Signed-off-by: Castillo Jonathan (jcs) <jcs@odoo.com>
2023-02-15 16:03:06 +01:00
Amelia Williams
aafa593c6a [FIX] 02_setup: remove gramatical error
closes 

X-original-commit: 18b000602b
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2023-02-15 13:36:53 +01:00
Mahmoud Metwally
a39f2d4421 [FW][FIX] developer/howtos: typos and phrasing
closes 

Forward-port-of: 
Signed-off-by: Victor Feyens (vfe) <vfe@odoo.com>
2023-02-13 15:15:41 +01:00
fdardenne
3690bba092 [FIX] developer: remove merge text in chapter 6
closes 

X-original-commit: a70665ef34
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2023-01-18 16:19:37 +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 

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 

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
Mahmoud Metwally
14be609d38 [FIX] rdtraining: fix writing errors
closes 

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: 
2023-01-03 20:14:55 +01:00
oco-odoo
a88ce0cb9e [IMP] accounting: full documentation of the new report engine
Engine report for accounting.

closes 

Taskid: 3042880
X-original-commit: bf2d3d9ed2
Signed-off-by: Castillo Jonathan (jcs) <jcs@odoo.com>
2022-12-21 18:38:49 +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 

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 

X-original-commit: 67a75a3e11
Signed-off-by: Horacio Tellez Perez (hote) <hote@odoo.com>
2022-12-12 09:30:37 +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 

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 

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
fdardenne
2110671090 [ADD] developer: add a tutorial on Owl
This commit adds the introduction and the chapter 1 of the new
Owl/JavaScript framework tutorial.

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

closes 

X-original-commit: 62051b643f
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>
2022-12-02 10:11:21 +01:00
Victor Feyens
2d1361c026 [FIX] developer/*: code blocks linting & fixes
invalid xml
invalid python
correct indentation

closes 

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: 
2022-11-25 10:52:04 +01:00
Jeff Nyalik
963de80d3e [FW][FIX] rdtraining: fix typo
Kind of a typo here " it will not possible" to "it will not be possible"

closes 

Forward-port-of: 
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-11-23 21:56:06 +01:00
Victor Feyens
f6ac437b68 [IMP] developer/howtos: deprecate themes tutorial
This tutorial was already outdated in 13.0 (but
supposedly working).

In 14.0+, a lot of changes happened in website logic,
especially for 'website option definitions', breaking
the existing theme tutorial.

Considering the fact that a new tutorial is being made,
and that fixing the whole existing tutorial would be
a big work, it will be kept, but hidden as 'most things
being said still make sense'.

closes 

X-original-commit: 9cc60baf46
Signed-off-by: Victor Feyens (vfe) <vfe@odoo.com>
2022-11-21 22:20:35 +01:00
Victor Feyens
197dbea3d2 [FIX] *: unbalanced literal markups
Part-of: 
2022-11-18 18:04:50 +01:00
Victor Feyens
c2f8d4bd44 [FIX] *: remove trailing whitespaces
Part-of: 
2022-11-18 18:04:50 +01:00
Victor Feyens
c60bc5f919 [FIX] *: enforce 1 newline on files end
Part-of: 
2022-11-18 18:04:49 +01:00
Elias
ade054b752 [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 

X-original-commit: e21dbd01c9
Signed-off-by: Victor Feyens (vfe) <vfe@odoo.com>
2022-10-18 13:17:37 +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 

X-original-commit: 93b383e95d
Signed-off-by: Victor Feyens (vfe) <vfe@odoo.com>
2022-10-18 12:19:30 +02:00
Xavier-Do
46a80f60c5 [ADD] developer/reference: add a reference page on performance
closes 

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 18:01:00 +02:00
Aleksander
f4bbbcb6c1 [FW][IMP] howtos/rdtraining: give the meaning of "ACL"
closes 

Forward-port-of: 
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-09-30 12:34:44 +02:00
Claire Bretton (clbr)
33196968df [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 

X-original-commit: 338fe297b0
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-09-16 23:49:41 +02:00
Julien Castiaux
0e6a41d6d5 [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: 
2022-09-14 16:18:26 +02:00
Julien Alardot (jual)
642968bfd8 [IMP] account, account_report, l10n_*: Introduce unified reporting engine
This commit adapts account's model to the new report engine introduced for v16, and updates the data files accordingly.

account.report model is now declared in community, together with the other models used by the reporting. This is done so that the tax tags can properly be created by the tax report and used on tax templates. All the actual computation logic stays in enterprise.

See enterprise commit for full details.

Task 2524389

closes 

Related: 
Related: 
Related: 
Signed-off-by: Julien Alardot (jual) <jual@odoo.com>
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-08-25 19:57:06 +02:00
Antoine Vandevenne (anv)
d508e02871 [IMP] rdtraining: mention that the second part needs to be completed too
closes 

X-original-commit: 9279fb80a7
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-08-01 16:01:09 +02:00
Victor Feyens
0fa4d26c19 [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 

closes 

X-original-commit: 1c4abe4e07
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-07-27 04:53:16 +02:00
Benoit Socias
92f4743b83 [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 

X-original-commit: b8ee134a28
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-07-20 22:40:01 +02:00
Victor Feyens
a1d7e430c7 [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 

Signed-off-by: Victor Feyens (vfe) <vfe@odoo.com>
2022-07-14 16:42:08 +02:00
Antoine Vandevenne (anv)
449898e39c [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 

X-original-commit: 524794c59c
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-07-14 15:22:10 +02:00
Antoine Vandevenne (anv)
cb8d65d5e3 [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 

X-original-commit: 12ff9f118b
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-07-04 17:47:43 +02:00
Valentin Chevalier
e32f9d8eab [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 

X-original-commit: 96d822bf87
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-06-27 10:10:43 +02:00