Commit Graph

406 Commits

Author SHA1 Message Date
samueljlieber
f292374c84 [FIX] resource folder match
closes odoo/documentation#12073

X-original-commit: 92a39cff3a
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
Signed-off-by: Samuel Lieber (sali) <sali@odoo.com>
2025-02-14 14:09:19 +00:00
samueljlieber
03db4e1132 [FIX] clean unused resource files
X-original-commit: 9c7ef9b2cf
Part-of: odoo/documentation#12073
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
Signed-off-by: Samuel Lieber (sali) <sali@odoo.com>
2025-02-14 14:09:19 +00:00
Erwin Zoer
0767d23ec0 [FW][FIX] developer/howtos/upgrade_custom_db: fix typo
Changed the word devolopments to developments

closes odoo/documentation#11873

Forward-port-of: odoo/documentation#11864
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2025-01-27 19:21:50 +00:00
William Braeckman
d60e8a1efc [IMP] developer/reference/cli: --limit-time-cron-conn
Document the newly created config option.

closes odoo/documentation#11831

See: https://github.com/odoo/odoo/pull/194141
X-original-commit: ea9c8bd807
Related: odoo/odoo#194822
Signed-off-by: William Braeckman (wbr) <wbr@odoo.com>
2025-01-23 16:48:34 +00:00
Sam Lieber (sali)
cf1a7701e8 [FIX] tutorials: explicit translation function example
closes odoo/documentation#11524

X-original-commit: cb1f1e89d6
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
Signed-off-by: Samuel Lieber (sali) <sali@odoo.com>
2024-12-04 15:28:42 +00:00
vava-odoo
0cd019210e [FIX] developer/tutorials/importable_modules: no self in actions
In ir.actions.server, the variable containing the record(s) is not
`self`, but `record` and `records`.
Also, since there is a word about `store` attribute for computed
fields, this commit specifies the behaviour of `readonly` attribute.

closes odoo/documentation#11487

X-original-commit: d77d3ace2a
Signed-off-by: Vallaeys Valentin (vava) <vava@odoo.com>
2024-11-29 14:49:53 +00:00
Joris Makauskis
a2069fcb54 [IMP] extract_api: Add bank statement documentation
- Updated documentation to include details on the new bank statement
extraction via OCR.
- Removed mention of unsupported discount, product, and unit features
from invoice_lines feature.

Task-3895452

closes odoo/documentation#11391

X-original-commit: 8c93ff790e
Signed-off-by: Joris Makauskis (jmak) <jmak@odoo.com>
2024-11-14 16:02:04 +00:00
Damien Bouvy
720117d3c1 [ADD] Developer: data module tutorial
Introduce a new tutorial about creating Odoo modules using XML data files
instead of Python code.

This guide is follows closely the 'Server Framework 101' tutorial and
covers the following:

- Module structure and deployment
- Defining models and fields
- Setting up security and access rights
- Creating views and actions
- Implementing relational fields (many2one, many2many, one2many)
- Working with computed and related fields
- Adding business logic through server actions and automation rules
- Creating website controllers for API endpoints

The tutorial includes practical exercises and code examples to reinforce
learning, catering to developers who need to customize Odoo without writing
Python code (e.g. Odoo PS-Tech employees, partners that focus on SaaS instances
or author of Industry modules).

Task-4167176

closes odoo/documentation#11303

X-original-commit: c6a8619367
Signed-off-by: Bouvy Damien (dbo) <dbo@odoo.com>
2024-11-04 12:18:18 +00:00
xpl-odoo
e198d3ce6e [IMP] upgrade: better introduce the upgrade process
closes odoo/documentation#10918

X-original-commit: e05a37917d
Signed-off-by: Xavier Platteau (xpl) <xpl@odoo.com>
2024-09-04 08:25:49 +00:00
Antoine Vandevenne (anv)
a413c3519d [FIX] developer/reference/data: fix typo in data file example
The attribute of `record` data operations should be `id` and not `name`.

closes odoo/documentation#10707

X-original-commit: e41e618116
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2024-08-13 13:20:16 +00:00
Antoine Vandevenne (anv)
cdeaaa21de [FIX] reference/view_architectures: remove outdated and broken link
The external link to `AbstractController` class was broken, both because
the placeholder substitution mechanism doesn't work in included RST
excerpts and because the class has long been removed.

