Commit Graph

101 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
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
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
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
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
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
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
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
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
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
Mahmoud Metwally
9e6f4a8c56 [FW][FIX] howtos/company: fix typos
closes odoo/documentation#4176

Forward-port-of: odoo/documentation#4147
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2023-04-17 17:48:23 +02:00
Mahmoud Metwally
32c6bed34b [FW][FIX] developer/web_services: fix typo
closes odoo/documentation#4157

Forward-port-of: odoo/documentation#4146
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2023-04-14 12:47:22 +02:00
Tiffany Chang (tic)
7124542ed9 [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#4031

Task: 3226581
Signed-off-by: Tiffany Chang <tic@odoo.com>
2023-04-05 14:47:46 +02:00
fdardenne
7e4435deb8 [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#3969

Signed-off-by: Dardenne Florent (dafl) <dafl@odoo.com>
2023-04-04 16:06:19 +02:00
Antoine Vandevenne (anv)
95ed856446 [MOV] developer/api/external_api: move "External API" to the reference dir
task-2991663

Part-of: odoo/documentation#3655
2023-02-23 14:33:17 +01:00
Antoine Vandevenne (anv)
b817e16a4c [MOV] developer/api/iap: move "In-App Purchase" to the howtos dir
task-2991663

Part-of: odoo/documentation#3655
2023-02-23 14:33:16 +01:00
Antoine Vandevenne (anv)
2701d91db0 [MOV] developer/iot: move "Internet of things" the howtos dir
task-2991663

Part-of: odoo/documentation#3655
2023-02-23 14:33:16 +01:00
Antoine Vandevenne (anv)
2d469bccbc [MOV] howto/web: move "Customizing the webclient" to the tutorials dir
task-2991663

Part-of: odoo/documentation#3655
2023-02-23 14:33:16 +01:00
Antoine Vandevenne (anv)
58f2174c49 [MOV] howto/website: move "Building a website" to the tutorials dir
task-2991663

Part-of: odoo/documentation#3655
2023-02-23 14:33:15 +01:00
Antoine Vandevenne (anv)
642c4839f7 [MOV] howtos/backend: move "Building a module" to the tutorials dir
task-2991663

Part-of: odoo/documentation#3655
2023-02-23 14:33:15 +01:00
Antoine Vandevenne (anv)
9c5ea316ff [MOV] howtos/discover_js_framework/*: move "Discover the JS Framework" to the tutorials dir
task-2991663

Part-of: odoo/documentation#3655
2023-02-23 14:33:15 +01:00
Antoine Vandevenne (anv)
4f4e346953 [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

Part-of: odoo/documentation#3655
2023-02-23 14:33:14 +01:00
Jonathan Castillo (jcs)
17319f92b2 [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#3581

Signed-off-by: Castillo Jonathan (jcs) <jcs@odoo.com>
2023-02-15 12:51:21 +01:00
Amelia Williams
18b000602b [FIX] 02_setup: remove gramatical error
closes odoo/documentation#3579

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2023-02-15 11:46:43 +01:00
Mahmoud Metwally
7913fd7bdd [FW][FIX] developer/howtos: typos and phrasing
closes odoo/documentation#3555

Forward-port-of: odoo/documentation#3541
Signed-off-by: Victor Feyens (vfe) <vfe@odoo.com>
2023-02-13 14:53:07 +01:00
fdardenne
a70665ef34 [FIX] developer: remove merge text in chapter 6
closes odoo/documentation#3348

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2023-01-18 11:49:18 +01:00
stefanorigano (SRI)
2ca32b40bc [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 odoo/documentation#3093

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2023-01-12 18:19:27 +01:00
fdardenne
54628b4f5b [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 odoo/documentation#3222

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 16:00:50 +01:00
Mahmoud Metwally
9c9c20110c [FIX] rdtraining: fix writing errors
closes odoo/documentation#3266

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2023-01-03 19:07:18 +01:00
Antoine Vandevenne (anv)
8d94f66d81 [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: odoo/documentation#3260
2023-01-03 13:27:05 +01:00
oco-odoo
bf2d3d9ed2 [IMP] accounting: full documentation of the new report engine
Engine report for accounting.

closes odoo/documentation#2784

Taskid: 3042880
Signed-off-by: Castillo Jonathan (jcs) <jcs@odoo.com>
2022-12-21 16:55:24 +01:00
fdardenne
1bd7e803e0 [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 odoo/documentation#3177

Signed-off-by: Dardenne Florent (dafl) <dafl@odoo.com>
2022-12-14 17:56:07 +01:00
Horacio Tellez
924e6a2339 [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 odoo/documentation#3182

X-original-commit: 67a75a3e11
Signed-off-by: Horacio Tellez Perez (hote) <hote@odoo.com>
2022-12-12 09:55:44 +01:00
Antoine Vandevenne (anv)
fa2d0f6363 [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 odoo/documentation#3166

X-original-commit: 12e1085199
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-12-09 10:40:06 +01:00
fdardenne
c5c6daef22 [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 odoo/documentation#3105

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-08 16:43:13 +01:00
fdardenne
62051b643f [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 odoo/documentation#2845

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-01 18:04:17 +01:00
Victor Feyens
b2121b7891 [FIX] developer/*: code blocks linting & fixes
invalid xml
invalid python
correct indentation

closes odoo/documentation#3001

Signed-off-by: Victor Feyens (vfe) <vfe@odoo.com>
2022-11-24 21:38:37 +01:00
Victor Feyens
387cf15e7f [FIX] developer/*: consistent code-block language specification
Part-of: odoo/documentation#3001
2022-11-24 21:38:37 +01:00
Jeff Nyalik
e44a8c49bb [FIX] rdtraining: fix typo
Kind of a typo here " it will not possible" to "it will not be possible"

closes odoo/documentation#3016

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-11-23 18:39:58 +01:00
Victor Feyens
e9c26512e6 [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 odoo/documentation#3005

X-original-commit: 9cc60baf46
Signed-off-by: Victor Feyens (vfe) <vfe@odoo.com>
2022-11-21 20:12:45 +01:00
Victor Feyens
1b811f8de8 [FIX] *: unbalanced literal markups
Part-of: odoo/documentation#2983
2022-11-18 20:30:01 +01:00
Victor Feyens
c367974170 [FIX] *: remove trailing whitespaces
Part-of: odoo/documentation#2983
2022-11-18 20:30:01 +01:00
Victor Feyens
968ed0a17a [FIX] *: enforce 1 newline on files end
Part-of: odoo/documentation#2983
2022-11-18 20:30:00 +01:00
Elias
90513b30dc [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 odoo/documentation#2825

X-original-commit: e21dbd01c9
Signed-off-by: Victor Feyens (vfe) <vfe@odoo.com>
2022-10-18 12:53:39 +02:00
Victor Feyens
93b383e95d [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 odoo/documentation#2821

Signed-off-by: Victor Feyens (vfe) <vfe@odoo.com>
2022-10-17 23:02:34 +02:00
Xavier-Do
811510fbcb [ADD] developer/reference: add a reference page on performance
closes odoo/documentation#2793

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 13:13:02 +02:00
Aleksander
508b089f68 [FW][IMP] howtos/rdtraining: give the meaning of "ACL"
closes odoo/documentation#2778

Forward-port-of: odoo/documentation#2774
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-10-01 15:11:40 +02:00
Victor Feyens
c765ea9bad [REL] freeze 16.0 branch 2022-09-21 08:45:37 +02:00