Commit Graph

332 Commits

Author SHA1 Message Date
celine de lannoy
2a976d4649 [ADD] tutorials/website_theme: Add tutorials to build a website theme 2025-04-29 11:07:22 +02:00
celine de lannoy
9f8b8e79d9 [REM] tutorials/website: Remove outdated tutorial 2025-03-27 11:40:19 +01:00
Alvaro Fuentes
942fd6dd41 [IMP] developer/reference/cli: improve docs of --upgrade-path
Be explicit about what we expect as parameter.

closes odoo/documentation#12528

Related: odoo/odoo#202014
Signed-off-by: Alvaro Fuentes Suarez (afu) <afu@odoo.com>
2025-03-19 16:47:21 +00:00
Alvaro Fuentes
bcad893864 [IMP] developer/reference/cli: --pre-upgrade-scripts
Document the new cli option.

Part-of: odoo/documentation#12528
Related: odoo/odoo#202014
Signed-off-by: Alvaro Fuentes Suarez (afu) <afu@odoo.com>
2025-03-19 16:47:21 +00:00
Brandon Mercier
8ce27c696d [IMP] Website Themes - Going Live
[IMP] Website Themes - Going Live

- Content update and additions
- Screenshot
- New anchors

[FIX] Fix after code review

[FIX] Anchor to noupdate attribute

closes odoo/documentation#12225

Signed-off-by: Brandon Mercier (bram) <bram@odoo.com>
2025-03-15 15:37:50 +00:00
Brandon Mercier
2fc209623d [IMP] Website themes - Pages
[IMP] Website themes - Pages
[FIX] Website Themes - Pages: Anchors
[FIX] Website Themes - Pages: anchors
[FIX] Anchors patterns + code review modifications

closes odoo/documentation#12222

Signed-off-by: Brandon Mercier (bram) <bram@odoo.com>
2025-03-14 15:42:27 +00:00
Brandon Mercier
53b2db4ab5 [IMP] Website Themes - Layout page
[IMP] Website Themes - Layout page

[FIX] Corrections for ci

[FIX] Ci failure

[IMP] Small corrections

- Reorder the Xpath examples.
- Add an explanation for the move directive

[ADD] Website Themes - Media section

[IMP] Website Themes - Layout section modifications

[IMP] Anchors for CEDE's references (Tutorials)

[IMP] Line width + visibility conditions alert type

[IMP] Website Themes - Layout : Anchors correction

Revert "[ADD] Website Themes - Media section"

This reverts commit 4567cfe114251cdc9f263b8e97f0f988945f4db8.

[FIX] Update anchors pattern

[FIX] Media company logo reference

closes odoo/documentation#12220

Signed-off-by: Brandon Mercier (bram) <bram@odoo.com>
2025-03-14 15:42:25 +00:00
Brandon Mercier
1ef929990c [IMP] Website Themes - Building blocks
Rework of the whole page in order to organized / categorized the content better + Addition from the PSBE Designers Wiki

[FIX] Website Themes - Building block : Fix typo

[FIX] Corrections after review

closes odoo/documentation#12219

Signed-off-by: Brandon Mercier (bram) <bram@odoo.com>
2025-03-14 15:42:24 +00:00
Carlos Valverde
0044a6bb09 [ADD] howto/website: add media page
This commit adds the `media` page, links it to the `website_themes`
index, deletes duplicated content from the `pages.rst` page and moves
images from the current `pages` folder to a new one.

Task-4316611

closes odoo/documentation#12192

Signed-off-by: Carlos Valverde (cvs) <cvs@odoo.com>
2025-03-14 11:56:08 +00:00
Carlos Valverde
a548d85da8 [IMP] howto/website: update navigation page
This commit updates current navigation page, by adding new anchor links
to the sections and by adding updated information.

Task-4316611

closes odoo/documentation#12191

Signed-off-by: Carlos Valverde (cvs) <cvs@odoo.com>
2025-03-14 09:40:36 +00:00
Brandon Mercier
88301e22ea [IMP] Website Themes - Forms
[IMP] Website Themes - Forms
[FIX] Anchors + Modifications after code review

closes odoo/documentation#12224

Signed-off-by: Brandon Mercier (bram) <bram@odoo.com>
2025-03-14 09:40:35 +00:00
Carlos Valverde
4e0f298786 [IMP] howto/website: update shapes page
This commit updates current `shapes` page, by adding new anchor links
to the sections, updated information and images.

Task-4316611

closes odoo/documentation#12213