Since it makes little sense to replace the link with another link to
the `useActionLinks` hook in the context of this reference doc, this
commit removes the link altogether, as well as the erroneous mention
of class limitations.

closes odoo/documentation#10732

X-original-commit: e7d2be6366
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2024-08-13 13:20:12 +00:00
sami odoo
0ee3c034d2 [IMP] reference/user_interface: update documentation regarding widget in graph
This commit aims to update the documentation regarding the adaptability of
widgets in the graph view of Odoo.

Task-3861721

closes odoo/documentation#10606

X-original-commit: 9dc985ef47
Signed-off-by: Mathieu Duckerts-Antoine (dam) <dam@odoo.com>
2024-08-06 07:52:51 +00:00
laro-odoo
fea873780d [IMP] web: make date widget work with datetime field
Task-3698841

closes odoo/documentation#10564

X-original-commit: 3badb434e1
Related: odoo/odoo#175446
Related: odoo/enterprise#67843
Signed-off-by: Mathieu Duckerts-Antoine (dam) <dam@odoo.com>
2024-08-05 15:27:47 +00:00
Krzysztof Magusiak (krma)
479ab2028e [IMP] core: remove 'inselect' operator
PR odoo/odoo#171371

closes odoo/documentation#10026

Related: odoo/enterprise#65796
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2024-07-05 05:39:11 +00:00
Sam Lieber (sali)
03d435ea31 [IMP] reference/user_interface: 17.0 odoo ui icons
closes odoo/documentation#9830

X-original-commit: d506554ed0
Signed-off-by: Samuel Lieber (sali) <sali@odoo.com>
2024-06-17 14:46:20 +00:00
Aaron Bohy
a164b8ab65 [IMP] reference/user interface: remove kanban-tooltip doc
This feature has been dropped.

(Part of) task `3650117`

closes odoo/documentation#9604

Related: odoo/odoo#167751
Related: odoo/enterprise#63714
Signed-off-by: Aaron Bohy (aab) <aab@odoo.com>
2024-06-17 11:35:45 +00:00
Aaron Bohy
05500b1416 [IMP] reference/user interface: kanban: color attribute
(Part of) task `3650117`

Part-of: odoo/documentation#9604
Related: odoo/odoo#167751
Related: odoo/enterprise#63714
Signed-off-by: Aaron Bohy (aab) <aab@odoo.com>
2024-06-17 11:35:45 +00:00
Aaron Bohy
ce5a8d554d [IMP] reference/user interface: kanban: can_open attribute
(Part of) task `3650117`

Part-of: odoo/documentation#9604
Related: odoo/odoo#167751
Related: odoo/enterprise#63714
Signed-off-by: Aaron Bohy (aab) <aab@odoo.com>
2024-06-17 11:35:45 +00:00
Nguyen Minh Tran Manh Cuong
64db022a95 [FW][FIX] tutorials/server_framework_101: position of form's notebook element
The notebook element should be nested in the sheet element.

closes odoo/documentation#9748

Forward-port-of: odoo/documentation#9744
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2024-06-10 18:50:00 +00:00
Enmanuel Otero Montano
f9f855cd2e [FW][FIX] howtos/javascript_view: fix typo
A typo was found. The word "customeKanbanView" is misspelled and should be "customKanbanView", which is the constant exported correctly in the code. Therefore, the corrected line would be:

closes odoo/documentation#9676

Forward-port-of: odoo/documentation#9661
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2024-06-06 16:27:19 +00:00
Alice Gaudon
b0627464e5 [IMP] tutorials: add example code for LazyComponent
js framework/Build a Dashboard/part 8 (LazyComponent)

There is no explicit instructions on how to use `LazyComponent`.

- add an example code snippet for minimal use of `LazyComponent`
- add the `.js` extension to the file you're supposed to create to make it a bit more intuitive
- fix `actions` registry name (missing an s)
- reword instructions in a more straightforward way

closes odoo/documentation#9596

