Commit Graph

312 Commits

Author SHA1 Message Date
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
fdardenne
c1c04f90a8 [IMP] Views howtos: add details on how to use a view in arch
closes odoo/documentation#5773

Signed-off-by: Florent Dardenne (dafl) <dafl@odoo.com>
2023-09-08 11:22:35 +00:00
Odoo's Mergebot
d8e71d6063 [FIX] developer/tutorials/discover_js_framework: fix broken "domain.js" link
The link pointing to domain.js file was broken.
The xml id on the line before that is also broken but it will be fixed with PR#5699.

closes odoo/documentation#5702

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
Co-authored-by: Armin FalDiS <armin.fallah96@gmail.com>
Co-authored-by: Armin FalDiS <fara@odoo.com>
2023-09-01 16:10:49 +00:00
Andrea Tasselli
44ef78b391 [FIX] developer/tutorials/discover_js_framework: add missing this
closes odoo/documentation#5677

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2023-08-30 12:03:28 +00:00
Xavier (XPL)
32b92f5959 [FIX] install: fix reference and redirect
closes odoo/documentation#5547

X-original-commit: f1db43b3ac
Signed-off-by: Xavier Platteau (xpl) <xpl@odoo.com>
2023-08-19 00:14:55 +02:00
Xavier (XPL)
da2a48b9fd [REF] install: move intro to main install page and split by install type
This PR moves the introduction about the different installation methods and editions found on the
install/install.rst page directly under the main install/ page. It creates three pages, one per
installation method documented on the install/install.rst page (Docker being documented on
docker.com and maintained by us), and moves the related content there. In addition, it fixes various
typos/grammar issues and improves the content according to the documentation guidelines. Various
references and links across the documentation had to be fixed accordingly.

task-3459070

closes odoo/documentation#5526

X-original-commit: 42a8f492e7
Signed-off-by: Xavier Platteau (xpl) <xpl@odoo.com>
2023-08-18 09:50:42 +02:00
Antoine Vandevenne (anv)
bb04b18e7f [FIX] tutorials/getting_started: fix typos in example model name
Commit f36c612d13 changed the model name
in Chapter 4 without updating the other occurences.

closes odoo/documentation#5505

X-original-commit: b6f923d111
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2023-08-17 19:13:24 +02:00
imanie383
56eed9771e [FIX] reference/owl_components: fix typo
Making edits for Owl Components Doc : [Link](https://www.odoo.com/documentation/16.0/developer/reference/frontend/owl_components.html#example-multi-level-dropdown-nested)

![image](https://github.com/odoo/documentation/assets/35231827/b2dd4b87-941c-4241-b0f5-e91ca69b3633)

closes odoo/documentation#5459

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2023-08-11 14:43:56 +02:00
Levi Siuzdak (sile)
a7743d513b [IMP] developer: add notes on entity references & fix illegal XML
Using `<` inside XML elements will result in a parsing error,
an entity reference should be used instead: `&lt;`.

closes odoo/documentation#5159

Signed-off-by: Levi Siuzdak (sile) <sile@odoo.com>
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2023-07-24 14:37:53 +02:00
chyde-clearwater
bd434b0528 [IMP] tutorials/getting_started: disambiguate example model name
I removed the dot notation in the  "_name" variable for the example
model. AKA, "test.model" is now named "test_model".

Dot notation implies a data structure relationship between a <model> and
it's parent (or class etc) <test> (like test.model() or Test.model).
There is no relationship like this between a <test> and <model> - it's
just one thing: a <test model>.

The seeming "benefit" of the ORM translating dots to underscores doesn't
justify this naming convention.  Yes, I know it's a string, but still,
this seems confusing for newbies and adds unnecessary complexity (why
name the same thing differently in different places?)

closes odoo/documentation#5137

X-original-commit: f36c612d13
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2023-07-18 12:53:34 +02:00
Henrique Dias
0a65b0872d [ADD] rpc: Go examples
Examples rely on `kolo/xmlrpc` as well as on the standard library package `log` to panic on error, matching snippets in other languages (which tend to raise exceptions).

As with other languages, only the RPC interaction is spelled out.

closes odoo/documentation#5064

Signed-off-by: Xavier Morel (xmo) <xmo@odoo.com>
2023-07-14 10:11:48 +02:00
Marc Durepos
c85031b3fc [FIX] Remove reference to assets_qweb in assets.rst
Reflects the fact that assets_qweb bundle is no longer used in 16.0

closes odoo/documentation#5094

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2023-07-13 10:40:51 +02:00
Benoit Socias
1c98265c95 [FIX] howto/rdtraining: ch.13 adapt reference to salesperson field
In chapter 13 the `property_ids` field is defined as the inverse of a
`user_id` field. But in chapter 8 when the salesperson field is added,
no such name is given to it.

This commit adapts the description to reference the general concept of
the field used to link to the salesperson instead of an actual field
identifier.

task-3381757

closes odoo/documentation#4905

X-original-commit: 3a131c829a
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2023-06-27 16:07:02 +02:00
Benoit Socias
77fe26c390 [IMP] developer/views: add optional attribute for fields of list views
The attributes of fields of list views do not mention the `optional`
attribute while it is used by chapter 12 of the R&D Training.

This commit describes this `optional` attribute.

task-3380953

closes odoo/documentation#4904

X-original-commit: 5a446f5c59
Signed-off-by: Benoit Socias (bso) <bso@odoo.com>
2023-06-27 16:07:00 +02:00
Christophe Monniez
eb6c567ee2 [FIX] deploy: reference the config parameter
The deploy documentation is assuming that `/etc/odoo.conf` is the
default config file, which is not the case.

With this commit, the configuration file references the cli
documentation.

closes odoo/documentation#4804

X-original-commit: 8aed7988ba
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
Signed-off-by: Christophe Monniez (moc) <moc@odoo.com>
2023-06-20 15:42:14 +02:00
Jonathan Castillo (jcs)
ebeebbcd45 [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#4470

Signed-off-by: Castillo Jonathan (jcs) <jcs@odoo.com>
2023-05-20 08:26:00 +02:00
CVDE-odoo
892fd3e2ac [ADD] developer/howto: guide for theming
A complete guide on how to create a custom website theme for Odoo

closes odoo/documentation#4399

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
Signed-off-by: Castillo Jonathan (jcs) <jcs@odoo.com>
2023-05-11 20:37:08 +02:00
Antoine Vandevenne (anv)
26e12696c1 [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#4402

X-original-commit: 276f981703
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2023-05-11 11:29:46 +02:00
Antoine Vandevenne (anv)
c1b38dc1f3 [FIX] reference/services: mark optional the params parameter of rpc
closes odoo/documentation#3994

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2023-04-27 11:30:29 +02:00
Antoine Vandevenne (anv)
b58dbb1fbb [IMP] tutorials/js_framework: reword, clarify and improve instructions
Part-of: odoo/documentation#3994
2023-04-27 11:30:29 +02:00
Antoine Vandevenne (anv)
6e746c851f [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.

Part-of: odoo/documentation#3994
2023-04-27 11:30:29 +02:00