Commit Graph

297 Commits

Author SHA1 Message Date
luvi
898b0280db [IMP] web: add documentation for Core components
This commit adds some documentation for features recently added to SelectMenu
and TagsList components during the saas-16.3 development. A screenshot has
been provided to the advances use case of the SelectMenu, with a customization
of the bottom area of the dropdown, to create display a button allowing the
creation of items.

closes odoo/documentation#4631

X-original-commit: 0aad6eafda
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
Signed-off-by: Luca Vitali <luvi@odoo.com>
2023-06-06 14:48:43 +02:00
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 odoo/documentation#4479

X-original-commit: c68cc154ed
Signed-off-by: Castillo Jonathan (jcs) <jcs@odoo.com>
2023-05-22 11:43:14 +02:00
Mathieu Duckerts-Antoine
70b69857e9 [IMP] abstract actions: adapt code after some legacy code removal
closes odoo/documentation#3722

Signed-off-by: Géry Debongnie <ged@odoo.com>
2023-05-17 14:46:58 +02:00
Mathieu Duckerts-Antoine
b4ebef7d20 [IMP] gantt: adapt doc to last changes brought during owl conversion
Part-of: odoo/documentation#3722
2023-05-17 14:46:58 +02:00
Mathieu Duckerts-Antoine
1491cce9d6 [IMP] views: document attributes "class" and "js_class"
Part-of: odoo/documentation#3722
2023-05-17 14:46:58 +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 odoo/documentation#4420

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
Antoine Vandevenne (anv)
fd933208d3 [IMP] tutorials/getting_started: rework the environment setup guide
This commit replaces a big chunk of the instructions relative to the
environment setup with a reference to the equivalent steps listed in the
contribution guide. It also moves the content of the "Create your first
PR" section from chapter 16 to chapter 2, as readers were struggling
with the Git configuration required to push their work to GitHub as they
progressed through the tutorial.

closes odoo/documentation#4413

X-original-commit: 26e12696c1
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2023-05-11 18:25:41 +02:00
Antoine Vandevenne (anv)
8c29d1fd6a [FIX] reference/services: mark optional the params parameter of rpc
closes odoo/documentation#4282

X-original-commit: c1b38dc1f3
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2023-04-27 18:25:21 +02:00
Antoine Vandevenne (anv)
b1a76aec63 [IMP] tutorials/js_framework: reword, clarify and improve instructions
X-original-commit: b58dbb1fbb
Part-of: odoo/documentation#4282
2023-04-27 18:25:21 +02:00
Antoine Vandevenne (anv)
08f472ef28 [IMP] tutorials/js_framework: freeze GitHub links with line numbers
A few links were already outdated. Either the referenced code was no
longer on the same line, or the file didn't exist anymore.

This commit freezes all links targeting a specific line on the odoo/odoo
repository by selecting a specific commit.

X-original-commit: 6e746c851f
Part-of: odoo/documentation#4282
2023-04-27 18:25:20 +02:00
Antoine Vandevenne (anv)
d90e09c8b7 [IMP] tutorials/js_framework: retarget links to the current major branch
Commits pushed on the odoo/tutorials repository are not automatically
forward-ported, which makes it cumbersome to keep all SaaS branches up
to date.

Because of this, and because Odoo developers are very unlikely to follow
tutorials specific to a SaaS branch, links to odoo/tutorials now target
the current major branch, or master if applicable. SaaS branches have
also been deleted from the odoo/tutorials repository.

X-original-commit: ce14b2cfb5
Part-of: odoo/documentation#4282
2023-04-27 18:25:20 +02:00
Géry Debongnie
adb845eb17 [IMP] developer/tutorials: separate js framework tutorial in two parts
This commit splits the 7 chapters of the JS tutorial in two
smaller and more focused tutorials:
- a basic one (Discover the JS framework)
- and an advanced one (Master the odoo web framework)

closes odoo/documentation#4248

X-original-commit: b6b9de70d2
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2023-04-25 11:22:48 +02:00
Leonardo Pavan Rocha
fe2111ccbf [IMP] web: add quick_create_form_view_id attribute
In https://github.com/odoo/odoo/pull/114827, a new attribute was added in
calendar views to allow passing the id of a form view that is used internally
in the calendar module to show a different form view when quick_creating an
event.

task-3129030

closes odoo/documentation#4221

Signed-off-by: Victor Feyens (vfe) <vfe@odoo.com>
2023-04-24 18:26:01 +02:00
Artygo8
ef4c3555bc [IMP] reference/extract: update documentation
task-3071317

closes odoo/documentation#4224

X-original-commit: 07eef81a95
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
Signed-off-by: Arthur Gossuin (goa) <goa@odoo.com>
2023-04-22 06:53:41 +02:00
Rémy Voet (ryv)
584e44396b [ADD] add documentation about Model._read_group
task-3001022

odoo/odoo#110737

closes odoo/documentation#4064

Related: odoo/enterprise#38639
Signed-off-by: Rémy Voet <ryv@odoo.com>
2023-04-19 21:58:12 +02:00
Mahmoud Metwally
d69383d7ae [FW][FIX] howtos/company: fix typos
closes odoo/documentation#4183

Forward-port-of: odoo/documentation#4147
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 odoo/documentation#4160

Forward-port-of: odoo/documentation#4146
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2023-04-14 11:49:17 +02:00
wangting
9fb8c5c354 [FIX] tutorials/js_framework: fix typo
closes odoo/documentation#4148

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2023-04-13 16:40:41 +02:00
Martin Trigaux
1e39949363 [IMP] reference: update markup documentation
closes odoo/documentation#3612