X-original-commit: 15c6bb8b0e
Signed-off-by: Florent Dardenne (dafl) <dafl@odoo.com>
Signed-off-by: Alice Gaudon (agau) <agau@odoo.com>
2024-06-03 12:04:58 +00:00
Vincent Larcin
59afd5062d [IMP] *: standardize spelling of “cancelled” across documentation
In https://github.com/odoo/odoo/pull/129722, we settled on using the spelling “cancelled”,
and removed all occurrences of “canceled” from the codebase.

This commit does the same for the documentation.

Task-3951276

closes odoo/documentation#9494

Signed-off-by: Vincent Larcin (vila) <vila@odoo.com>
2024-06-01 16:32:07 +00:00
Vincent Larcin
ac5f9cd28e [IMP] developer/view_architectures: new date filters
Task-3692123

closes odoo/documentation#9398

Related: odoo/odoo#156746
Related: odoo/enterprise#59901
Related: odoo/upgrade#6034
Signed-off-by: Vincent Larcin (vila) <vila@odoo.com>
2024-05-23 16:31:34 +00:00
kcv-odoo
2adc169aec [IMP] developer/js_reference: new attribute for m2m_tags
task-3526304

closes odoo/documentation#9438

Related: odoo/upgrade#6039
Related: odoo/enterprise#62721
Related: odoo/odoo#165935
Signed-off-by: Victor Feyens (vfe) <vfe@odoo.com>
2024-05-23 11:01:06 +00:00
Samuel Degueldre
2c5c43c474 [IMP] developer: add an article to explain error handling in JS
closes odoo/documentation#9310

X-original-commit: 489fe7d3ea
Signed-off-by: Samuel Degueldre (sad) <sad@odoo.com>
2024-05-14 08:41:55 +00:00
XPL
f7769365bc [IMP] settings: simplify the developer mode page
task-3849915

closes odoo/documentation#9238