Signed-off-by: Carlos Valverde (cvs) <cvs@odoo.com>
2025-03-14 09:40:33 +00:00
Carlos Valverde
0ea5823a94 [IMP] howto/website: update animations page
This commit updates current `animations` page, by adding new anchor
links to the sections, updated information and images.

Task-4316611

closes odoo/documentation#12235

Signed-off-by: Carlos Valverde (cvs) <cvs@odoo.com>
2025-03-14 09:40:32 +00:00
Brandon Mercier
dab8e3c71e [IMP] Website Themes - Gradients
[IMP] Website Themes - Gradients

- Corrections
- New anchors

[FIX] Modifications after code review

closes odoo/documentation#12223

Signed-off-by: Brandon Mercier (bram) <bram@odoo.com>
2025-03-14 09:40:31 +00:00
Brandon Mercier
9d5ccb7e1d [IMP] Website Themes - Setup
[IMP] Website Themes - Setup

[IMP] Website Themes - Setup

- Use the right code-block language for terminal command line
- Add a step about the 2-factor authentication

[IMP] Anchors for CEDE's references (Tutorials)

[FIX] Website Themes - Setup: Anchors

[IMP] Anchors pattern correction

closes odoo/documentation#12221

Signed-off-by: Brandon Mercier (bram) <bram@odoo.com>
2025-03-14 07:31:26 +00:00
Carlos Valverde
e508d96c1d [IMP] howto/website: update translations page
This commit updates current `translations` page, by adding new anchor
links to the sections, updated information and images.

Task-431661

closes odoo/documentation#12236

Signed-off-by: Carlos Valverde (cvs) <cvs@odoo.com>
2025-03-10 13:25:23 +00:00
Carlos Valverde
16e1bad7db [IMP] howto/website: update theming page
This commit updates current theming page, by adding new anchor links to
the sections and by adding updated information.

Task-4316611

closes odoo/documentation#12143

Signed-off-by: Carlos Valverde (cvs) <cvs@odoo.com>
2025-03-05 15:55:41 +00:00
Louis Baudoux
1a33d8ef2b [IMP] extract_api: few minor improvements/corrections
- Add links to the IAP documentation.
- Remove BMP from supported file format (it never was supported ?).
- Rewording of some descriptions in the `/parse` documentation.
- More consistent abbreviations for "IAP" and "OCR".

closes odoo/documentation#12239

Signed-off-by: Louis Baudoux (lba) <lba@odoo.com>
2025-03-05 15:55:40 +00:00
Louis Baudoux
56fa6da441 [IMP] extract_api: improve implementation example
- Since the example only works for invoices, references to the other
  document types supported by the OCR have been removed.
- Handle the case where library `requests` isn't available.
- Show additional fields detected by the OCR.
- Properly set the ID of the JSON-RPC request.
- Commit 8c93ff7 should have adapted the implementation example with the
  latest API version.

Part-of: odoo/documentation#12239
Signed-off-by: Louis Baudoux (lba) <lba@odoo.com>
2025-03-05 15:55:40 +00:00
Odoo's Mergebot
14c8b29ac9 [IMP] developer/reference/cli: neutralize option
closes odoo/documentation#11478

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
Co-authored-by: Chris Smith <cgsmith105@gmail.com>
Co-authored-by: Chris Smith <chris@cgsmith.net>
2025-02-25 10:35:52 +00:00
samueljlieber
97f9ae1b95 [FIX] clean unused resource files
Part-of: odoo/documentation#12010
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2025-02-13 08:44:14 +00:00
William Braeckman
de2241eb7c [IMP] developer/reference/cli: --limit-time-cron-conn
Document the newly created config option.

closes odoo/documentation#11779