Related: odoo/odoo#111850
Related: odoo/enterprise#36728
Signed-off-by: Martin Trigaux (mat) <mat@odoo.com>
2023-04-13 16:39:45 +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 odoo/documentation#4035

Task: 3226581
X-original-commit: 7124542ed9
Signed-off-by: Tiffany Chang <tic@odoo.com>
2023-04-05 17:31:58 +02:00
Tiffany Chang (tic)
e18b24a176 [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#4035
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 odoo/documentation#4020

X-original-commit: 7e4435deb8
Signed-off-by: Dardenne Florent (dafl) <dafl@odoo.com>
2023-04-05 13:57:53 +02:00
luvi
5e248b7017 [IMP] web: Add core components documentation
This commit adds the documentation for core components that have
been improved or moved during the Studio refactor. Some new props
have been added, and the documentation is now present as expected.

Components involved:
- Notebook
- SelectMenu
- TagsList

closes odoo/documentation#4007

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2023-04-04 18:07:11 +02:00
kcv-odoo
ff846cc48d [IMP] backend: add disable_linking option in cohort view
Related PR: https://github.com/odoo/enterprise/pull/37396

task-3186590

closes odoo/documentation#3646

Related: odoo/enterprise#37396
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2023-04-04 18:07:01 +02:00
Benoit Socias
39d5455110 [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#3991

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:55:23 +02:00
Raphael Collet
4f3531f81b [IMP] tests: server-side Form and other tests features
closes odoo/documentation#3968

Related: odoo/enterprise#38858
Related: odoo/odoo#116779
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2023-03-31 17:02:46 +02:00
FrancoisGe
679504a05c [REF] web: remove allow_group_range_value
The allow_group_range_value option is used in one arch of a kanban in
CRM. We therefore believe that this is not standard behaviour.
So we decided to move this logic to the custom view that uses it.

closes odoo/documentation#3964

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2023-03-30 13:58:28 +02:00
Valentin Vallaeys (vava)
04c732f89e [ADD] developer: add _get_available_tokens
Introduced with this commit:
e534ab41e7

closes odoo/documentation#3859

X-original-commit: cb06fb7687
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
Signed-off-by: Vallaeys Valentin (vava) <vava@odoo.com>
2023-03-21 19:54:31 +01:00
Jonathan Castillo (jcs)
33f99d03dc [FIX] dev/tuto: grammar mistake in 02_setup
task-3238089

closes odoo/documentation#3849

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 16:51:47 +01:00
Géry Debongnie
f6ce2b9904 [IMP] developer: add description of disabled prop to Dropdown
This prop has been implemented in pr https://github.com/odoo/odoo/pull/115201/files

closes odoo/documentation#3828

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2023-03-14 17:03:41 +01:00
Raphael Collet
097c247449 [IMP] core: introduce search_fetch() and fetch()
closes odoo/documentation#3749

Related: odoo/odoo#114551
Signed-off-by: Raphael Collet <rco@odoo.com>
2023-03-07 18:03:13 +01:00
Antoine Vandevenne (anv)
009ae8ffde [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#3689

X-original-commit: 34bc63d2bc
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2023-02-28 18:08:29 +01:00
Antoine Vandevenne (anv)
ed4b8c1320 [MOV] developer/cli: move "Command-line interface (CLI)" to the reference dir
task-2991663

closes odoo/documentation#3660

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

X-original-commit: 73f976e679
Part-of: odoo/documentation#3660
2023-02-23 16:09:00 +01: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: odoo/documentation#3660
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: odoo/documentation#3660
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: odoo/documentation#3660
2023-02-23 16:08:59 +01:00
Antoine Vandevenne (anv)
ba7a47e03e [IMP] tutorials/*: hide outdated tutorials
*: backend, web, website

task-2991663

X-original-commit: 9561c9abf8
Part-of: odoo/documentation#3660
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: odoo/documentation#3660
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: odoo/documentation#3660
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: odoo/documentation#3660
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: odoo/documentation#3660
2023-02-23 16:08:58 +01:00
Antoine Vandevenne (anv)
c3a66c28a0 [MOV] tutorials/getting_started/*: promote advanced chapters to independent tutorials
task-2991663

X-original-commit: a8c78a80ba
Part-of: odoo/documentation#3660
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: odoo/documentation#3660
2023-02-23 16:08:58 +01:00
Antoine Vandevenne (anv)
286ae4a7b7 [ADD] developer/tutorials: add a directory for developer tutorials
task-2991663

X-original-commit: 73ce4d6cd8
Part-of: odoo/documentation#3660
2023-02-23 16:08:57 +01:00
william-andre
cd81a97399 [REF] account: remove chart templates
The way of declaring charts of accounts has completely changed.

closes odoo/documentation#3336

Related: odoo/enterprise#35836
Related: odoo/odoo#110016
Related: odoo/upgrade#4276
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 odoo/documentation#3589

X-original-commit: 7ae76bad42
Signed-off-by: Castillo Jonathan (jcs) <jcs@odoo.com>
2023-02-15 16:03:06 +01:00
luvi
f4c8a0f929 [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#3586

X-original-commit: 7a9d807bcc
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
Signed-off-by: Luca Vitali <luvi@odoo.com>
2023-02-15 16:03:03 +01:00
Amelia Williams
aafa593c6a [FIX] 02_setup: remove gramatical error
closes odoo/documentation#3583

X-original-commit: 18b000602b
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2023-02-15 13:36:53 +01:00
luvi
a844c0aa12 [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#3575

X-original-commit: 4a220d61fe
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
Signed-off-by: Luca Vitali <luvi@odoo.com>
2023-02-14 18:12:04 +01:00