X-original-commit: 67f02edd7b
Signed-off-by: Xavier Platteau (xpl) <xpl@odoo.com>
2024-05-08 10:25:40 +00:00
Antoine Vandevenne (anv)
6332d389f9 [FIX] reference/view_architectures/*: remove nosearch meta directives
The `nosearch` meta directive is not fully supported in included files:
the generated file is excluded from search results, but the "nosearch"
term is present in the included content.

closes odoo/documentation#9191

X-original-commit: 298a222d00
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2024-05-07 07:08:25 +00:00
Samuel Degueldre
59e8cb1c3a [FIX] developer: rewrite a bunch of outdated info in JS reference
Previously, a lot of information on the JavaScript reference page was
outdated.

This commit rewrites a bunch of sections to bring them up to date and
removes others that are no longer relevant. While a more profound rework
of the JS documentation is still needed, this commit at least reduces
the amount of outdated information significantly in the meantime.

closes odoo/documentation#9203

X-original-commit: 2354f0946e
Signed-off-by: Samuel Degueldre (sad) <sad@odoo.com>
2024-05-07 05:56:26 +00:00
Victor Feyens
b4a8e166a6 [FIX] dev/tutorials: typo
courtesy of @/ChloeLiang

closes odoo/documentation#9051

X-original-commit: 3e62a8c4cd
Signed-off-by: Victor Feyens (vfe) <vfe@odoo.com>
2024-04-30 02:30:25 +00:00
Vincent Schippefilt
564f2640c7 [IMP] base: add read_group relative granularity
references https://github.com/odoo/odoo/pull/159528

closes odoo/documentation#8447

Task: 3836802
Related: odoo/odoo#159528
Signed-off-by: Vincent Schippefilt (vsc) <vsc@odoo.com>
2024-04-25 17:11:23 +00:00
Alvaro Fuentes
3bba491f57 [IMP] doc: improve organization of upgrades docs
* Add autodoc directives to generate documentation directly from
  upgrade-util repo.
* Group all upgrades-related reference documentation into one group in
  the sidebar, instead of having two entries.
* Mention `upgrades` vs `migrations` directory. It has been supported
  since a while but nothing was explicit in the documentation.

Original commit: 91a48bfe88

closes odoo/documentation#8849

X-original-commit: ef4b5f87d5
Signed-off-by: Victor Feyens (vfe) <vfe@odoo.com>
2024-04-19 13:35:52 +00:00
Antoine Vandevenne (anv)
57b7ca69d9 [IMP] developer: improve navigation in top-level pages
Prior to this commit, users had to either know in advance or guess the
location of the content they were looking for. Top-level pages of the
"Developer" section of the documentation, in particular the "Developer"
page itself, were listing their sub-pages without directions for users.

This commit brings the following changes to improve the navigation:
- add directions for users on the "Developer" page and list the three
  main categories of developer documentation ("Tutorials", "How-to
  guides", and "Reference") with explanations of their content and
  target audience;
- add categories for content cards on the "Tutorials" and "How-to
  guides" pages, and fine-tune the toctree of the "Reference" page to
  more easily locate specific topics;
- clarify what are the "Python framework" and the "JavaScript framework"
  by relabelling them to "Server framework" and "Web framework" on
  top-level pages, as some users were confused to find that the JS
  framework was not responsible for the server, and others that the
  documentation for QWeb template is located in the Python documentation;
- extract the "Setup guide" from the "Getting started" tutorial and
  rename the latter to "Server framework 101" to allow reusing the setup
  guide in other tutorials and make clear that the "Server framework 101"
  tutorial is not about the Web framework.

task-3802536

closes odoo/documentation#8712

X-original-commit: 7f623b6ad5
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
Co-authored-by: Valeriya (vchu) <vchu@odoo.com>
2024-04-13 12:16:35 +00:00
Gorash
644cbd052f [IMP] base: required field (from view python expr) are add automatically
related to odoo/odoo#137031

closes odoo/documentation#6115

Related: odoo/enterprise#48832
Related: odoo/upgrade#5861
Signed-off-by: Raphael Collet <rco@odoo.com>
2024-04-08 19:17:56 +00:00
mathysPaul
06d25495e6 [IMP] payment: Remove _compute_view_configuration_fields docs
Following the removal of explicit view configuration fields and
the `_compute_view_configuration_fields` method in the payment
module, this commit updates the documentation accordingly. It
removes all references and instructions related to
`_compute_view_configuration_fields`, ensuring the documentation
reflects the current implementation that leverages XPath for
view customization.

task-3679393

See odoo/odoo#152517
See odoo/enterprise#56181
See odoo/upgrade#5667

closes odoo/documentation#7686

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2024-04-02 13:09:25 +00:00
Rémy Voet (ryv)
5f2a5d318e [IMP] orm: add 'any' and 'not any' operators
- Add descriptions of the 'any' and 'not any' operators
- Simplify the example for searching partners
- Add an example using the 'any' operator for the sale.order model

closes odoo/documentation#8349

Closes: #7620
X-original-commit: 7353d7b2cc
Signed-off-by: Rémy Voet (ryv) <ryv@odoo.com>
2024-03-25 12:54:14 +00:00
Mohamed Alkobrosli
47edb88436 [FW][FIX] dev/assets: typo
the "py" letter should be "by" to make the syntax correct and understood.

closes odoo/documentation#8302

Forward-port-of: odoo/documentation#8276
Signed-off-by: Victor Feyens (vfe) <vfe@odoo.com>
2024-03-22 07:27:11 +00:00
glovebx
3e4b026979 [FW][FIX] dev/view_architectures: domain attribute of search view fields
The domain in the `field` component cannot accept user-provided values or access self variables.
This commit removes the misleading sentence about it from the documentation.

closes odoo/documentation#8229

Forward-port-of: odoo/documentation#8193
Signed-off-by: Victor Feyens (vfe) <vfe@odoo.com>
2024-03-22 03:08:58 +00:00
tiku-odoo
cbe068e3ab [IMP] developer: external api add admonition block
closes odoo/documentation#8240

X-original-commit: d6f5e74971
Signed-off-by: Xavier Platteau (xpl) <xpl@odoo.com>
Signed-off-by: Timothy Kukulka (tiku) <tiku@odoo.com>
2024-03-20 16:31:57 +00:00
Bastien Fafchamps (bafa)
df1f1dd6b6 [FIX] web: adapted Dropdown component documentation to new api
This commit adapts the documentation to reflect changes made to the Dropdown
component after its refactor, namely:
- Adapted props list
- Adapted code snippets
- Added DropdownGroup component documentation
- More consise examples

closes odoo/documentation#8156

Task-id: 3266145
Signed-off-by: Bastien Fafchamps (bafa) <bafa@odoo.com>
2024-03-20 16:31:55 +00:00
Louis (loti)
5bb97c3fcb [IMP] payment: render /payment/status entirely from the server
Previously, /payment/status would render a template on the server-side, and a JS widget would render subtemplates on the client-side and insert them in the server-side rendered template.

However, mixing server-side and client-side templates causes issues because the context is not properly communicated between client and server. It also makes the code more complex.

This change assumes that no new information returned by /payment/status is worth re-rendering part of the template. If the transaction moves from a pending ('draft', 'pending') state to a final state, the customer should be redirected to the final route that will display the updated information on the transaction.

task-3340354

closes odoo/documentation#8198

Related: odoo/upgrade#5829
Related: odoo/odoo#149821
Related: odoo/enterprise#58822
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2024-03-20 12:09:27 +00:00
Antoine Vandevenne (anv)
124f9743c6 [FIX] tutorials/discover_js_framework: clarify instructions
closes odoo/documentation#8184

X-original-commit: 632add350d
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2024-03-19 01:31:02 +00:00
Samuel Degueldre
ff36e1f7aa [IMP] web: create how-to for using Owl components in the frontend
closes odoo/documentation#8149

X-original-commit: e259853486
Signed-off-by: Samuel Degueldre (sad) <sad@odoo.com>
2024-03-15 15:59:20 +00:00
Raphael Collet
cb948c7f05 [IMP] core: remove user_has_groups()
Simply align the documentation with the new API and usage of method
user.has_group().

closes odoo/documentation#8131

Related: odoo/odoo#151597
Related: odoo/upgrade#5616
Related: odoo/enterprise#55523
Signed-off-by: Raphael Collet <rco@odoo.com>
2024-03-15 14:29:11 +00:00
Pierre Pulinckx (PIPU)
bf79132249 [IMP] dev/testing: document new tour debug mode
In this commit, documentation about debug mode feature in tour
(implemented in https://github.com/odoo/odoo/pull/155082) is added.

closes odoo/documentation#7807

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2024-03-13 19:23:45 +00:00
Jonathan Castillo (jcs)
0249d9d0a6 [MOV] documentation structure reorganization
This commit aims to improve the documentation's navigability by
redefining some categories' purposes and titles.

There is a redirection rule for each documentation page moved.
This ensures that users won't have a 404 error message.

task-3217827

closes odoo/documentation#8064

Signed-off-by: Jonathan Castillo (jcs) <jcs@odoo.com>
2024-03-12 07:08:34 +00:00
Claire Bretton (clbr)
0fab281c12 [IMP] getting_started: use odoo/tutorials repository + runbot
We now use the odoo/tutorials to make the technical onboarding.
- Change the current documentation accordingly.
- Add a section for employees only so that they use odoo-dev/tutorials
as shared fork. It's closer to our way to work so we think it's better
to make them use to it as fast as possible.
- Add some explanations about runbot.

`odoo/technical-training-sandbox` will no longer be used and can be considered deprecated.

closes odoo/documentation#8043

X-original-commit: e60affa6fe
Signed-off-by: Claire Bretton (clbr) <clbr@odoo.com>
2024-03-06 11:37:58 +00:00
Tarek berkane
54c328611c [FW][FIX] tutorials/getting_started: typo in 'estate'
closes odoo/documentation#7786

Forward-port-of: odoo/documentation#7772
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2024-02-20 11:02:07 +00:00
Rémy Voet (ryv)
99751542c7 [IMP] orm: renaming of group_operator -> aggregator
closes odoo/documentation#5541

Related: odoo/enterprise#46795
Related: odoo/odoo#127353
Signed-off-by: Rémy Voet (ryv) <ryv@odoo.com>
2024-02-08 11:24:50 +00:00
Rémy Voet (ryv)
ad749706ec [IMP] orm: changelog about group/aggregate/order by no-store related fields
Part-of: odoo/documentation#5541
2024-02-08 11:24:50 +00:00
Michaël Mattiello
973d5800d2 [IMP] web: update javascript odoo modules
This commit adapts the javascript modules section with the last
update https://github.com/odoo/odoo/pull/142858 and some outdated
features.

closes odoo/documentation#7640

Signed-off-by: Michaël Mattiello (mcm) <mcm@odoo.com>
2024-02-06 15:53:40 +00:00