See: https://github.com/odoo/odoo/pull/194141
Related: odoo/odoo#194141
Signed-off-by: William Braeckman (wbr) <wbr@odoo.com>
2025-01-22 12:21:44 +00:00
Joris Makauskis
8c93ff790e [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#11127

Signed-off-by: Joris Makauskis (jmak) <jmak@odoo.com>
2024-11-14 11:31:09 +00:00
xpl-odoo
efe4e4a4bc [IMP] upgrade: better introduce the upgrade process
closes odoo/documentation#10899

X-original-commit: fcf0b645d1
Signed-off-by: Xavier Platteau (xpl) <xpl@odoo.com>
2024-09-02 13:57:39 +00:00
Antoine Vandevenne (anv)
e41e618116 [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#10602

X-original-commit: 2be7fa1c98
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2024-08-12 16:12:43 +00:00
XPL
e16a66706a [IMP] settings: simplify the developer mode page
task-3849915

closes odoo/documentation#9208

X-original-commit: df888df654
Signed-off-by: Xavier Platteau (xpl) <xpl@odoo.com>
2024-05-07 13:49:33 +00:00
Victor Feyens
9865c8ee4e [FIX] dev/tutorials: typo
courtesy of @/ChloeLiang

closes odoo/documentation#9045

X-original-commit: 3e62a8c4cd
Signed-off-by: Victor Feyens (vfe) <vfe@odoo.com>
2024-04-29 15:29:05 +00:00
Alvaro Fuentes
91a48bfe88 [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.

closes odoo/documentation#8748

Signed-off-by: Victor Feyens (vfe) <vfe@odoo.com>
2024-04-18 10:25:30 +00:00
Mohamed Alkobrosli
91f0f5d194 [FIX] dev/assets: typo
the "py" letter should be "by" to make the syntax correct and understood.

closes odoo/documentation#8276

Signed-off-by: Victor Feyens (vfe) <vfe@odoo.com>
2024-03-21 12:41:50 +00:00
tiku-odoo
556ee18406 [IMP] developer: external api add admonition block
closes odoo/documentation#8214

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 13:10:32 +00:00
Jonathan Castillo (jcs)
32aafb08cb [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#8056

Signed-off-by: Jonathan Castillo (jcs) <jcs@odoo.com>
2024-03-11 13:59:04 +00:00
Claire Bretton (clbr)
e60affa6fe [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#8020

X-original-commit: 2d41fd7e0c
Signed-off-by: Claire Bretton (clbr) <clbr@odoo.com>
2024-03-06 07:55:42 +00:00
Tarek berkane
34e9ab6754 [FW][FIX] tutorials/getting_started: typo in 'estate'
closes odoo/documentation#7774

Forward-port-of: odoo/documentation#7772
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2024-02-19 17:20:47 +00:00
Augusto Perez
16a209c750 [ADD] Upgrade documentation: Upgrade scripts and Util package
closes odoo/documentation#7330

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2024-01-25 12:56:20 +00:00
Nathan Marotte (nama)
44f4683519 [ADD] Upgrade documentation: How-to-guide for developers
closes odoo/documentation#6757

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2024-01-10 17:25:59 +00:00
Julien Castiaux
4073e9dfb1 [FIX] developer/reference/cli: log on stderr
Odoo is actually logging on sys.stderr and not sys.stdout[^1][^2][^3].

Remove passage about the workflows, the workflows were an OpenERP
feature removed almost a decade ago in odoo/odoo@98cb4719db.

Fixes: #7210

[^1]: b3b9b2b49e/odoo/netsvc.py (L156)
[^2]: b3b9b2b49e/odoo/netsvc.py (L198)
[^3]: https://docs.python.org/3/library/logging.handlers.html#logging.StreamHandler

closes odoo/documentation#7259

X-original-commit: c55e8f251a
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
Signed-off-by: Julien Castiaux (juc) <juc@odoo.com>
2024-01-05 09:05:13 +00:00
Julien Castiaux
a2f895f644 [IMP] developer/reference/cli: --proxy-mode
Many customers struggle with their web server configuration, notably
regarding the `--proxy-mode` option and the way `X-Forwarded-*` HTTP
request headers are interpreted within Odoo.

The `--proxy-mode` section has been updated to cover the most common
misunderstandings and to give guidances on how to setup a web server.

Odoo always only takes the last entry of the `X-Forwarded-*` request
header because there are situations where it is not possible to
determine which last n-th entry to use. Employees might access their
odoo database via the internal network: connecting directly to nginx,
while customers might access the database via an additional proxy such
as cloudflare. The real IP of employees would be the last inside the
`X-Forwarded-For` chain, while the real IP of customers would be the
*second* last entry inside the chain. It would be incorrect to always
take the same nth last entry inside the chain. The cloudflare's own IP
address must be discarded from the chain. Web servers usually feature
a way to ignore trusted IP from the chain, a way so that the real IP
of the user is always the last entry inside the chain. Odoo relies on
such feature to be active and configured.

Prior discussions about `X-Forwarded-For`:
* odoo/odoo#104947
* odoo/odoo#118629
* odoo/odoo#139536

All `X-Forwarded-*` headers are ignored in case the `X-Forwarded-Host`
header is missing (even with `--proxy-mode`). System admin might be
tempted to not set this header and to set `Host` instead, this is
broken as this a user-agent would be able to spoof `X-Forwarded-Host`
and Odoo would use that instead of the correct `Host`.

Prior discussions about `X-Forwarded-Host`:
* odoo/odoo#63277
* odoo/odoo#70117

closes odoo/documentation#6738

X-original-commit: 3d91c57b57
Signed-off-by: Julien Castiaux (juc) <juc@odoo.com>
2023-12-03 08:27:52 +00:00
Claire Bretton (clbr)
620508fb29 [FIX] getting_started: remove useless lambda
The lambda function here is useless and makes newdooers think
they need to use it everytime.
`default=fields.Date.add(fields.Date.today(), months=3))`
should do the trick, no lambda involved.

closes odoo/documentation#6607

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2023-11-23 13:07:05 +00:00
Claire Bretton (clbr)
8707609b38 [FIX] getting_started: invalid addons-path
The "../technical-training-sandbox" is added too early in the path since
its still empty, and results into an "invalid addons-path" error.

Part-of: odoo/documentation#6607
2023-11-23 13:07:05 +00:00
Rémy Voet (ryv)
f1960a250c [IMP] orm: update changelog
closes odoo/documentation#1611

Signed-off-by: Rémy Voet (ryv) <ryv@odoo.com>
2023-11-15 10:40:22 +00:00
Louis Baudoux
282f041ed1 [IMP] iap: remove documentation related to IAP services creation
It has been decided to remove the possibility for our users to create
their own IAP services.
This decision was motivated by the fact that, in the 5 years of
existence of IAP, very few non-Odoo services have been created and
actively used by our customers.

X-original-commit: 0c1b7c4636
Part-of: odoo/documentation#6298
2023-11-07 16:10:04 +00:00
Louis Baudoux
9df648b4c7 [IMP] extract_api: document the new API version
We have introduced a second version of the Extract API that adds the IAP
account token to the `get_result` and `validate` routes.

There are also other changes in this commit:
 - The deprecated stuff has been removed as it's been deprecated for a
   while and won't be supported anymore in the future.
 - The `status` table of the `get_result` route has been added as it was
   missing for some reason.
 - The documentation regarding the `/validate` routes have been removed
   for security reasons.

closes odoo/documentation#6277

X-original-commit: a8c6272899
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
Signed-off-by: Louis Baudoux (lba) <lba@odoo.com>
2023-11-03 11:50:00 +00:00
Rémy Voet (ryv)
378252afdf [FIX] developer: fix bad documentation of --unaccent
In the CLI, `--unaccent` try to enable PostgreSQL unaccent extention
when odoo is responsible to create new database(s).

closes odoo/documentation#6238

X-original-commit: 1639d22efd
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
Signed-off-by: Rémy Voet (ryv) <ryv@odoo.com>
2023-10-31 07:00:57 +00:00
Mathieu Duckerts-Antoine
7a936c9f70 [FIX] search panel: fix bad indentation
closes odoo/documentation#6197

X-original-commit: 82055c1f15
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
Signed-off-by: Mathieu Duckerts-Antoine (dam) <dam@odoo.com>
2023-10-23 14:19:03 +00:00
Stan (stgu)
6f3ed657fc [IMP] howtos/translations: text & tips
Remove parenthesis around a term that's fairly straightforward to
understand and later used as a title Add a much-needed point.

closes odoo/documentation#5653

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2023-10-13 17:01:06 +00:00
Denis Ledoux
3b56832297 [FIX] qweb: type "overrinding"
overrinding -> overriding

closes odoo/documentation#6050

X-original-commit: d141144be5
Signed-off-by: Victor Feyens (vfe) <vfe@odoo.com>
2023-10-06 16:43:28 +00:00
Louis Baudoux
cade61dd56 [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#5984

Signed-off-by: Louis Baudoux (lba) <lba@odoo.com>
2023-10-05 11:24:20 +00:00
Louis Baudoux
24c7b2506e [REM] extract_api: remove documentation of get_result_batch
For security reasons, we had to drop the support of those routes.

Part-of: odoo/documentation#5984
2023-10-05 11:24:20 +00:00
dispread
407534595a [FIX] developer/tutorials: wrong kanban view example
Pretty sure the previous wasnt the intended result as it would show the "this is new" in a new kanban card. This just groups it with the property it belongs to.

closes odoo/documentation#5899

Signed-off-by: Victor Feyens (vfe) <vfe@odoo.com>
2023-09-25 09:03:54 +00:00
Leloup Loïc (lole)
12f3b1beb7 [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#5789

X-original-commit: 9fadc3355d
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2023-09-11 08:16:46 +00:00