Compare commits

...

554 Commits

Author SHA1 Message Date
Sam Lieber (sali) 67a7dbd607 [IMP] marketing: sms pricing and faq doc updates
X-original-commit: 1591e1f087
2023-02-16 14:13:54 -05:00
Brandon Seltenrich (BRSE) 7169946cba [IMP] inventory: update automated inventory valuation
closes odoo/documentation#3601

X-original-commit: aaa1de94bd
Signed-off-by: Brandon Seltenrich (brse) <brse@odoo.com>
2023-02-16 19:13:34 +01:00
Jonathan Castillo (jcs) c5434ccd0a [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#3568

Signed-off-by: Castillo Jonathan (jcs) <jcs@odoo.com>
2023-02-14 14:27:44 +01:00
LoredanaLrpz 295d29effd [IMP] pos: rename & redo receipt page (structure, text, images)
Task ID: 3005121

Do not merge for Odoo 16 - configuration flow to modify

closes odoo/documentation#3429

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2023-02-14 11:17:33 +01:00
Victor Feyens 7c027ea367 [FIX] *: typos
closes odoo/documentation#3547

X-original-commit: 831cf23be9
Signed-off-by: Victor Feyens (vfe) <vfe@odoo.com>
2023-02-13 14:54:55 +01:00
Victor Feyens 2e13740363 [ADD] tests: add sphinxlint checkers for headings
task-2801043

X-original-commit: ad768c33aa
Part-of: odoo/documentation#3547
Co-authored-by: Antoine Vandevenne (anv) <anv@odoo.com>
2023-02-13 14:54:55 +01:00
Mahmoud Metwally 784963e89d [FIX] developer/howtos: typos and phrasing
closes odoo/documentation#3541

Signed-off-by: Victor Feyens (vfe) <vfe@odoo.com>
2023-02-13 12:51:54 +01:00
Jonathan Castillo (jcs) 323110f676 [MOV] finance: move fiscal localisation pages and merge /overview/
The content written in the fiscal localisation pages are not only for
Accounting, but also for other apps such as Payroll and Point of Sales.
This commit moves the content to the "Finance" level, to better reflect
this reality, and merges the pages in the /overview/ folder in the main
category page.

closes odoo/documentation#3537

Signed-off-by: Castillo Jonathan (jcs) <jcs@odoo.com>
2023-02-13 11:55:25 +01:00
Odoo Translation Bot 08fb17e689 [I18N] Update translation terms from Transifex 2023-02-13 08:21:07 +01:00
Jonathan Castillo (jcs) f270587a12 [FIX] *: first small clean of the code
Friday afternoon cleanup. 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#3538

Signed-off-by: Castillo Jonathan (jcs) <jcs@odoo.com>
2023-02-10 21:00:03 +01:00
“Chiara ec0fae4992 [IMP] accounting/l10n: Italian Localization
closes odoo/documentation#3522

Taskid: 3067241
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
Signed-off-by: Castillo Jonathan (jcs) <jcs@odoo.com>
2023-02-09 18:31:52 +01:00
Donatienne Pirlot 546db0647f [ADD] accounting: localization page for uk
closes odoo/documentation#3515

X-original-commit: 0550374968
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
Signed-off-by: Pirlot Donatienne (dopi) <dopi@odoo.com>
2023-02-09 16:16:03 +01:00
Martin Trigaux 5c368b7af3 [I18N] migrate to the nex transifex API
Tansifex is deprecating it's client and switches to a go-based
solution in its API v3

The new client is still backward compatible with the old format but
the v2 API is going to be phased out.
See https://github.com/transifex/cli to install the deplyments using
the tx client

This PR is the result of the "tx migrate" command

closes odoo/documentation#3514

X-original-commit: 040ceeb39c
Related: odoo/odoo#112269
Related: odoo/enterprise#36853
Signed-off-by: Martin Trigaux (mat) <mat@odoo.com>
2023-02-09 14:11:53 +01:00
Zachary Straub (ZST) 063f035712 [FIX] Quality: add missing/cutoff content
closes odoo/documentation#3487

X-original-commit: 591e80deb7
Signed-off-by: Victor Feyens (vfe) <vfe@odoo.com>
Signed-off-by: Zachary Straub <zst@odoo.com>
2023-02-06 20:23:17 +01:00
Odoo Translation Bot 4051d25179 [I18N] Update translation terms from Transifex 2023-02-05 01:40:41 +01:00
Simon Goffin 4102ca51f5 [FIX] content: The outlook add-in URL
The outlook add-in URL was not updated

opw:3131547

closes odoo/documentation#3469

Signed-off-by: Victor Feyens (vfe) <vfe@odoo.com>
2023-02-02 18:34:05 +01:00
Mahmoud Metwally 65347b99b4 [FIX] developer/javascript_reference: typos and phrasing
closes odoo/documentation#3470

Signed-off-by: Victor Feyens (vfe) <vfe@odoo.com>
2023-02-02 15:18:41 +01:00
Sam Lieber (sali) 616347b8c7 [ADD] Quality: configure quality control checks
closes odoo/documentation#3462

X-original-commit: ec1ddb34b1
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
Signed-off-by: Samuel Lieber (sali) <sali@odoo.com>
2023-02-01 22:05:44 +01:00
Zachary Straub (ZST) e5069dbf72 [IMP] inventory: add a note on default warehouses
closes odoo/documentation#2979

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2023-02-01 10:21:39 +01:00
Donatienne Pirlot 75e1bfd099 [MOV] purchase: moving doc page from accounting to purchase
Moving the Manage vendor bills page from the accounting app to the purchase app as it is
more relevant.

closes odoo/documentation#3452

Taskid: 2687652
X-original-commit: b5febf2299
Signed-off-by: Zachary Straub <zst@odoo.com>
2023-01-31 23:34:13 +01:00
thkl-odoo 57d25c5af2 [IMP] install/maintain: clarification in the upgrade SLA
The Service Level Agreement has to be updated. Any additional line of
code, without using studio, in standard modules is not supposed to be
covered by the upgrade team. It is slightly different than the point
telling "development of custom modules"

closes odoo/documentation#3446

X-original-commit: f469e4ef81
Signed-off-by: Castillo Jonathan (jcs) <jcs@odoo.com>
2023-01-31 20:06:38 +01:00
Martin Trigaux ea03bc8e1a [I18N] *: export 15.0 translations 2023-01-31 11:27:58 +01:00
Melanie Nguyen (meng) 2f63a0d504 [IMP] sales: fix returns and refunds
closes odoo/documentation#3433

X-original-commit: 2fb777e3e8
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
Signed-off-by: Melanie Nguyen (meng) <meng@odoo.com>
2023-01-30 19:46:42 +01:00
Odoo Translation Bot 8da25bd443 [I18N] Update translation terms from Transifex 2023-01-29 01:40:36 +01:00
Jonathan Castillo (jcs) 9a0bf7bb0e [IMP] accounting: update how to get api keys for silverfin integration
task 2918697

closes odoo/documentation#3416

Signed-off-by: Castillo Jonathan (jcs) <jcs@odoo.com>
2023-01-27 10:18:01 +01:00
avg-odoo ff3b7c6c87 [IMP] install/maintain: update content of upgrade SLA
The maintenance fees cover the maintenance of the custom code (whoever
did it) and are not specifically dedicated to custom code written by
Odoo development teams

closes odoo/documentation#3418

X-original-commit: 92de7ccb2d
Signed-off-by: Castillo Jonathan (jcs) <jcs@odoo.com>
2023-01-26 23:09:53 +01:00
KC (ksc) 39d3a985b8 [IMP] surveys:update get started docs
closes odoo/documentation#3412

X-original-commit: 3cf6e25f06
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
Signed-off-by: Kevin Scannell (ksc) <ksc@odoo.com>
2023-01-26 21:57:45 +01:00
Mathieu (mano) 64fc72b6ca [IMP] toctrees: redesign and new card component
The goal of this commit is to propose a first step towards a new
`.. card::` directive for the toctrees. This is a first design
proposition for this new card component in raw html for the fallback
page `howtos.rst`

The long term objective is to redesign the toctrees by implementing card
components, clearer toctree list design and custom html pages.

Related to task-3059229

closes odoo/documentation#3404

X-original-commit: c59663f252
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2023-01-26 19:08:44 +01:00
Donatienne Pirlot 14db4ca8e0 [IMP] : accounting : manage a financial budget documentation
closes odoo/documentation#3397

X-original-commit: 78d3cf489a
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
Signed-off-by: Pirlot Donatienne (dopi) <dopi@odoo.com>
2023-01-26 07:58:40 +01:00
Jess Rogers (jero) 518e599c15 [IMP] helpdesk: close_ticket.rst cleanup
closes odoo/documentation#3384

X-original-commit: 8396c2a4ad
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
Signed-off-by: Jessica Rogers (jero) <jero@odoo.com>
2023-01-24 19:29:42 +01:00
Nishant Jain (niai) 97e914b340 [ADD] accounting/l10n: add section about E-waybill (India)
closes odoo/documentation#3333

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2023-01-24 11:52:09 +01:00
Odoo Translation Bot 48b30c8f53 [I18N] Update translation terms from Transifex 2023-01-22 01:40:46 +01:00
nle-odoo cea0760ba5 [FIX] developer/guidelines: odoo addons import order
The example for import order is a little confusing since it is wrong.

closes odoo/documentation#3377

X-original-commit: f7b1f66b8c
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
Signed-off-by: Nicolas Lempereur (nle) <nle@odoo.com>
2023-01-20 14:35:42 +01:00
LoredanaLrpz cef6e16e3c [IMP] POS: improve and update the barcode page (text & screenshots)
Task ID: 3004918

closes odoo/documentation#3361

X-original-commit: 8138b95b0b
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
Signed-off-by: Perazzo Loredana (lrpz) <lrpz@odoo.com>
2023-01-20 14:35:39 +01:00
Antoine Vandevenne (anv) 9ecf013684 [IMP] supported_versions: add end of support dates for SaaS versions
closes odoo/documentation#3362

X-original-commit: ebce333c73
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2023-01-19 17:52:09 +01:00
Martin Trigaux 6f4fc09026 [I18N] *: update 15.0 source terms 2023-01-19 16:36:13 +01:00
Jonathan Castillo (jcs) 7f6535dcc8 [ADD] accounting: configuration of silverfin integration
task-2918697

closes odoo/documentation#3354

Signed-off-by: Castillo Jonathan (jcs) <jcs@odoo.com>
2023-01-18 18:27:37 +01:00
Ray Carnes 3b8b49e248 [IMP] sales: update portal.rst
Removed old and probably not needed image of the dashboard showing the Contacts App

closes odoo/documentation#3341

X-original-commit: 4d3a10e8cd
Signed-off-by: Zachary Straub <zst@odoo.com>
2023-01-16 20:45:28 +01:00
Odoo Translation Bot c020078eb2 [I18N] Update translation terms from Transifex 2023-01-15 01:40:40 +01:00
Martin Trigaux f9c56a8546 [IMP] conf: prepare for building documentation in Romanian 2023-01-13 15:19:27 +01:00
Wesley Kao (weka) 79e08557d3 [IMP] MRP: edited semi-finished products user doc
closes odoo/documentation#2787

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2023-01-13 12:01:03 +01:00
Donatienne Pirlot cc0285144a [ADD] accounting: add documentation related to the Kenyan localization
closes odoo/documentation#3227

Id: 3089195
Signed-off-by: Pirlot Donatienne (dopi) <dopi@odoo.com>
2023-01-13 08:18:54 +01:00
Elisabeth Dickinson f88f7eb97f [IMP] odoo_theme: Fix alerts and accordions colors
closes odoo/documentation#3317

X-original-commit: 8aebb79237
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2023-01-12 08:15:54 +01:00
Elisabeth Dickinson a01d90a1e2 [IMP] odoo_theme: Fix text-dark on homepage
While doing the changes on the text-dark issue, we noticed the
homepage's text color isn't aligned with the rest of the website.
`.text-muted` was too light, so we changed it to `.text-dark`.

X-original-commit: ee2390fdaf
Part-of: odoo/documentation#3317
2023-01-12 08:15:54 +01:00
Elisabeth Dickinson 1e73db0aa1 [IMP] odoo-theme: Revert $dark color variable to initial $gray-900
This was changed to get a good text/background contrast on the
alert-dark (Exercise).
By doing so, the .text-dark class generated by BS from the $dark
theme-color was gray instead of the intended near-black color.

By changing the variable, the contrast issue with the alert was back,
to solve this we directly override the alert's background color instead.

X-original-commit: 32c9e59ae6
Part-of: odoo/documentation#3317
2023-01-12 08:15:53 +01:00
Sam Lieber (sali) ff9d710a11 [ADD] maintain: connect office365 with azure oauth
closes odoo/documentation#3221

Signed-off-by: Zachary Straub <zst@odoo.com>
2023-01-10 20:57:52 +01:00
Olivier Dony 0eb7a795c4 [CHG] legal: partnership contract v10 (update SH commission)
note: version not bumped for ES translation, since it needs other updates
first

opw-3094638

closes odoo/documentation#3310

X-original-commit: 39ce411f76
Signed-off-by: Olivier Dony (odo) <odo@odoo.com>
2023-01-09 17:20:26 +01:00
Odoo Translation Bot 13b818b037 [I18N] Update translation terms from Transifex 2023-01-08 01:40:37 +01:00
Sam Lieber (sali) 197a1cc932 [ADD] maintain: setup mailjet api
closes odoo/documentation#3178

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2023-01-06 11:21:14 +01:00
Antoine Vandevenne (anv) c1ea2dfff1 [FIX] odoo_theme: re-enable redirect fallback logic
closes odoo/documentation#3294

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2023-01-05 10:52:33 +01:00
Mahmoud Metwally 8cde1f7b74 Update qweb.rst
closes odoo/documentation#3246

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2023-01-04 11:03:06 +01:00
Odoo's Mergebot 387fbc1eff [MERGE] odoo_theme: SCSS code clean up
In order to reduce the size of our css files:
Some unused or repeated code was found and removed.
Variables have been cleaned up, the way the admonitions (alerts) were created has been modified,

Expanding the use of BS variables in order to reduce repeated code and to stay consistent in the general design.
Sphinx was updated which made some changes in the DOM, breaking some of the CSS:
the literals for example, these have been fixed in this PR.
The font sizes were breaking the typescale, this has been fixed by modifying the typescale
rather than hardcoding font sizes.

closes odoo/documentation#3268

Forward-port-of: odoo/documentation#3225
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2023-01-04 09:52:22 +01:00
Sam Lieber (sali) 389cf97be7 [FIX] maintain: correct cname definition
closes odoo/documentation#3277

X-original-commit: 96cbb2375b
Signed-off-by: Castillo Jonathan (jcs) <jcs@odoo.com>
2023-01-04 00:30:10 +01:00
Jason (jaae) 614b981799 [IMP] project: adding description to app page
closes odoo/documentation#3270

X-original-commit: cfaf4386c2
Signed-off-by: Castillo Jonathan (jcs) <jcs@odoo.com>
2023-01-03 23:27:56 +01:00
Elisabeth Dickinson d1f2e20190 [IMP][CSS] Replace text-decoration on link with BS override 2023-01-03 18:30:40 +01:00
Elisabeth Dickinson 8eee40ed98 [IMP][CSS] Reorder styles according to styles guidelines 2023-01-03 18:30:40 +01:00
Elisabeth Dickinson cefc0ecd46 [IMP] fix typo 2023-01-03 18:30:40 +01:00
Elisabeth Dickinson 37467f7440 [IMP] icon fixes 2023-01-03 18:30:40 +01:00
Elisabeth Dickinson 10dc23cda0 [IMP][CSS] Fix unresponsive font-size on alert text
By removing $font-size-sm on the alerts, the text is bigger. The title
text and its icon have been increased as well.
2023-01-03 18:30:40 +01:00
Elisabeth Dickinson 57912a18f2 [IMP][CSS] Remove browser prefixes and unnecessary mixins 2023-01-03 18:30:40 +01:00
Elisabeth Dickinson 713b134327 [IMP][CSS] Fix literals in alerts containing tabs 2023-01-03 18:30:40 +01:00
Elisabeth Dickinson 2196189453 [IMP][CSS] Fix data indentation 2023-01-03 18:30:40 +01:00
Elisabeth Dickinson d475404e05 [IMP][CSS] Fix alignment on modal btn-close 2023-01-03 18:30:40 +01:00
Elisabeth Dickinson 7cc86314c6 [IMP] Indentation fix 2023-01-03 18:30:40 +01:00
Elisabeth Dickinson 3c7ab6b46e [REM] Removal of changelog
The idea was not developed and it has since been decided not to do it.
2023-01-03 18:30:40 +01:00
Elisabeth Dickinson 5534245b21 [IMP][CSS] Use BS font-weight variables and fix
Instead of redefining font-weights, we override the BS variables and add
one extra font-weight in the newly-introduced extended utilities file.
After this change all the variables needed replacing and some tweaking
was needed to get the same or closely similar result as before this
change.

By doing so the font-weight classes in the typography file were obsolete
and hence removed.
Some other font-weight issues which were already there have been fixed
in this commit too.
2023-01-03 18:30:40 +01:00
Elisabeth Dickinson b9727457ce [IMP][CSS] Fix color variable issue 2023-01-03 18:30:40 +01:00
Elisabeth Dickinson 585e3bfb8e [IMP][CSS] Revamp of the .o_spoiler element to use same code as alerts 2023-01-03 18:30:40 +01:00
Elisabeth Dickinson 8020cbf564 [IMP][CSS]Change order of imported scss files
The aim of this cleanup is to use as many bootstrap classes, functions
and utilities as possible to reduce the amount of extra code.
Instead of redefining variables, BS variables are overridden in the
bootstrap_overridden file.

In order to be able to reuse these overridden variables within our own
custom variable file — and after consultation with SRI — it was
determined that the variables.scss file should come after the bootstrap
files in the order of importation, unlike the order of odoo website's
scss files.

Changes to variables in bootstrap_overridden have been made to adapt to
the new structure.
2023-01-03 18:30:40 +01:00
Elisabeth Dickinson 750c43d0cf [IMP][CSS] Use CSS variables to style different alert types
CSS variables avoid having to repeat code for each alert type.
Also remove the need to add "tip" to the theme-colors (no need for "tip"
styled buttons, badges etc, especially as tips use the primary color) by
styling `.alert-tip` with customized copy of BS alert mechanism.

In order to be able to modify the icons with a CSS variable,
the `content` attribute has been removed from the `o-inline-icon` mixin.
Code where this mixin is called in other places has been adapted.
2023-01-03 18:30:40 +01:00
Elisabeth Dickinson ff5ac57e1d [IMP][CSS] Place overrides in bootstrap_overridden file 2023-01-03 18:30:40 +01:00
Elisabeth Dickinson d856ff21e8 [IMP][CSS] Clean up the file according to conventions
Includes reordering styles, renaming variables ($o-*),
re-indenting lines, removing commented code
2023-01-03 18:30:40 +01:00
Elisabeth Dickinson 2223c6c885 [IMP][CSS] Set gray background to it's original darker color 2023-01-03 18:30:40 +01:00
Elisabeth Dickinson 103bf34cc1 [IMP][CSS] Improve literals styling (o_code, .sig-*) 2023-01-03 18:30:40 +01:00
Elisabeth Dickinson 944de07592 [IMP][CSS] Update _sphinx_basic.css after update of Sphinx
Note: Some code is commented instead of being deleted.
This allows us to keep track of what should be commented out in future
versions of Sphinx' basic CSS.
2023-01-03 18:30:40 +01:00
Elisabeth Dickinson 56f681d1ba [IMP][CSS] Remove repetitive or unnused CSS 2023-01-03 18:30:40 +01:00
Elisabeth Dickinson c634afd40e [IMP][CSS] Improve margins on headings and sections 2023-01-03 18:30:40 +01:00
Elisabeth Dickinson 2bedf3711b [IMP][CSS] Replace margin and padding values with variables 2023-01-03 18:30:40 +01:00
Elisabeth Dickinson 950b714c92 [IMP][CSS] Revamp modal to use all BS classes and variables 2023-01-03 18:30:40 +01:00
Elisabeth Dickinson e94a132e1a [IMP][CSS] Rescale heading fonts 2023-01-03 18:30:40 +01:00
Elisabeth Dickinson f35e8482f8 [IMP][CSS] Cleanup font variables 2023-01-03 18:30:40 +01:00
Elisabeth Dickinson 5b6705fecc [IMP][CSS] Cleanup admonitions (alerts) 2023-01-03 18:30:40 +01:00
Elisabeth Dickinson 0f911e984b [IMP][CSS] Cleanup color variables 2023-01-03 18:30:40 +01:00
Elisabeth Dickinson c51edecd28 [IMP][CSS] update literals styles (.o_code, .sig-*) 2023-01-03 18:30:40 +01:00
Antoine Vandevenne (anv) fe894ad110 [IMP] odoo_theme: add the class o_code on literals
The SCSS that styles the `literal`, `code`, `file`, and `command` roles
is excessively complex because the traduction from RST to HTML is not
consistent from one role to another: some use `<code>` elements, some
have the `code` class, some wrap the literal with a `span` element.

This commit sets the `o_code` class on all of these roles' parent node
at translation time to allow simplifying the SCSS target.
2023-01-03 18:30:36 +01:00
Mahmoud Metwally 840b97cb49 [FIX] rdtraining: fix writing errors
closes odoo/documentation#3250

X-original-commit: ad91dd67c2
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2023-01-03 10:56:22 +01:00
Antoine Vandevenne (anv) e3972349f4 [FIX] odoo_theme: handle non-TOC pages when expanding top menu entries
Trying to "expand" those pages lead to a crash that prevented the menu
to be shown at all.

Incidentally, this commit also handles menus built with `make fast`.

closes odoo/documentation#3252

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2023-01-02 18:47:57 +01:00
Antoine Vandevenne (anv) dca158c867 [IMP] odoo_theme: scroll the active menu entry into view
In large and deeply nested TOCs like finance/accounting/fiscal_localizations/localizations/...
the user had to constantly scroll the menu to the menu entry they just
clicked because the expanded menu would not fit entirely on the page.
With this commit, the active menu entry is scrolled into view each time
the page is reloaded.

The previous behavior was also the reason for expanding the top menu
entries on only the homepage. Thanks to the scroll, they now always
expand.

Part-of: odoo/documentation#3252
2023-01-02 18:47:57 +01:00
Antoine Vandevenne (anv) c919778f0a [IMP] README: remove version from links and rephrase explanations
task-2897123

closes odoo/documentation#3249

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2023-01-02 18:47:52 +01:00
Antoine Vandevenne (anv) 2e96c049fe [IMP] contributing/documentation: rewrite the contribution guide
This commit restructures the contributing/documentation page to re-use
content introduced with the contributing/development page and to
display the two ways to contribute (github vs git) in content tabs
rather than sections.

The guide is simplified and updated to delegate long explanations to
other pages or websites, remove useless images and focus on getting
users ready to contribute.

task-2897123

Part-of: odoo/documentation#3249
2023-01-02 18:47:52 +01:00
Antoine Vandevenne (anv) beb0317832 [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#3249
2023-01-02 18:47:51 +01:00
Martin Trigaux 0e556f5bc2 [I18N] *: update source terms 2023-01-02 10:23:53 +01:00
Odoo Translation Bot 14b7746cd9 [I18N] Update translation terms from Transifex 2023-01-01 01:40:21 +01:00
Antoine Vandevenne (anv) c8f8164943 [FIX] odoo_theme: update the aria attributes when scrolling the page TOC
The 'aria-expanded' attribute was not correctly updated on the `i` tag
when the user scrolled through the page TOC. This caused a minor issue
where an arrow (`i`) that was collapsed manually with a click would no
longer automatically expand afterward.

task-3106339

closes odoo/documentation#3235

X-original-commit: f068065d39
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-12-27 13:04:22 +01:00
Antoine Vandevenne (anv) a179595415 [IMP] odoo_theme: expand top level menu items on the homepage
When the user browses the homepage, it might be hard to figure out
where they want to go next. Expanding the top-level menu items could
help them with that.

task-3106339

X-original-commit: 5526f1ea07
Part-of: odoo/documentation#3235
2022-12-27 13:04:22 +01:00
Michelle Vu (mivu) 5979a772e6 [IMP] Calendar: Outlook sync warning
If committed, this will add a more elaborate warning on what users must
do before syncing Odoo Calendar and Outlook Calendar. It also removes
mentions of the import/export process and archiving events, as these
methods will not prevent email spam from Outlook.

closes odoo/documentation#2925

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-12-27 10:28:40 +01:00
Odoo Translation Bot 77145fce1c [I18N] Update translation terms from Transifex 2022-12-25 01:40:19 +01:00
Odoo Translation Bot bec0453a33 [I18N] Update translation terms from Transifex 2022-12-18 01:40:14 +01:00
LoredanaLrpz fb5c128fb7 [IMP] POS: upgrade the getting started page for 15.0
Task ID: 3090486
Do not fw to 16.0 without making other changes

closes odoo/documentation#3094

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-12-16 15:25:01 +01:00
Victor Feyens d14f802c8f [FIX] core: latex build
* latest droid package does not allow \usepackage{droid} anymore,
replace it with the right package

See https://github.com/MiKTeX/miktex-packaging/issues/136

* remove reference to package texlive-generic-recommended since
it's not available nor necessary since ubuntu 20.04.

closes odoo/documentation#3200

X-original-commit: 816f437064
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
Signed-off-by: Victor Feyens (vfe) <vfe@odoo.com>
2022-12-16 00:58:41 +01:00
Antoine Vandevenne (anv) 3af62b0a59 [FIX] legal: fix path to PDF version of legal agreements
closes odoo/documentation#3196

X-original-commit: 73021c3a41
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-12-15 19:52:48 +01:00
Sam Lieber (sali) 54b903e512 [IMP] general: add notes about dev mode toggle
closes odoo/documentation#3143

X-original-commit: dc3d43c143
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-12-15 17:56:52 +01:00
Zachary Straub (ZST) df041b1212 [IMP] email: add mail.default.from_filter
closes odoo/documentation#2694

Signed-off-by: Victor Feyens (vfe) <vfe@odoo.com>
2022-12-15 17:56:46 +01:00
Tom Aarab (toaa) 3337ffa6c7 [IMP] odoo.sh: Python libraries and packages
Added a note on packages and extensions support

closes odoo/documentation#3184

Taskid: 2836438
X-original-commit: b1f92ba879
Signed-off-by: Aarab Tom (toaa) <toaa@odoo.com>
2022-12-13 09:02:44 +01:00
Horacio Tellez 3c9b87be30 [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#3179

X-original-commit: 67a75a3e11
Signed-off-by: Horacio Tellez Perez (hote) <hote@odoo.com>
2022-12-12 10:10:44 +01:00
Odoo Translation Bot 594f052a2b [I18N] Update translation terms from Transifex 2022-12-11 01:40:13 +01:00
KC (ksc) ec61b2eeb0 [ADD] marketing automation: added 'getting started' section and docs to round out documentation
closes odoo/documentation#3158

X-original-commit: 4f6b03dc5b
Signed-off-by: Victor Feyens (vfe) <vfe@odoo.com>
2022-12-08 17:19:07 +01:00
Antoine Vandevenne (anv) 5dcf9f7e86 [IMP] contributing: list the ways to contribute to Odoo
task-2897123

closes odoo/documentation#3151

X-original-commit: a309372d83
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
Signed-off-by: Castillo Jonathan (jcs) <jcs@odoo.com>
2022-12-08 16:10:24 +01:00
Antoine Vandevenne (anv) 359ab4d028 [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#3142

X-original-commit: 0b9279d5
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-12-08 11:46:38 +01:00
Donatienne Pirlot 7a57fb3c81 [IMP] accounting: different ways to record a payment
closes odoo/documentation#3141

Signed-off-by: Castillo Jonathan (jcs) <jcs@odoo.com>
2022-12-08 10:38:19 +01:00
Morgane (morm) 4259241ffd [IMP] documentation: legal page design
Prior to this commit, the terms and conditions were displayed in a table
with all the languages and it was not practical for the futur, with many
more languages.

task-3073198

closes odoo/documentation#3122

X-original-commit: b7bc34a197
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-12-07 15:21:24 +01:00
jopa-odoo 4d48da0840 [IMP] legal/fr: fix typos, spellcheck French translation
No changes to actual contents/semantics.

closes odoo/documentation#2941

X-original-commit: b085e06303
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-12-07 15:21:19 +01:00
“Chiara 1492cf810a [ACC] accounting: Forecasting bills
closes odoo/documentation#3121

Tasikd: 3069519
X-original-commit: 939d40c16d
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
Signed-off-by: chiaraprattico <chpr@odoo.com>
2022-12-07 13:14:59 +01:00
Zachary Straub (ZST) 2416a2e5e9 [IMP] CRM: updating flow and screenshots about lead mining
Task: 2543815
Cherry pick from #998

Omitted changes proposed in the **track_leads** directory (e.g. `lead_scoring.rst` + image folder). Both the content and image updates were already pushed from another PR so what was proposed on #998 was outdated and no longer necessary.

What’s left over are the original proposed changes in #998, within the **acquire_leads** directory which include updates to `lead_mining.rst` and corresponding image files.

On top of these proposals, I went ahead and made the following changes:

- renamed the image files in the asset directory, since they were using outdated naming convention (e.g. LM1.png, LM6.png, LM7.png)
- cleaned up rst formatting issues (headings, line breaks, added guilabels, etc.)
- rewrote document so content was more concise + followed content guidelines. You can see the first version of proposals here to compare the changes made.

closes odoo/documentation#3118

X-original-commit: 02ef871fa6
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-12-07 11:15:52 +01:00
“Chiara 632be6ef37 [IMP] accounting: tax return
closes odoo/documentation#3113

X-original-commit: 1db9968faa
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
Signed-off-by: chiaraprattico <chpr@odoo.com>
2022-12-06 17:02:19 +01:00
Melanie Nguyen (meng) 88e00bf021 [IMP] mail plugins: gmail plugin updates
Updated to reflect how to download Gmail Plugin from Google Workspace Marketplace for Odoo Online users; added new images

Closes Odoo Task 3001713

closes odoo/documentation#2773

Signed-off-by: Victor Feyens (vfe) <vfe@odoo.com>
2022-12-06 14:01:50 +01:00
Morgane (morm) 6ba5660133 [FIX] documentation: tabs responsiveness
Prior of this commit, the tabs were not responsive in the documentation

closes odoo/documentation#3076

X-original-commit: c9a001d22b
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-12-06 12:33:56 +01:00
Sam Lieber (sali) efb165d791 [IMP] accounting/l10n: AR update documentation
closes odoo/documentation#2430

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-12-06 11:17:37 +01:00
“Chiara 5628762fae [IMP] accounting: SEPA
closes odoo/documentation#2849

Taskid: 2890089
Signed-off-by: Platteau Xavier (xpl) <xpl@odoo.com>
2022-12-05 13:24:04 +01:00
Tom Aarab (toaa) d774094e87 [IMP] paypal: typo update
V14 has a dedicated "Fees" tab for PayPal, current documentation does not reflect that.

closes odoo/documentation#3077

Taskid: 3089273
Signed-off-by: Castillo Jonathan (jcs) <jcs@odoo.com>
2022-12-02 19:11:25 +01:00
Tom Aarab (toaa) 870fb0ba54 [IMP] payment provider: minor phrasing
Changed phrasing on main page, based on PR #2775

Forward to 15.3.

closes odoo/documentation#3075

Taskid: 3089294
Signed-off-by: Castillo Jonathan (jcs) <jcs@odoo.com>
2022-12-02 18:17:13 +01:00
LoredanaLrpz f2b8645a3c [IMP] pos: update and improve the page and screenshots
closes odoo/documentation#3064

Taskid: 3062150
X-original-commit: 1ee45c661f
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
Signed-off-by: Perazzo Loredana (lrpz) <lrpz@odoo.com>
2022-12-02 10:21:48 +01:00
“Chiara 528d16c611 [IMP] accounting: update payments by check
closes odoo/documentation#2934

Taskid: 3062532
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-12-01 17:56:16 +01:00
Jonathan Castillo (jcs) 45d92b4f19 [IMP] contribution: typo in documentation.rst
closes odoo/documentation#3052

X-original-commit: f0fa7a2e22
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
Signed-off-by: Castillo Jonathan (jcs) <jcs@odoo.com>
2022-11-30 14:48:44 +01:00
Antoine Vandevenne (anv) d12de44508 [IMP] contributing/documentation: suggest to clone with ssh
GitHub requires users to "use token-based authentication for all
authenticated operations", for example `git push`. See
https://github.blog/2020-12-15-token-authentication-requirements-for-git-operations/

This commit suggests new contributors to clone the repository with SSH
so that the remote URL is automatically configured with the SSH
protocol.

task-3036845

closes odoo/documentation#3038

X-original-commit: dfb7801484
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-11-29 16:08:28 +01:00
“Chiara c0c3aed14b [IMP] accounting: batch payments sdd
Forward to 16.0

closes odoo/documentation#3031

X-original-commit: fe2d694aff
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
Signed-off-by: chiaraprattico <chpr@odoo.com>
2022-11-28 09:45:57 +01:00
Odoo Translation Bot e0cb1a7884 [I18N] Update translation terms from Transifex 2022-11-27 01:40:43 +01:00
Ivan Kropotkin 38dc4ceca5 [FIX] developer/reference: code example
closes odoo/documentation#2943

Signed-off-by: Victor Feyens (vfe) <vfe@odoo.com>
2022-11-24 16:31:39 +01:00
Loan (lse) 4b0b29e0fd [IMP] point_of_sale: Adyen Event URLs configuration
Add more details as of how to set Adyen Event URLs.
This is important to configure as it is necessary to
receive a callback from Adyen terminal when a transaction
have been done.

OPW-3041117
OPW-3041117

closes odoo/documentation#3018

X-original-commit: aa9126b037
Signed-off-by: Castillo Jonathan (jcs) <jcs@odoo.com>
2022-11-23 20:38:09 +01:00
Tori (vpk) 0a0c4123a5 [ADD] Sales: new doc about returns and refunds
Task Number: 2514789

closes odoo/documentation#2985

X-original-commit: be0a995e21
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-11-23 18:17:55 +01:00
Donatienne Pirlot 2cb96db57c [IMP] upgrade: updating screenshots and process steps
closes odoo/documentation#3011

X-original-commit: f0f6083ee5
Signed-off-by: Castillo Jonathan (jcs) <jcs@odoo.com>
2022-11-22 20:50:43 +01:00
Victor Feyens 6b38785b75 [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#3002

X-original-commit: 9cc60baf46
Signed-off-by: Victor Feyens (vfe) <vfe@odoo.com>
2022-11-21 19:15:38 +01:00
Wesley Kao (weka) 426b66ec7b [IMP] MRP: updated Kits doc rst content
Went through the existing kits documentation and changed a lot of the
content, as much of it was outdated. Also replaced the images with new
ones.

closes odoo/documentation#2720

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-11-21 10:44:38 +01:00
Sam Lieber (sali) ce1d0b216d [ADD] discuss: specific email server from
closes odoo/documentation#2627

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-11-21 09:44:49 +01:00
Odoo Translation Bot 71319c2d04 [I18N] Update translation terms from Transifex 2022-11-20 01:40:41 +01:00
Victor Feyens 2a933246dd [FIX] developer/mobile: use spaces and not tabs for indentation
closes odoo/documentation#2980

Signed-off-by: Victor Feyens (vfe) <vfe@odoo.com>
2022-11-18 17:32:59 +01:00
Victor Feyens f1216a9f59 [FIX] *: unbalanced literal markups
Part-of: odoo/documentation#2980
2022-11-18 17:32:59 +01:00
Victor Feyens c24d780387 [FIX] *: remove trailing whitespaces
Part-of: odoo/documentation#2980
2022-11-18 17:32:59 +01:00
Victor Feyens cf2b1b934d [FIX] *: enforce 1 newline on files end
Part-of: odoo/documentation#2980
2022-11-18 17:32:58 +01:00
Odoo Translation Bot 49599fb95f [I18N] Update translation terms from Transifex 2022-11-17 10:26:51 +01:00
Martin Trigaux d088a8e788 [I18N] *: export 15.0 source terms 2022-11-17 10:23:24 +01:00
Victor Feyens 5128208495 [CLN] core: upgrade to python 3.6
& sort imports

closes odoo/documentation#2957

X-original-commit: 8a5aa384d3
Signed-off-by: Victor Feyens (vfe) <vfe@odoo.com>
2022-11-15 20:19:10 +01:00
Tom Aarab (toaa) 5ec67044a8 [ADD] accounting: manage cash transactions
New page to document cash reconciliation, and fixed other H1 titles that should have
 been in small caps. Forward up to V15.

task id: 3000530

closes odoo/documentation#2956

X-original-commit: 0d2dd59349
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
Signed-off-by: Aarab Tom (toaa) <toaa@odoo.com>
2022-11-15 20:19:07 +01:00
Wesley Kao (weka) 1645e8c3da [IMP] MRP: updated bills of materials rst content
Reviewed the 15.0 doc for Bills of Materials and made some edits to
clean up inconsistencies and made minor wording changes.

closes odoo/documentation#2611

Signed-off-by: Zachary Straub <zst@odoo.com>
2022-11-15 20:18:56 +01:00
jopa-odoo 1575a67268 [IMP] Legal: Update Dutch translation
Update of the Dutch translation of Odoo Enterprise Subscription agreemnt
2022-11-15 17:47:17 +01:00
Donatienne Pirlot d36bacb54a [IMP] accounting: update the doc related to internal transfers
closes odoo/documentation#2702

Id: 2901915
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-11-15 10:52:48 +01:00
Loan (lse) 37ec1bbd48 [IMP] iot: Add part regarding screen
Add  more details as of how to connect a screen to the IoT box
and how it can be used.

OPW-2962462

closes odoo/documentation#2936

X-original-commit: 21edc4fcc7
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-11-14 10:27:04 +01:00
Odoo Translation Bot 7bee76fa13 [I18N] Update translation terms from Transifex 2022-11-13 01:40:18 +01:00
Tom Aarab (toaa) 9c4e08c2b0 [IMP] accounting: updated chart of accounts v15
Creating account groups part was outdated.

task id: 2950820

closes odoo/documentation#2929

X-original-commit: 60ad93ea31
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
Signed-off-by: Aarab Tom (toaa) <toaa@odoo.com>
2022-11-10 17:10:39 +01:00
Tom Aarab (toaa) 655818a51f [IMP] TaxCloud: updated doc
Changed out-of-date function and updated doc/changed grammar. Forward up to 16 (16 exluded)

task id: 2909436

closes odoo/documentation#2904

X-original-commit: 7cf109db1e
Signed-off-by: Platteau Xavier (xpl) <xpl@odoo.com>
2022-11-08 10:46:08 +01:00
Tom Aarab (toaa) ba39ecdb62 [IMP] accounting: updated multiple payments page
Previous page was based on V13. Forward up to 16.

closes odoo/documentation#2915

Taskid: 3045197
X-original-commit: e4839ea7e9
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-11-07 16:36:45 +01:00
Odoo Translation Bot 1a208b7e78 [I18N] Update translation terms from Transifex 2022-11-06 01:40:24 +01:00
Tom Aarab (toaa) de7fddab6c [IMP] accounting: updated bank statement page
Previous version used V13 screenshots.

task - 2902004

closes odoo/documentation#2373

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-11-04 18:40:54 +01:00
“Chiara 6af8a4d01d [IMP] accounting: Bank Synchronization: automatic import
closes odoo/documentation#2896

X-original-commit: 7fb5a21d64
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-11-02 18:27:06 +01:00
Xavier 5ad9d5eb0b [ADD] Studio: PDF reports
closes odoo/documentation#2832

Id: 2978638
Signed-off-by: Platteau Xavier (xpl) <xpl@odoo.com>
2022-11-02 14:23:58 +01:00
Odoo Translation Bot 958914c35d [I18N] Update translation terms from Transifex 2022-10-30 01:40:24 +02:00
Antoine Vandevenne (anv) 340e90b5c2 [IMP] extensions/spoilers: add an extension for spoilers
It is often needed in developer tutorials to show excerpts of code for
examples and solutions. This takes quite some page space and, for the
latter, it is not always desired to show the final code result right
after the exercise objective.

This commit adds a spoiler feature to the documentation to allow hiding
content until the reader wants to display it.

The feature relies on the new `.. spoiler:: Button label` directive.

task-3036845

closes odoo/documentation#2873

X-original-commit: 4d7a88639a
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
Co-authored-by: Morgan Meganck <morm@odoo.com>
Co-authored-by: Stefano Rigano <sri@odoo.com>
2022-10-28 13:53:20 +02:00
stefanorigano (SRI) 2ce86088a4 [IMP] odoo_theme: add default BS functions
Prior to this change it was not possible to use Bootstrap default SCSS
functions in 'bootstrap_overridden.scss'.

This commit mirrors odoo framework's architecture, injecting bootstrap
'_functions.scss' at the beginning of the documentation's SCSS "bundle".

Commit preparatory to the introduction of the 'Spoiler' documentation
component.

task-3036845

X-original-commit: 1691e8970b
Part-of: odoo/documentation#2873
2022-10-28 13:53:19 +02:00
Tom (toaa) 5c83679a02 [IMP] accounting: reconciliation models
Updated reconciliation page. Forward to V15.

closes odoo/documentation#2868

Taskid: 3043106
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
Signed-off-by: Castillo Jonathan (jcs) <jcs@odoo.com>
2022-10-28 12:54:28 +02:00
Donatienne Pirlot 285252d1fd [IMP] accounting: update the bank accounts documentation
ID:2607774

closes odoo/documentation#2417

Signed-off-by: Castillo Jonathan (jcs) <jcs@odoo.com>
2022-10-28 11:50:27 +02:00
Donatienne Pirlot 8770938a97 [IMP] accounting: update and improve the cash basis taxes documentation
closes odoo/documentation#2500

Id: 2381690
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-10-28 10:52:07 +02:00
Olivier Dony cc4d03f565 [IMP] legal: OE v10a - clarified wording for Section 5.1
The "(at that time") wording could be confusing - the goal was really to
refer to the price at the time of the deviation, not the price at the
conclusion of the agreement. This should be clearer.

Validated with SBR.
2022-10-27 18:13:58 +02:00
Victor Feyens 87a76ebdce [FIX] developer/guidelines: do not mention deprecated xml tags
act_window & report xml tags have been deprecated by
https://github.com/odoo/odoo/commit/6835aeb0de6895f7f4d6b23e0b4654465ef21d6a
two years ago, we should avoid mentioning them in the guidelines.

Furthermore, in 17.0 they won't be available anymore.

closes odoo/documentation#2858

X-original-commit: 758463edd4
Signed-off-by: Victor Feyens (vfe) <vfe@odoo.com>
2022-10-25 19:13:41 +02:00
Zachary Straub (ZST) ac3ec17266 [IMP] inventory: thd batch updates
closes odoo/documentation#2556

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-10-25 15:24:04 +02:00
Odoo Translation Bot 88eb812c2c [I18N] Update translation terms from Transifex 2022-10-23 01:40:23 +02:00
Jonathan Castillo (jcs) eae71e6eda [IMP] *: Remove "SaaS" to keep only the "Odoo Online" appellation
task-3034812

closes odoo/documentation#2833

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
Signed-off-by: Castillo Jonathan (jcs) <jcs@odoo.com>
2022-10-21 13:51:54 +02:00
Jonathan Castillo (jcs) 121516d52c [IMP] *: consistency for the use of "Odoo Online" (and SaaS)
task-3034812

Part-of: odoo/documentation#2833
2022-10-21 13:51:54 +02:00
Olivier Dony 33477b68eb [IMP] legal: make PDF links relative
This way we don't need to update the links nor risk a desynchronization
between the version of the PDF and the HTML.

Previously version 15.0 and 16.0 still referenced the 14.0 PDFs
(which are the same at the moment, but still...)
2022-10-19 19:10:03 +02:00
Olivier Dony c2b1650d13 [FIX] legal: enterprise terms FR fall 2022 pricing typo 2022-10-19 18:52:56 +02:00
“Friederike 6bdf36d5cd [FIX] legal: enterprise terms DE translation update (v9c) 2022-10-19 18:52:52 +02:00
Elias e21dbd01c9 [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#2790

Signed-off-by: Victor Feyens (vfe) <vfe@odoo.com>
2022-10-18 11:14:39 +02:00
Odoo Translation Bot 3c9c8bdac9 [I18N] Update translation terms from Transifex 2022-10-16 01:40:22 +02:00
Olivier Dony a7ba2e3001 [CHG] legal: enterprise terms for fall 2022 pricing
- removal of "per app" notion
- addition of "subscription plan" notion
2022-10-13 12:18:15 +02:00
Antoine Vandevenne (anv) 11e08bb2e2 [IMP] supported_version: release 16.0 and deprecate 13.0
closes odoo/documentation#2810

X-original-commit: 3c61d24b1d
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-10-11 21:10:48 +02:00
Odoo Translation Bot acc2bea09b [I18N] Update translation terms from Transifex 2022-10-09 01:40:19 +02:00
Xavier-Do 4d8e3f9785 [ADD] developer/reference: add a reference page on performance
closes odoo/documentation#1180

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
Co-authored-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-10-06 11:21:48 +02:00
Odoo Translation Bot b9448b4cb0 [I18N] Update translation terms from Transifex 2022-10-02 01:40:22 +02:00
Tom Aarab (toaa) f3ef72f1f5 [FIX] payment providers: ogone parameter value typo
Fixed a typo in the ogone documentation

task id: 3001021

closes odoo/documentation#2772

Signed-off-by: Castillo Jonathan (jcs) <jcs@odoo.com>
2022-09-30 11:19:52 +02:00
Aleksander 43621e7042 [IMP] howtos/rdtraining: give the meaning of "ACL"
closes odoo/documentation#2774

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-09-30 10:18:45 +02:00
Jonathan Quique (jqu) 7b21e6001b [IMP] email_communication: can't use Odoo STMP with another mail server
Customer may want to use their own SMTP for email marketing, and Odoo default SMTP for everything else. There is no good way to do this. Previously we suggested adding Odoo SMTP as an outgoing email server but we don't want to share credentials anymore.
R&D is working on a solution (e.g. showing the Odoo default email server in the list rather than keeping it as an "hidden feature") but for the time being, if you use an outgoing email server, you give up using the Odoo default SMTP.

closes odoo/documentation#2741

X-original-commit: d1317812e1
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-09-28 17:52:47 +02:00
Wesley Kao (weka) b3d5e928aa [IMP] MRP: updated Variants BOM Management rst content
closes odoo/documentation#2648

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-09-27 11:32:39 +02:00
Odoo Translation Bot c9550dd711 [I18N] Update translation terms from Transifex 2022-09-25 01:40:34 +02:00
Fabrice Henrion f21b31b18a [FIX] accounting: grammar fix in ponto
closes odoo/documentation#2755

X-original-commit: dad110c7cc
Signed-off-by: Castillo Jonathan (jcs) <jcs@odoo.com>
2022-09-23 11:09:19 +02:00
Tom Aarab (toaa) 149353cf72 [IMP] accounting: update + merge of multiple multi-currency pages
task id: 2942040

closes odoo/documentation#2559

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
Co-authored-by: Jonathan Castillo (jcs) <jcs@odoo.com>
2022-09-20 17:28:26 +02:00
Jonathan Quique (jqu) 1b7ec7ca20 [FIX] sales/crm: fix menu path and RST formatting
Cherry-pick of #2652:
>To view the Sales Team dashboard, go to `:menuselection:CRM --> Sales --> Teams.`

closes odoo/documentation#2731

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-09-20 15:10:51 +02:00
Tori (vpk) 0338a9f005 [ADD] Sales: adding doc about variants in orders
closes odoo/documentation#2732

Task: 2574874
X-original-commit: 05d10ab355
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-09-20 10:55:55 +02:00
Odoo Translation Bot ce0cb8f1d8 [I18N] Update translation terms from Transifex 2022-09-18 01:40:41 +02:00
Claire Bretton (clbr) 5e3dbc0201 [IMP] developer/howtos/rdtraining: Add missing information about module category.
Adds explanations and directive for module category creation, so it can be used correctly at res.groups creation.

closes odoo/documentation#2726

X-original-commit: 338fe297b0
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-09-16 15:58:49 +02:00
Max 980edde1e5 [IMP] developer/backend: correct filters attribute for calendar view fields
closes odoo/documentation#2692

Signed-off-by: Victor Feyens (vfe) <vfe@odoo.com>
2022-09-15 14:15:45 +02:00
Julien Castiaux 79e58e3db1 [IMP] developer/api/external_api: XML-RPC in PHP8
Starting PHP8, the XML-RPC extension is not available by default
anymore and must be installed separately.

closes odoo/documentation#2481

Task: 2613818
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-09-14 10:26:51 +02:00
Julien Castiaux 83c2e6de0b [IMP] content/developer/webservices
It is hard to find and learn about RPC in Odoo, users hardly know about
JSON-RPC as the only place where we talk about it in deep down in the
*How to make a Module* tutorial.

In the commit, we isolated the tutorial about RPC in a dedicated file,
that file is better referenced thanks to cross-references in some others
places that are talking about RPC

Task: 2884559
Part-of: odoo/documentation#2481
2022-09-14 10:26:51 +02:00
Xavier ff807ecbc3 [ADD] accounting: data inalterability check report
Task ID: 2977343

closes odoo/documentation#2713

X-original-commit: 1d48967962
Signed-off-by: Victor Feyens (vfe) <vfe@odoo.com>
2022-09-13 12:17:26 +02:00
Tori (vpk) f2cb70a40e [IMP] Sales: updating product variants overview and config
closes odoo/documentation#2708

Task: 2055940
X-original-commit: 01878ac966
Signed-off-by: Victor Feyens (vfe) <vfe@odoo.com>
2022-09-13 12:17:23 +02:00
std-odoo 2a01b21800 [IMP] mail: add documentation about the SSL SMTP authentication
Purpose
=======
Add the documentation about the SSL SMTP authentication
(2 new binary arguments) and also about the new from
filter binary argument.

The goal of those new arguments is to improve the score
of the emails sent by Odoo.

Task 2367946
See odoo/odoo/pull/61853
See odoo/upgrade/pull/1903

closes odoo/documentation#973

Signed-off-by: Victor Feyens (vfe) <vfe@odoo.com>
2022-09-12 14:09:40 +02:00
Odoo Translation Bot 68e53fffd4 [I18N] Update translation terms from Transifex 2022-09-11 01:40:32 +02:00
Valentin Vallaeys (vava) ba27d0ecd7 [FIX] coding_guidelines: fix typos and add sql contraints
task-2977263

closes odoo/documentation#2698

X-original-commit: 8061470577
Signed-off-by: Victor Feyens (vfe) <vfe@odoo.com>
Signed-off-by: Castillo Jonathan (jcs) <jcs@odoo.com>
2022-09-08 16:04:27 +02:00
Jonathan Castillo (jcs) b4c3c19175 [IMP] acc/l10n: minor change in mexico/pre-requirements
task-2971754

closes odoo/documentation#2688

X-original-commit: 8d482c831e
Signed-off-by: Castillo Jonathan (jcs) <jcs@odoo.com>
2022-09-06 13:25:48 +02:00
Donatienne Pirlot b823d55e09 [IMP] accounting: update the information on recording payments
closes odoo/documentation#2682

Id: 2258464
X-original-commit: 3fb1e9f9fe
Signed-off-by: Castillo Jonathan (jcs) <jcs@odoo.com>
2022-09-05 17:35:49 +02:00
Jonathan Castillo (jcs) c9833bcf14 [IMP] install/maintain: add note about mailboxes in domain_names
task-2973080

closes odoo/documentation#2677

X-original-commit: 9089a78602
Signed-off-by: Castillo Jonathan (jcs) <jcs@odoo.com>
2022-09-05 13:26:59 +02:00
Odoo Translation Bot 64691bca68 [I18N] Update translation terms from Transifex 2022-09-04 01:40:33 +02:00
frin-odoo 073d5207e2 [IMP] crm: grammar on google_spreadsheets
closes odoo/documentation#2666

X-original-commit: f39a43f697
Signed-off-by: Castillo Jonathan (jcs) <jcs@odoo.com>
2022-09-02 14:40:44 +02:00
Jonathan Castillo (jcs) 3083c2dbe6 [IMP] accounting/l10n: table with list of modules to install Luxembourg
closes odoo/documentation#2664

Signed-off-by: Castillo Jonathan (jcs) <jcs@odoo.com>
2022-09-02 13:42:43 +02:00
Nidhi Patel 028c67041b [ADD] accounting/l10n: new localization page for India
closes odoo/documentation#1940

Signed-off-by: Castillo Jonathan (jcs) <jcs@odoo.com>
Co-authored-by: Jonathan Castillo <jcs@odoo.com>
2022-09-01 21:43:50 +02:00
Martin Trigaux 55c06a75ce [I18N] *: export 15.0 source terms 2022-09-01 17:13:24 +02:00
William Henrotin ae928a9ace [FIX] inventory: fix typo
closes odoo/documentation#2651

X-original-commit: 1a10dced12
Signed-off-by: Castillo Jonathan (jcs) <jcs@odoo.com>
2022-08-31 16:34:28 +02:00
Zachary Straub (ZST) 4dbee7ac1f [IMP] finance/accounting: add Delivery Guide to CL localization
closes odoo/documentation#2643

X-original-commit: a6f2c55896
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-08-30 13:55:02 +02:00
Tom Aarab (toaa) 603c041f5b [IMP] accounting: updated foreign currency page
Foreign currency page was V13 only and outdated. Updated for V14.

task - 2904025

closes odoo/documentation#2636

X-original-commit: 0ba09280ad
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
Signed-off-by: Castillo Jonathan (jcs) <jcs@odoo.com>
2022-08-26 16:28:05 +02:00
Jonathan Castillo (jcs) f484e64eed [FIX] accounting: new tutorial link in payment_terms
task-2963526

closes odoo/documentation#2631

X-original-commit: 99519c93cb
Signed-off-by: Castillo Jonathan (jcs) <jcs@odoo.com>
2022-08-26 15:16:26 +02:00
Tom Aarab (toaa) 51954e0eb9 [IMP] accounting: fixed one-word mistake on B2B/B2C page
V13/14 only. Create fw-bot request for V15

task id: 2960682

closes odoo/documentation#2621

X-original-commit: bc7c65fbf6
Signed-off-by: Castillo Jonathan (jcs) <jcs@odoo.com>
2022-08-26 11:29:43 +02:00
Odoo Translation Bot 1168ba6bc9 [I18N] Update translation terms from Transifex 2022-08-21 01:40:25 +02:00
Julian Roussieau 3592c76ec5 [FIX] odoo_sh: change img who explain storage space
closes odoo/documentation#2613

X-original-commit: f52be8da2a
Signed-off-by: Castillo Jonathan (jcs) <jcs@odoo.com>
2022-08-19 14:15:02 +02:00
poma-odoo d204fe743f [FIX] developer/frontend: small typos
closes odoo/documentation#2584

Signed-off-by: Victor Feyens (vfe) <vfe@odoo.com>
2022-08-18 14:17:41 +02:00
Moens Alexandre ea41b02474 [IMP] maintain : process for odoo.sh to odoo online
Correction to a typo that made the line completly nonsensical and made
people think that they could migrate just part of the database.

opw-2947684

closes odoo/documentation#2601

X-original-commit: a92671bd85
Signed-off-by: Castillo Jonathan (jcs) <jcs@odoo.com>
2022-08-18 13:05:30 +02:00
Jonathan Castillo (jcs) 44c2f924cf [FIX] iot: typo in devices/scale
task-2956495

closes odoo/documentation#2595

X-original-commit: 81a23de57d
Signed-off-by: Castillo Jonathan (jcs) <jcs@odoo.com>
2022-08-18 11:47:02 +02:00
Antoine Vandevenne (anv) 8bcaa08531 [IMP] stripe: clarify the conditions for the support of a payment method
Even though the documentation was correct, it was confusing the reader
to state that local payment methods are considered enabled if their
related payment icon record does not exist in the database. The intended
meaning was that this statement only holds if the local payment method
is also supported, otherwise it cannot be enabled.

closes odoo/documentation#2588

X-original-commit: 80a9cfb68f
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-08-17 18:11:14 +02:00
Odoo Translation Bot 5d3aff317e [I18N] Update translation terms from Transifex 2022-08-14 01:40:26 +02:00
Donatienne Pirlot 0f42b4c94f [IMP] accounting: further information to be added regarding EDI
closes odoo/documentation#2573

Id: 2857860
Signed-off-by: Victor Feyens (vfe) <vfe@odoo.com>
2022-08-09 11:10:10 +02:00
Wesley Kao (weka) 394ceaadea [IMP] inventory and mrp: capitalized "MRP" in toctree
In the toctree, "MRP" wasn't capitalized in "Inventory & MRP."
Affects all branches, can be forward ported.

closes odoo/documentation#2562

X-original-commit: 8c665643ce
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
Signed-off-by: Castillo Jonathan (jcs) <jcs@odoo.com>
2022-08-09 11:10:08 +02:00
Michelle Vu (mivu) 30a38d23d0 [IMP] helpdesk: update field names and screenshots
In Odoo v15, the field names for "Timesheet on Ticket" and "Time
Reinvoicing" changed to "Timesheets" and "Time Billing", respectively.
The "Tickets" button on the project card is also no longer available in
Odoo v15. Updated the RST file to reflect these changes, and also
updated screenshots to match.

Fixes PR #2094
Closes Odoo Task 2870115

closes odoo/documentation#2486

Signed-off-by: Victor Feyens (vfe) <vfe@odoo.com>
2022-08-09 11:10:02 +02:00
Donatienne Pirlot 241ee8a6ee [ADD] accounting: creation of electronic invoicing documentation
closes odoo/documentation#2568

Id: 2857860
X-original-commit: 73204e6789
Signed-off-by: Victor Feyens (vfe) <vfe@odoo.com>
2022-08-08 14:02:56 +02:00
Odoo Translation Bot 7ed49b1008 [I18N] Update translation terms from Transifex 2022-08-07 01:40:41 +02:00
Antoine Vandevenne (anv) 68762e9856 [IMP] install: guide the user through the login page
Developers sometimes have a hard time making the difference between the
PostgreSQL user and the internal user. They would try to log into Odoo's
web client with their PostgreSQL credentials rather than with admin. See
https://reddit.com/r/Odoo/comments/w8zubf/logging_in_on_source_install.

closes odoo/documentation#2544

X-original-commit: 4558be3a5e
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-08-01 18:03:00 +02:00
Antoine Vandevenne (anv) 1c4d9ced44 [IMP] rdtraining: mention that the second part needs to be completed too
closes odoo/documentation#2537

X-original-commit: 9279fb80a7
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-08-01 15:53:35 +02:00
Odoo Translation Bot 54f79d5ee4 [I18N] Update translation terms from Transifex 2022-07-31 01:40:37 +02:00
Xavier c8ea9703f7 [IMP] studio: complete update of Studio
The goal is to make the Studio users doc a sort of encyclopedia to accompany tutorials.
The doc isn't to explain the basics - or just briefly, as introductions - but instead to
give a full overview of all the available options.

closes odoo/documentation#1974

Task: 2817981
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-07-28 09:41:41 +02:00
Tom Aarab (toaa) b064a7ed6b [IMP] payment providers: ingenico documentation updated
This is a new documentation for the Ingenico payment provider, as support received a lot of tickets from customers having issues setting-up ingenico properly.

task - 2834329

closes odoo/documentation#2117

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-07-25 17:03:16 +02:00
Victor Feyens 86cfcd5246 [CLN] rdtraining: remove reference to unexisting file
The referenced `bypass.py` file isn't specified anywhere in
the training documentation or code content.

The paragraph is removed to avoid meaningless searches and
confusing trainees.

This commit also adds a missing parenthese in the preceding
code content.

Fixes #2488

closes odoo/documentation#2519

X-original-commit: 1c4abe4e07
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-07-25 15:52:11 +02:00
Odoo Translation Bot 569898c7d8 [I18N] Update translation terms from Transifex 2022-07-24 01:40:43 +02:00
Martin Trigaux c1e062c1f4 [I18N] *: export 15.0 source terms 2022-07-22 11:37:58 +02:00
Benoit Socias 3c984344d9 [IMP] rdtraining: update float utils information
The warning about float utils does not state where to find them, and
they are preceded by an example in the code that infringes the warning's
recommendation.

This commit indicates where to find the float utils and replaces the
example by one that uses them.

task-2925402

closes odoo/documentation#2508

X-original-commit: b8ee134a28
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-07-20 15:30:58 +02:00
Benoit Socias 44688c1e6a [IMP] install: troubleshoot typical problems for Mac users
As mentioned in [1], because of [2], some python implementation for Mac
fail on startup with default parameters.

Also, when installing requirements, the psycopg requirement can fail
because the $PATH does not contain the postgresql tools installed with
the .app.

This commit provides instructions to avoid those issues.

[1]: https://github.com/odoo/odoo/issues/79112
[2]: https://bugs.python.org/issue40518

task-2922249

closes odoo/documentation#2501

X-original-commit: 77f4b4b307
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-07-19 11:36:03 +02:00
Romain Derie 0d01565ac3 [FIX] website: warn about google api deprecation
Google deprecated both its "Universal Analytics" and "Google Sign-In"
API. See community counterpart commit for a detailed explanation and
links.

closes odoo/documentation#2487

X-original-commit: e13d2517b2
Related: odoo/odoo#96118
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
Signed-off-by: Romain Derie (rde) <rde@odoo.com>
2022-07-18 19:18:45 +02:00
Stanislas Sobieski 14a42cb9bb [IMP] install/maintain: update info about upgrade process on Odoo.sh
closes odoo/documentation#2490

Id: 2744270
X-original-commit: 815acb64c4
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
Signed-off-by: Pirlot Donatienne (dopi) <dopi@odoo.com>
Co-authored-by: Stanislas <sts@odoo.com>
Co-authored-by: Donatienne <dopi@odoo.com>
2022-07-18 14:04:57 +02:00
Odoo Translation Bot af6f4ba045 [I18N] Update translation terms from Transifex 2022-07-17 01:40:23 +02:00
Victor Feyens 60adfacbc9 [FIX] accounting_localization: use relative paths in csv-table's option
The `file` option for the `csv-table` directive expects relative file
paths rather than absolute file paths since Sphinx 4. Since this was the
only usage of the `ODOO_ABSPATH` placeholder, it is removed with this
commit.

Task - 2898477

closes odoo/documentation#2362

Signed-off-by: Victor Feyens (vfe) <vfe@odoo.com>
2022-07-14 17:38:42 +02:00
Victor Feyens 217dba8bbe [IMP] conf.py, requirements.txt, *: allow building with Python 3.10
- Bump Sphinx version to 4.3.2 (default for Debian Jammy).
- Remove the retrocompatibility for Sphinx < 3.5 (warnings are raised in
  4.5).
- Fix translator issue crashing builds.
- Unpin jinja2 from the requirements as the base issue is solved in sphinx 4

Task - 2898477

Part-of: odoo/documentation#2362
2022-07-14 17:38:42 +02:00
Michelle Vu (mivu) f28f77b397 [IMP] helpdesk: clarify postpaid support and delete mentions of tasks
If committed, this will delete mentions of project tasks in the "Invoice
Time Spent on Tickets (Postpaid Support Services)" v14.0 user doc. It
also deletes unnecessary steps and screenshots about creating and
configuring a new Project and updates the steps and screenshots for the
"Create a sales order" and "Link the Helpdesk ticket to the SO" sections.

Fixes PR #1901
Closes Odoo Task 2870104

closes odoo/documentation#2473

X-original-commit: 521cee8aa0
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-07-14 11:39:10 +02:00
Sam Lieber (sali) a0f472dbe2 [ADD] maintain: google oauth doc
Added document and media files on the setup of Google Gmail using OAuth with Odoo.

closes odoo/documentation#2470

X-original-commit: 9b75dfd2ac
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-07-14 11:39:07 +02:00
Antoine Vandevenne (anv) df8250f736 [REF] legal: convert the table from a grid to a list table
Prior to this commit, the /legal.html page relied on RST substitutions
to insert the images directives of legal agreements within the table.
This caused Sphinx to omit the `image-reference` class on all `<a>`
elements surrounding an `<img>` element, which it normally adds when the
`target` option is specified on an `image` directive. As the theme
relies on that class to hide the "external link" icon added with commit
343decf1, the layout of the page was broken.

While replacing the substitutions with the plain `image` directive, the
grid table is converted to a list table to avoid the hassle of expanding
table cells to fit the directives. This will also help in maintaining
the content of the table when we will add new translations for the legal
agreements.

task-2909167

closes odoo/documentation#2462

X-original-commit: 81bf067ba1
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-07-13 18:36:00 +02:00
Antoine Vandevenne (anv) ec7b978fb3 [FIX] odoo_theme: show a cursor when hovering on an image without modal
The images that have the class `o-no-modal` cannot be clicked to open in
a modal, so the cursor should not be changed to a pointer when hovering
on them.

This commit also simplifies the theme's SCSS by replacing the hard-coded
SVG images used in the "Supported versions" page by unicode circles with
a custom styling.

X-original-commit: f648960c78
Part-of: odoo/documentation#2462
Co-authored-by: Elisabeth Dickinson (edi) <edi@odoo.com>
2022-07-13 18:36:00 +02:00
Antoine Vandevenne (anv) 435f21ab30 [FIX] odoo_theme: only open images that have no target in modal
Since clicking on the image redirects the user to the target URL, it's
useless to open the image in a modal. Also, it partially broke the
layout of the /legal.html page due to the modal div being inserted into
table cells.

This commit also introduces the possibility to add the `o-no-modal`
class on images that should not open in a modal.

task-2909167

X-original-commit: 7cbbb77746
Part-of: odoo/documentation#2462
2022-07-13 18:36:00 +02:00
Antoine Vandevenne (anv) bdafd7c1bf [IMP] developer: rename reference directories to "Py/Js framework"
It was confusing to label the directory for pages related to the Python
framework "Backend" as, in Odoo, the backend is the web client, and the
frontend is the portal/website. It also led to the "Standard modules"
directory to be placed within the "Backend" directory as of `saas-15.1`
to indicate that they were part of the backend too, but that was a
mistake. Indeed, most standard modules comprise JavaScript methods, and
we could want to document these in the reference at some point.

closes odoo/documentation#2445

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-07-12 16:29:56 +02:00
Antoine Vandevenne (anv) 5f2879b3cc [FIX] odoo_theme: fix the display of modal images in mobile
task-2908330

closes odoo/documentation#2443

X-original-commit: 5e0f14f683
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-07-12 16:29:54 +02:00
Antoine Vandevenne (anv) 44fd054858 [IMP] developer/rdtraining: simplify the development environment setup
In an attempt to help new developers install Odoo with a
straightforward procedure, Chapter 2 of the "Getting started" tutorial
included copy-pastes of parts of the "Installing Odoo" page. This proved
to be inefficient because it required maintaining documentation on the
installation procedure in several places and misled the readers by
suggesting installing the Python requirements *after* installing
PostgreSQL.

With this commit, the page on Chapter 2 is refreshed to be clearer to
the readers and redirect them to the "Installing Odoo" page when
necessary.

task-2908434

closes odoo/documentation#2440

X-original-commit: 11460f4c93
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-07-12 15:12:04 +02:00
LoredanaLrpz 235d2ad749 [ADD] pos: add a doc about tracking numbers in pos
Task ID: 2622088

closes odoo/documentation#2405

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
Co-authored-by: Robin Boisdenghien <robo@odoo.com>
2022-07-12 13:45:48 +02:00
Antoine Vandevenne (anv) 6e91652baf [CLN] conf.py: stop labelling saas-15.1 in version switcher
The branch was recently dropped from the supported versions. We no
longer need to add a label for it in the version switcher.

closes odoo/documentation#2433

X-original-commit: 2481e3d842
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-07-11 17:22:43 +02:00
Odoo Translation Bot dc841d8f47 [I18N] Update translation terms from Transifex 2022-07-10 01:40:18 +02:00
LoredanaLrpz 94eedb1c76 [IMP] pos: add a warning about Six unusability in July
Task ID:2893426
Since Six payment terminal won't be usable starting in July 2022, I
added this warning.

closes odoo/documentation#2421

X-original-commit: ceec1b0436
Signed-off-by: Castillo Jonathan (jcs) <jcs@odoo.com>
Signed-off-by: Perazzo Loredana (lrpz) <lrpz@odoo.com>
2022-07-08 10:03:14 +02:00
“Lau-Odoo” 45bb7ce848 [IMP] ecommerce: remove one sub-menu to add it as a see also
task - 2904108 I removed the "website/publish" section from the toctree to add a link to the full website documentation inside off the see also.

closes odoo/documentation#2415

X-original-commit: 7307dac6a6
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-07-07 19:24:46 +02:00
Demesmaeker fc23d7b7b6 [FIX] sale_amazon: fix information displayed
Both carrier name and tracking reference are now displayed to the
customer, even when using the carrie `Self Delivery`

task-2900803

closes odoo/documentation#2407

X-original-commit: 471d0c2094
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-07-07 14:22:52 +02:00
LoredanaLrpz a5d850e230 [IMP] pos: change the page heading
closes odoo/documentation#2388

Signed-off-by: Castillo Jonathan (jcs) <jcs@odoo.com>
2022-07-07 00:25:50 +02:00
LoredanaLrpz 53744bea5b [ADD] pos: add a new doc page about sales orders in pos
Task ID: 2622084

closes odoo/documentation#2041

Signed-off-by: Castillo Jonathan (jcs) <jcs@odoo.com>
Co-authored-by: Quentin Celis (qce) <qce@odoo.com>
Co-authored-by: Xavier Plateau (xpl) <xpl@odoo.com>
Co-authored-by: Robin Boisdenghien (robo) <robo@odoo.com>
2022-07-07 00:25:48 +02:00
Ludvig Auvens db8b45ead2 [IMP] eCommerce: update of cross-selling doc for Odoo 15.0 and after.
closes odoo/documentation#1712

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-07-06 15:34:58 +02:00
Antoine Vandevenne (anv) 31a9d4a340 [IMP] developer/javascript: unify the styling of API references
Now that a new styling for API references was added with commit 934f45c,
we can remove the extra CSS that was crafted specifically for JavaScript
API references with commit 05a0a49a. While we're at it, this commit also
applies the new styling to definition lists that were missing it, like
it was done for the page on views with commit 120ae785.

closes odoo/documentation#2367

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-07-04 15:22:27 +02:00
Antoine Vandevenne (anv) 109817311e [MOV] developer/misc: move all pages to a more logical location
Before this commit, the "Developer/Misc" directory of the doc, and
more particularly the "Developer/Misc/Other" sub-directory, was used as
a garbage dump where we moved all the pages that didn't fit elsewhere.
Due to that, interesting and important pages, such as the Coding
Guidelines, were buried in that directory never to be read again by Odoo
developers.

This commit moves most pages under "Misc" one or two levels up to be
located directly under "Developer" hence making them more accessible. A
new "Contributing/Development" directory is added to host the Coding
Guidelines page and soon many other pages.

task-2897143

closes odoo/documentation#2368

X-original-commit: 4e67b8986c
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-07-04 11:57:52 +02:00
“Lau-Odoo” fb86971df9 [IMP] website: broken link removal
task - 2841794

closes odoo/documentation#2358

X-original-commit: c40059e0a7
Signed-off-by: Auvens Ludvig (lau) <lau@odoo.com>
Signed-off-by: Castillo Jonathan (jcs) <jcs@odoo.com>
2022-07-01 17:17:12 +02:00
Tom Aarab (toaa) da87312821 [IMP] accounting: Adyen's backend changes for the webhook creation
Adyen's backend had slightly changed and the previous doc version was outdated (URL and HMAC key fields)

task - 2810213

closes odoo/documentation#2241

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-06-30 18:03:20 +02:00
Michelle Vu (mivu) 7f2110e8a3 [IMP] discuss: custom ICE server list optional
This will edit the "Define a list of custom ICE servers" section in the
"Configure ICE servers with Twilio" v15.0 user doc. I added a line to
mention that defining a list of custom ICE servers is an optional step,
as Odoo only uses this list as a fallback if Twilio is not configured or
is not working at any given moment.

Fixes PR #1994
Closes Odoo Task 2882679

closes odoo/documentation#2240

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-06-29 09:30:49 +02:00
Antoine Vandevenne (anv) e2a3ca0631 [IMP] developer/views: apply the new API references style
The documentation of view attributes was lacking visual structure to
help the reader figure out which attribute relates to which parent
element. Since this documentation was relying on RST block quotes to
represent the hierarchy of view attributes, we can apply the same new
styling that was added with commit 934f45cf and designed for autodoc,
and which relies on the exact same HTML structure as block quotes.

task-2755298

closes odoo/documentation#2336

X-original-commit: 7f95e9e2e0
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-06-28 18:32:10 +02:00
LoredanaLrpz f34bfaa3ab [ADD] pos: adyen payment terminal
Task ID: 2808584
Do not Forward port r+

closes odoo/documentation#2330

X-original-commit: 85b5374995
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
Signed-off-by: Perazzo Loredana (lrpz) <lrpz@odoo.com>
2022-06-28 17:30:06 +02:00
LoredanaLrpz 3ebbab5a67 [IMP] pos: change titles
X-original-commit: 5618e5ad9b
Part-of: odoo/documentation#2330
2022-06-28 17:30:06 +02:00
Odoo's Mergebot 3462553c5f [FW][MERGE] odoo_theme: styling fixes, tweaks, and general cleanup
**Special terms restyling:**
A general restyling of special terms has been made for better legibility
in text, and to differentiate roles (ie: `:command:`,`:file:`,`:dfn:`)
so writers can use these instead of italic and bold styling.
`:guilabel:` has not been changed because its use is too vast.

task-2790284

**Reference pages have a new look:**
`code` elements have been restyled to remove unnecessary spaces (ex:
`odoo.models .BaseModel`. See
https://www.odoo.com/documentation/15.0/developer/reference/backend/orm.html#odoo.models.BaseModel)
and to include visual aid of parent/children relations (left border).

Basic for task-2755298

**URL styling:**
When an image has an external link, the `external-link` icon appears
under the image. This has been removed. URLs with icons such as external
links or "Edit on Github" links have been modified to remove the
underline under the icons. On mobile, long URLs would push the content
outside the viewport. `overflow-wrap: anywhere` has been added to all
URLs on mobile devices.

**No more horizontal scroll on Windows thanks to css grid:**
Windows and Mac don't work the same (no kidding). Windows would add
±`1rem` of horizontal scroll when Mac doesn't. Adding that `1rem` to the
content's `max-width` calculations would make Mac unhappy (it left a
`1rem` gap). The solution for everyone to be happy was to change the
display type to `grid`. By doing this, the max-width calculations and
the left positioning according to the side-nav were not necessary
anymore. Great Success. Very Nice.

**Scrolling To:**
With the new subnav added with commit 10f62b6a, the scroll position was
wrong. This is fixed by changing the padding/margin top values in the
`o-scroll-padding` mixin.

**Replace "Hide Search Matches" with close icon:**
The title says it all.

**Forgotten scrollbar styling**
The scrollbar stylings for the side-nav should have been moved to
`o_side_nav-inner` during the previous restyling of the header.

**Clean up the mess:**
All these changes made me want to clean up a bit. By doing so I realised
that a lot of the utility mixins that were used in the old *old* doc
were still present here, but aren't being used. Same for some variables.
Some stying was using values instead of their variable counterparts, so
these have been replaced.

closes odoo/documentation#2322

Forward-port-of: odoo/documentation#2264
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-06-28 10:42:45 +02:00
Jonathan Castillo (jcs) 65c87d8e44 [IMP] contributing: update the rst cheat sheet
task - 2810468

closes odoo/documentation#2315

X-original-commit: 9ff312298d
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
Signed-off-by: Castillo Jonathan (jcs) <jcs@odoo.com>
Co-authored-by: Antoine Vandevenne (anv) <anv@odoo.com>
Co-authored-by: Elisabeth Dickinson (edi) <edi@odoo.com>
2022-06-27 17:11:56 +02:00
Elisabeth Dickinson 7836fe7b76 [REF] odoo_theme: replace values with variables in SCSS files
X-original-commit: c82d95b17c
2022-06-27 15:32:01 +02:00
Elisabeth Dickinson c5df00b604 [REF] odoo_theme: move stray mixins into the _mixins.scss file
X-original-commit: 7fa153594d
2022-06-27 15:32:00 +02:00
Elisabeth Dickinson 6419e4c5a3 [CLN] odoo_theme: remove unnecessary css
X-original-commit: fca78f44db
2022-06-27 15:31:59 +02:00
Elisabeth Dickinson 38ae5643dd [CLN] odoo_theme: remove old doc's unused variables
X-original-commit: 383e3d4206
2022-06-27 15:31:58 +02:00
Elisabeth Dickinson cf91bd9c3c [REF] odoo_theme: move scrollbar styling to .o_side_nav-inner
X-original-commit: b9ca38215d
2022-06-27 15:31:57 +02:00
Elisabeth Dickinson cea130cbfd [CLN] odoo_theme: remove old doc's utility mixins
These mixins were used in the old doc and were kept "just in case". The
`valid-radius` mixin already exists in the bootstrap library.

X-original-commit: 9a2e8eefef
2022-06-27 15:31:56 +02:00
Elisabeth Dickinson 995826e04a [IMP] odoo_theme: replace "hide search matches" by a close button
X-original-commit: 994d273a59
2022-06-27 15:31:55 +02:00
Elisabeth Dickinson 4b227945d8 [IMP] odoo_theme: improve spacing around code blocks on reference pages
X-original-commit: 794e42f78b
2022-06-27 15:31:54 +02:00
Elisabeth Dickinson 283787fe55 [FIX] odoo_theme: fix scrollTo margin/padding with new headers height
The scroll padding needed increasing with the new sub-header.
Unnecessary calc() and parenthesis on the headers-height variable are
removed.

X-original-commit: 0b536debac
2022-06-27 15:31:53 +02:00
Elisabeth Dickinson 75a4ed156b [FIX] odoo_theme: remove the horizontal scroll bar
X-original-commit: 26bc1cd707
2022-06-27 15:31:52 +02:00
Elisabeth Dickinson 4b3bed78e9 [IMP] odoo_theme: improve URL stylings
- Remove external-link icon on images.
- Remove underline from external-link icon on link hover.
- Add overflow-wrap on URLs on mobile.

X-original-commit: 91cb3ca026
2022-06-27 15:31:51 +02:00
Elisabeth Dickinson 0fc6efc3e8 [IMP] odoo_theme: improve general spacings and paddings
X-original-commit: 2e693b3c4a
2022-06-27 15:31:50 +02:00
Elisabeth Dickinson 3ca5f7c38e [IMP] odoo_theme: improve special terms styling
Including the `:command:`, `:file:` and `:dfn:` roles, and code-styled
text in alerts.

task-2790284

X-original-commit: 7239986484
2022-06-27 15:31:49 +02:00
Gopakumar N G 2116f5eaaf [FIX] pos: change the tab name in the configuration steps
closes odoo/documentation#2092

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-06-27 11:30:19 +02:00
Valentin Chevalier be4caef653 [IMP] developer/howtos: Add missing information about debug mode
In chapter 3 of the developer core training, one is asked to click on a
button that is only shown in debug mode but there is no indication about
this mode in this chapter.

closes odoo/documentation#2299

X-original-commit: 96d822bf87
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-06-27 10:18:46 +02:00
Odoo Translation Bot fce5ee704f [I18N] Update translation terms from Transifex 2022-06-26 01:40:30 +02:00
Donatienne Pirlot 11f9c35191 [IMP] accounting: note about outstanding accounts
task-2868642

closes odoo/documentation#2238

Signed-off-by: Castillo Jonathan (jcs) <jcs@odoo.com>
2022-06-24 14:42:30 +02:00
Antoine Vandevenne (anv) f10eb0ef3b [IMP] odoo_theme: open images in a modal
task-2358082

closes odoo/documentation#2278

X-original-commit: 2a867b4f60
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
Co-authored-by: Elisabeth Dickinson (edi) <edi@odoo.com>
2022-06-23 14:41:48 +02:00
Antoine Vandevenne (anv) fabad3da33 [IMP] redirects: split redirects.txt into multiple, per-version, files
The `redirects.txt` file used to specify redirect rules for renamed or
moved documentation pages is starting to grow too big to be easily
maintainable. The main reason is that the number of redirect rules that
were thought to be required has been largely underestimated when
implementing the 'redirects' extension. At first, we believed that no
guidelines or structure were necessary because only a small amount of
redirect rules would be specified. This proved wrong and the file is now
becoming a mess, making it increasingly difficult to figure out where,
why, when, and if a redirect rule is specified in the file.

As the file is versioned, another issue emerges: conflicts occur every
time a commit is forward-ported to a later version if that commit adds a
redirect rule at the end of the file or at a line that was changed in
the later version. As redirect rules are frequently added, and since
blocks of redirect rules for new versions are added at the end of the
file, this tends to happen a lot.

This commit attempts to hit two birds with one stone by splitting the
`redirects.txt` file into multiple files, one per version. While doing
so, the existing redirect rules are ordered alphabetically and moved
into contextual blocks. Instructions and guidelines on how to create
redirect rules are also listed in the `redirects/MANUAL.md` file. By
sorting the redirect rules and adding them in different files, the
number of conflicts should decrease by a lot.

task-2891912

closes odoo/documentation#2277

X-original-commit: 9dcc8bb071
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-06-23 13:30:48 +02:00
Antoine Vandevenne (anv) 9dc440ff41 [FIX] odoo_theme: correctly test for fallback URLs when using switchers
closes odoo/documentation#2269

X-original-commit: 9e84b6f681
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-06-23 10:46:18 +02:00
Donatienne Pirlot c8fd4608d4 [IMP] accounting: new content for invoice digitization (ocr)
closes odoo/documentation#1875

Id: 2320188
Signed-off-by: Pirlot Donatienne (dopi) <dopi@odoo.com>
2022-06-21 18:24:01 +02:00
Antoine Vandevenne (anv) ffff763b39 [FIX] redirects: add missing redirect rule for external_api.rst
The redirect rule was omitted in commit 3465475f.

closes odoo/documentation#2252

X-original-commit: 060e8f2344
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-06-21 17:10:52 +02:00
“Chiara f9f84dc28d [FW][IMP] accounting: remove the odoo tutorials invoices link
Deleting the Odoo Tutorials Invoices link since the course has been merged, and the link isn't necessary anymore.

closes odoo/documentation#2245

Forward-port-of: odoo/documentation#2243
Signed-off-by: Victor Feyens (vfe) <vfe@odoo.com>
2022-06-20 18:51:57 +02:00
Elisabeth Dickinson cf40a90c81 [FIX] odoo_theme: fix highlight blocks in field-list items
On pages such as /developer/reference/backend/orm.html#fields, the
highlight blocks inside `dl.field-list` items were pushing the width of
the page to go outside the screen on mobile. This is fixed by changing
the `.field-list`'s `display: grid` into `block` on mobile.

closes odoo/documentation#2225

X-original-commit: a689ea236d
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-06-20 11:25:04 +02:00
Odoo Translation Bot ec1ba758a9 [I18N] Update translation terms from Transifex 2022-06-19 01:40:31 +02:00
lma-odoo 573c314ba1 Update epos_ssc.rst
Because of a recent Chrome security update, a lot of customers using peripheral devices (printers, ...) will have to follow this doc.

Therefore, I followed the doc and did the flow on my side.

I modified 'Copy to file' to 'Export' and 'Trusted Root Certification Authorities' to 'Authorities' in order to have the exact same terms as in Chrome (I guess they updated their terms at some point).

closes odoo/documentation#2232

X-original-commit: 4c4b81b12c
Signed-off-by: Victor Feyens (vfe) <vfe@odoo.com>
2022-06-16 13:17:29 +02:00
Odoo's Mergebot e1583bcd98 [FW][MERGE] odoo_theme: revamp header and menu for better mobile support
Previously the switchers were hidden on mobile. These have been moved
to a sub-nav which also contains the button for the sidenav, leaving
more space for the searchbox so it can remain in the header. Like MDN
web docs, the navigation now slides in from the left instead of the
top.

See PR's commits for more details.

task-2800937

closes odoo/documentation#2217

Forward-port-of: odoo/documentation#2206
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-06-15 13:49:48 +02:00
Antoine Vandevenne (anv) 44a025babf [FIX] odoo_theme: stop testing for valid URLs if in localhost
The mechanism that makes the version and language switchers test for
valid URLs crashed when testing in localhost. The mechanism is now
skipped if the URL starts with a '/'.

X-original-commit: 98e98f65c9
2022-06-15 11:27:18 +02:00
Elisabeth Dickinson ac3b5349f9 [FIX] odoo_theme: fix searchbox's highlight-link
task-2800937

X-original-commit: 3fd32fe92a
2022-06-15 11:27:17 +02:00
Elisabeth Dickinson 532992084d [IMP] odoo_theme: revamp side menu to add overlay
task-2800937

X-original-commit: 4ed8c2238a
2022-06-15 11:27:16 +02:00
Elisabeth Dickinson e1504aac49 [FIX] odoo_theme: fix menu scrolling
task-2800937

X-original-commit: 9c53901db9
2022-06-15 11:27:15 +02:00
Elisabeth Dickinson 9f31188560 [IMP] odoo_theme: add side menu collapse icon
task-2800937

X-original-commit: 7284b11a36
2022-06-15 11:27:14 +02:00
Elisabeth Dickinson 315f1a1a26 [IMP] odoo_theme: change collapsing menu orientation
task-2800937

X-original-commit: dee96ad2da
2022-06-15 11:27:13 +02:00
Elisabeth Dickinson cef926b284 [IMP] odoo_theme: add subheader and adapt switchers and searchbar
task-2800937

X-original-commit: 411e1cb1d3
2022-06-15 11:27:12 +02:00
Elisabeth Dickinson a0f9d55c87 [IMP] odoo_theme: stop translating language names in the switcher
Before this commit, the language names were translated to display
"Français" instead of "French". This helped the user find their language
in the switcher but it was taking too much horizontal space, and that
space was not constant from one language to another.

This commit removes the translations of the language names and simply
goes with "FR", "NL", etc. which any user can identify as their
language.

task-2800937

X-original-commit: b1fa30f431
2022-06-15 11:27:11 +02:00
Elisabeth Dickinson 4e8fc887db [IMP] design: add an icon behind external links
The external links' target attribute is now also updated to open the
link in a new tab. In addition, the "[source]" link of autodoc's models
is moved right next to the name of the model to correctly position the
icon.

task-2790244

closes odoo/documentation#2208

X-original-commit: 343decf192
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
Co-authored-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-06-14 15:28:11 +02:00
Elisabeth Dickinson 07e943f85c [IMP] odoo_theme: show the "On this page" section in mobile
When the page gets too small for the "On this page" section (local tree
of content) to fit on the page, the section is now moved above the menu
(global tree of content) rather than being hidden.

task-2800970

closes odoo/documentation#2194

X-original-commit: c0040fa532
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
Co-authored-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-06-14 07:42:03 +02:00
Odoo Translation Bot 50459464d5 [I18N] Update translation terms from Transifex 2022-06-12 01:40:23 +02:00
Julien Castiaux e9be350ddd [IMP] rdtraining: tip about -i/-u for odoo-bin
It is never shown to the trainee that he can install/update a module
right from the CLI. Multiple developpers still use the app manager to
install/update their modules multiple months into the job.

closes odoo/documentation#2182

X-original-commit: 3d2f067e6c
Signed-off-by: Victor Feyens (vfe) <vfe@odoo.com>
Signed-off-by: Julien Castiaux <juc@odoo.com>
2022-06-10 22:44:05 +02:00
LoredanaLrpz c0036ae13c [REM] pos: remove cash control doc page in 15 bc deprecated
Task ID: 2680699

closes odoo/documentation#2069

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-06-10 16:54:12 +02:00
Antoine Vandevenne (anv) 9923bb33c9 [FIX] requirements: pin docutils to 0.16.0
Since sphinx-tabs 3.2.0 has the requirement docutils==0.16.0 and sphinx
3.5.4 has the requirement docutils>=0.12,<0.17, this commit pins
docutils to version 0.16.0.

While we're at it, the dependency to sphinx-tabs is also explicitly
listed, although it was already imported in the extensions. It causes
no trouble to install it from pip alongside the imported extension.

closes odoo/documentation#2171

X-original-commit: 5471d9a2ff
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-06-10 08:34:50 +02:00
Denis Vermylen 4ee741bb26 [FIX] odoo.sh: remove hidden folder from documentation
it will also be renamed to .repositories in the near future

closes odoo/documentation#2161

X-original-commit: 1afee9e2c7
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-06-08 08:50:38 +02:00
Odoo Translation Bot 417d29dfef [I18N] Update translation terms from Transifex 2022-06-05 01:40:24 +02:00
Jason Aerts (jaae) 27da1647f8 [IMP] maintain: process for odoo.sh to odoo online
task-id 2870122

closes odoo/documentation#2153

X-original-commit: 6dc4288e49
Signed-off-by: Victor Feyens (vfe) <vfe@odoo.com>
2022-06-03 13:40:46 +02:00
Tom Aarab (toaa) bf994dc95c [IMP] accounting: add note about bank sync not available for trial db
Added a note to specify that bank synchronization is not available on trial databases

closes odoo/documentation#2134

X-original-commit: e4fc5f07ee
Signed-off-by: Castillo Jonathan (jcs) <jcs@odoo.com>
Signed-off-by: Aarab Tom (toaa) <toaa@odoo.com>
2022-06-02 14:27:34 +02:00
Jonathan Castillo (jcs) a2cf3da864 [ADD] accounting/l10n: new egyptian localization and einvoicing section
task-id 2858349

closes odoo/documentation#2109

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-06-02 14:27:32 +02:00
Antoine Vandevenne (anv) c8e9d82884 [FIX] homepage: fix the link to the external API page
The page was moved from odoo.rst to external_api.rst with commit
0fc52188.

task-2870501

closes odoo/documentation#2139

X-original-commit: f6cd947d6b
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-06-02 13:13:09 +02:00
Jonathan Castillo (jcs) a535c92064 [IMP] maintain: add note in hosting changes (on-premise to online)
task-id 2869953

closes odoo/documentation#2125

X-original-commit: 4cd0500408
Signed-off-by: Castillo Jonathan (jcs) <jcs@odoo.com>
2022-06-01 19:16:00 +02:00
Odoo Translation Bot 96915d42dc [I18N] Update translation terms from Transifex 2022-06-01 10:28:58 +02:00
Antoine Vandevenne (anv) c820aa4951 [IMP] payment_acquirers: explain the different additional features
task-2862636

closes odoo/documentation#2082

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-05-31 18:16:41 +02:00
william 8acca3e1ac [FIX] conf: dynamic LaTeX releasename
closes odoo/documentation#2112

X-original-commit: 6d4f4f7d9b
Signed-off-by: Victor Feyens (vfe) <vfe@odoo.com>
2022-05-30 17:45:49 +02:00
Demesmaeker e92edc5a06 [IMP] amazon: migrate to SPAPI
Starting July 2022, Amazon WMS API is deprecated and we need to use the Selling Partners API.

This brings changes in the authentication flow that are explained.

task-2466636

closes odoo/documentation#2103

X-original-commit: 2dd3a4ae74
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-05-30 16:43:59 +02:00
Odoo Translation Bot 00bc48ebaf [I18N] Update translation terms from Transifex 2022-05-29 01:40:20 +02:00
Michelle Vu (mivu) 2dbe17bb4e [IMP] helpdesk: update flow and images for reinvoicing time
closes odoo/documentation#2093

X-original-commit: 00ec789d96
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-05-27 12:01:47 +02:00
Michelle Vu (mivu) 6dc30adf15 [IMP] payment: update SIX screenshots
closes odoo/documentation#2085

X-original-commit: f6b22996b7
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-05-27 10:59:42 +02:00
Michelle Vu (mivu) 42d1f1736f [FW][IMP] calendar: update Google Calendar sync screenshots
Task ID: 2685658

closes odoo/documentation#2084

Forward-port-of: odoo/documentation#1982
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-05-25 14:58:08 +02:00
Donatienne Pirlot 02a2d471ba [IMP] accounting: update the follow-up information
Task ID: 2735445

closes odoo/documentation#2077

X-original-commit: ffc23483ca
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
Signed-off-by: Pirlot Donatienne (dopi) <dopi@odoo.com>
2022-05-24 16:29:39 +02:00
Michelle Vu (mivu) 47d1146c10 [ADD] discuss: configure Twilio ICE servers
closes odoo/documentation#1994

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-05-23 09:29:54 +02:00
Odoo Translation Bot c924b21b81 [I18N] Update translation terms from Transifex 2022-05-22 01:40:23 +02:00
Donatienne Pirlot cabfbb5fc2 [IMP] accounting : update the list of fiscal localization packages
task id: 2858536

closes odoo/documentation#2045

X-original-commit: 18f8b286d5
Signed-off-by: Castillo Jonathan (jcs) <jcs@odoo.com>
2022-05-20 15:20:13 +02:00
Antoine Vandevenne (anv) 5a7048eb0a [MOV] developer/api/odoo: rename odoo.rst into external_api.rst
The previous file name was not very relevant in regard to the content of
the page, and it conflicted with the `sys.path`.

closes odoo/documentation#2064

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-05-20 14:10:01 +02:00
Antoine Vandevenne (anv) 17df8c547a [MOV] content/*: move resource files into their related page's directory
Since odoo/documentation#903, the guideline for the location of new
resource (images, downloadable files, RST includes...) files is to place
those inside the directory of the RST page that references them.

For example, if `doc1.rst` has a reference to `image.png` and to
`download.zip`, the file structure should look like this:

├── parent_doc/
│     └── doc1/
│     │     └── image.png
│     │     └── download.zip
│     └── doc1.rst
│     └── doc2.rst
├── parent_doc.rst

Before this commit, most of the resource files were still located inside
'media' directories holding all the resource files referenced by RST
pages located at the same level as these directories. In the example
above, a single 'media' directory would hold all the resource files
referenced by both `doc1.rst` and `doc2.rst`. Doing so prevented us from
figuring out easily which resource file was referenced by which RST page
and, thus, lead to unused resource files piling up in the repository. It
also made it more complicated to define codeowners regex rules because a
team could not simply be assigned to `/some_page.*` but needed to be
assigned to both `/some_page\.rst` and to the location of 'media'.

In order to help new content writers figure out the guideline when
taking examples from other RST pages, this commit retroactively applies
the guideline to existing resource files and 'media' directories. The
left-over resource files that are not referenced by any RST page are
removed.

task-2497965

Part-of: odoo/documentation#2064
2022-05-20 14:10:01 +02:00
Martin Trigaux fbb1cfc90f [FIX] odoo_theme: correctly consider baseurl
urlBase was only containing the domain name, not the /documentation/

closes odoo/documentation#2058

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-05-20 11:56:45 +02:00
Martin Trigaux 7c2f300c95 [IMP] odoo_theme: introduce fallback URLs for the page switchers
When a user clicks on the link of an alternate page in the version or
language switcher, we now check if the page referenced by the target URL
exists or not. If not, we generate a series of fallback URLs from the
target URL and check whether the targeted resource exists or not, until
we read the root of the documentation. As soon as we find a valid URL,
we redirect the user to it.

This is inspired by the behaviour of docs.python.org's version and
language switchers.

task-2534669

closes odoo/documentation#2044

X-original-commit: 25e863a64c
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
Signed-off-by: Martin Trigaux (mat) <mat@odoo.com>
Co-authored-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-05-19 22:32:45 +02:00
Altela Eleviansyah Pramardhika c583067332 [FW][FIX] developer/howtos: Fixed typo from field to fields
closes odoo/documentation#2030

Forward-port-of: odoo/documentation#2023
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-05-19 15:39:42 +02:00
Tori (vpk) d2a9285bb4 [IMP] CRM: updated lead scoring with note about deprecation
Task ID: 2496900

closes odoo/documentation#2024

X-original-commit: fca684e802
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-05-19 15:39:39 +02:00
Tori (vpk) 1b89d20aeb [IMP] CRM: updating flow and screenshots of generating leads
closes odoo/documentation#2018

Task: 2540813
X-original-commit: 44129be225
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-05-19 13:06:05 +02:00
Beshoy Nabeih 6d30d81a76 [FIX] developer/frontend: typo in the user menu registry example
closes odoo/documentation#1975

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-05-19 13:05:59 +02:00
John Kirkwood (kij) 599a137ffc [IMP] developer: clarify options for many2one widget
Only `no_create` is required to hide both the 'Create "xxx"' and the
'Create and Edit...' dropdown menu options.

closes odoo/documentation#1545

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-05-18 12:36:48 +02:00
Donatienne Pirlot 5de81c9e2d [ADD] accounting: new doc about outstanding account
Task-id 2744131

closes odoo/documentation#1887

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-05-18 11:10:56 +02:00
Odoo Translation Bot bac53c282c [I18N] Update translation terms from Transifex 2022-05-15 01:40:22 +02:00
Antoine Vandevenne (anv) 4c7e89d872 [FIX] requirements.txt: pin Jinja2 < 3.1
The latest versions of Jinja2 are no longer compatible with the latest
version of Sphinx 3 (3.5.4).

task-2828982

closes odoo/documentation#1993

X-original-commit: 8f4be8e3ea
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-05-13 13:17:04 +02:00
Fabrice Henrion 85819de4c4 [IMP] payment acquirers: a note in Authorize.net
closes odoo/documentation#1986

X-original-commit: df10f17c3e
Signed-off-by: Castillo Jonathan (jcs) <jcs@odoo.com>
2022-05-12 17:31:07 +02:00
Laurent Desausoi (lade) c788e5f246 [IMP] sale_management: remove price_unit from quotation template
Companion of [1].

[1]: https://github.com/odoo/odoo/pull/47186

opw-2824263

closes odoo/documentation#1976

X-original-commit: f6bf1183db
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
Signed-off-by: Desausoi Laurent (lade) <lade@odoo.com>
2022-05-11 09:24:13 +02:00
Demesmaeker 545bcd7a6d [IMP] amazon: explain how to use a carrier
In case of an unsupported carrier or a self Delivery, Odoo won't block
the user to use the Amazon connector, but explanation were needed for
these cases.

task-2804907

closes odoo/documentation#1960

X-original-commit: 3231d20d92
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-05-09 14:06:29 +02:00
Antoine Vandevenne (anv) 557b261e01 [FIX] conf: allow building the documentation with Python 3.6.
Commit 3d358fdb introduced a new import of Odoo source files which
complain about the minimal Python version if the hack added by 57e1e314
is not executed early enough.

closes odoo/documentation#1949

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-05-09 14:06:23 +02:00
Tori (vpk) a86dd00b41 [IMP] CRM: update multiple sales teams doc
closes odoo/documentation#1957

Task: 2588786
X-original-commit: 98f306eca5
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-05-09 13:00:04 +02:00
Jeremy Kersten 8df7aa1d3e [IMP] odoo_theme: allow to add plausible script
export PLAUSIBLE_SCRIPT=https://plausible.io/js/script.js
export PLAUSIBLE_DOMAIN=yourdomain.com

closes odoo/documentation#1951

X-original-commit: 4c526eb02f
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
Signed-off-by: Jérémy Kersten <jke@odoo.com>
2022-05-09 11:44:17 +02:00
Zachary Straub (ZST) 72fe4cddd9 [ADD] accounting: avatax integration
closes odoo/documentation#1941

X-original-commit: 093aea15ec
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-05-09 08:25:44 +02:00
Odoo Translation Bot d8b5f89b75 [I18N] Update translation terms from Transifex 2022-05-08 01:40:22 +02:00
wan 2da1f72389 [REF] i18n/localization.rst: rework the entire localization tutorial
closes odoo/documentation#1334

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
Co-authored-by: William Andre <wan@odoo.com>
Co-authored-by: Ivan Yelizariev <iel@odoo.com>
2022-05-06 17:47:12 +02:00
wan c4b09dfbd9 [ADD] extension: allow to build graphs using graphviz
Part-of: odoo/documentation#1334
2022-05-06 17:47:11 +02:00
wan 3d358fdbcd [ADD] extensions: new autofield directive
This new directive is generating documentation from Odoo fields. This
can be used to build documentation about business classes.
This will help developpers import/export data and build localization
modules for instance.

Part-of: odoo/documentation#1334
2022-05-06 17:47:11 +02:00
wan c37f2030dc [ADD] conf: give relative and absolute path to odoo repo
Also add a condition on some directives to ignore them when we have no
relative/absolute path.

Part-of: odoo/documentation#1334
2022-05-06 17:47:11 +02:00
Jonathan Castillo (jcs) c7de4a7b3f [IMP] install/maintain: add seealso links in domain names doc
closes odoo/documentation#1934

X-original-commit: d7da800674
Signed-off-by: Castillo Jonathan (jcs) <jcs@odoo.com>
2022-05-06 16:27:28 +02:00
Altela Eleviansyah Pramardhika fdab26d5c7 [FW][FIX] developer/howtos: missing parentheses in print statement
Added parentheses in a print function

closes odoo/documentation#1927

Forward-port-of: odoo/documentation#1923
Signed-off-by: Victor Feyens (vfe) <vfe@odoo.com>
2022-05-06 11:39:58 +02:00
Jonathan Castillo (jcs) 1997788e81 [IMP] contributing: modify titles and headings guidelines
The previous guidelines for titles and headings included an exception to
capitalize feature names as they are written in the apps. However, this
exception seems to have confused most writers as it isn't always clear
what should be considered as a feature name or what should be considered
as a noun or noun group. This commit removes this exception to make the
writing and reviewing processes easier while retaining good titles and
improving consistency across the documentation. It also changes the
titles of the Accounting section to provide a better example to other
writers.

task-id 2843109

closes odoo/documentation#1912

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
Signed-off-by: Castillo Jonathan (jcs) <jcs@odoo.com>
2022-05-05 12:54:55 +02:00
Antoine Dupuis (andu) 555ebf48d7 [FW][IMP] accounting: add a warning about invoices in USD in Mexico
Mexican companies very commonly issue invoices in USD, to be fulfiled
in MXN, at the official exchange rate defined by the Banco de Mexico
on the day of payment.

(Presumably, this is to insure against the volatility of the Mexican
peso.)

Odoo supports this workflow, but only if the payment is registered
directly on the invoice using the 'Register Payment' button.

If the payment is created separately, and then reconciled manually
with the invoice, a whole host of problems occur:
- the payment typically can't be reconciled fully with the invoice,
  (even though that can usually be solved by manually creating
  an exchange move)
- but more problematically, the amounts on the payment CFDI will
  be wrong, and even manually creating an exchange move won't solve
  that.

So, we absolutely need to warn users not to try to do that.

(We've been encountering lots of tickets lately in the tech-support
pipe because of users who tried this and then wonder why it doesn't
work.)

This is currently an issue in 14.0, 15.0 and master.

closes odoo/documentation#1913

Forward-port-of: odoo/documentation#1728
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-05-05 09:42:05 +02:00
Alexandre de Pape b2f4a9e818 [FIX] sales: fix typo
critarias -> criteria

closes odoo/documentation#1886

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-05-02 16:22:49 +02:00
Odoo Translation Bot fa0cffd672 [I18N] Update translation terms from Transifex 2022-05-01 01:40:34 +02:00
root 8d63b494c3 [ADD] multi_website: add info to configure multiple domains
closes odoo/documentation#1891

X-original-commit: 324936c43e
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-04-28 18:02:09 +02:00
Antoine Vandevenne (anv) 71d7500ffa [ADD] .gitattributes: include RST files in language statistic on GitHub
closes odoo/documentation#1890

X-original-commit: 34d604ca89
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-04-28 18:02:06 +02:00
Loan (lse) 3e25d94b0d [IMP] outlook mail_plugin: add solution for cookie issue
closes odoo/documentation#1645

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-04-28 10:04:51 +02:00
Adrien Milis b578f575d0 [FIX] developer/rd-training: fix commands
Changed commands that were still referring to Odoo 14.0 to 15.0

closes odoo/documentation#1868

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-04-26 16:40:48 +02:00
MichaSi 9693824bee [FIX] crm: fix typos and menuselection items
closes odoo/documentation#1183

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-04-26 11:22:56 +02:00
Antoine Vandevenne (anv) d28fb186ae [FIX] developer/rdtraining: fix typos
closes odoo/documentation#1863

X-original-commit: f8f5ed93e1
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-04-26 11:22:53 +02:00
Dossogne Bertrand b4b3171237 [FIX] developer: fix duplicate action availability
The duplicate action is not available for list views

closes odoo/documentation#1856

X-original-commit: ce1961ebaf
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-04-25 10:03:48 +02:00
Odoo Translation Bot 2251618f09 [I18N] Update translation terms from Transifex 2022-04-24 01:40:41 +02:00
Dossogne Bertrand 6d52dd976f [FIX] developer: fix duplicate availability
The duplicate action is not available for list views

closes odoo/documentation#1848

X-original-commit: 9cf425d886
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-04-22 17:42:34 +02:00
Touati Djamel (otd) 9c242400b6 [FIX] inventory_and_mrp: documentation update
After this PR: https://github.com/odoo/odoo/pull/78199

The explanation of the `Security Lead Time for Purchase` field needs to be updated

opw-2766940

closes odoo/documentation#1801

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-04-21 14:17:53 +02:00
Odoo Translation Bot dabdcda318 [I18N] Update translation terms from Transifex 2022-04-17 01:40:32 +02:00
Benoit Socias 3be4613d41 [IMP] rdtraining: clarify transition sentence to view inheritance
The "View Inheritance" section is introduced by a sentence that can be
understood as "do this task then we'll be ready to go the next section"
instead of "in the next section we will see how to do this task".
This can confuse the reader into thinking that some knowledge was not
acquired in the previous parts.

This commit makes it clear that the task described in the transition
sentence will be achieved in the next part.

task-2822582

closes odoo/documentation#1827

X-original-commit: 5a39ba7d24
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
Signed-off-by: Benoit Socias (bso) <bso@odoo.com>
2022-04-14 13:31:47 +02:00
Benoit Socias e57ace10b8 [IMP] rdtraining: add note about Settings requiring at least one app
At the point when the developer mode is introduced in the training, it is
confusing because the documentation page describes the option inside the
Settings page, but that page only appears if at least one application is
installed. (Otherwise, the Settings app shows the Users instead)

This commit adds a note so that the reader does not start looking for a
screen that cannot be reached at that point.

task-2822582

X-original-commit: 2ebb7fe802
Part-of: odoo/documentation#1827
2022-04-14 13:31:47 +02:00
Altela Eleviansyah Pramardhika 533264c082 [FW][FIX] developer/rdtraining: fix typo
Fixed `name = field.Char(required=True)` to
`name = fields.Char(required=True)`.

closes odoo/documentation#1819

Forward-port-of: odoo/documentation#1816
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-04-11 12:43:00 +02:00
Odoo Translation Bot f6c87f9170 [I18N] Update translation terms from Transifex 2022-04-10 01:40:24 +02:00
Antoine Vandevenne (anv) fbe363ad8c [IMP] odoo_theme: hide the "Edit on GitHub" button for pages in legal/
closes odoo/documentation#1812

X-original-commit: ff79ca3a6b
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-04-08 15:39:50 +02:00
Martin Trigaux 96d7d0f050 [I18N] *: export 15.0 source terms 2022-04-08 15:27:14 +02:00
Christophe Simonis bf5eb8b5fc [FIX] supported_versions: correct naming of recent saas~x versions
Since 11.0, the naming scheme changed from `(x.)saas~y` to `saas~x.y`.

closes odoo/documentation#1806

X-original-commit: 30f55dfd72
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
Signed-off-by: Castillo Jonathan (jcs) <jcs@odoo.com>
2022-04-06 18:06:33 +02:00
Antoine Vandevenne (anv) 675e64c1fb [ADD] last_build: add an orphan page informing on the last build date
closes odoo/documentation#1799

X-original-commit: 683840be18
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-04-05 17:36:28 +02:00
nouraellm 7c5d18b84c [IMP] manufacturing: scrap location warning fw of #950
The destination location in manufacturing order shouldn't be a scrap location.
Otherwise, the user won't be able to complete manufacturing orders.

closes odoo/documentation#1736

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-04-04 11:42:27 +02:00
LoredanaLrpz 9f4a63e28d [IMP] pos: add tip usable decimal separator
task-id 2608735

closes odoo/documentation#1785

X-original-commit: ae76baa20e
Signed-off-by: Castillo Jonathan (jcs) <jcs@odoo.com>
2022-03-31 10:34:57 +02:00
Ray Carnes 09631be408 [IMP] inventory: add note about detailed operations in one_step.rst
User tripped up due to the creation of a second warehouse enabling
Storage Locations and changingthe workflow.

https://www.odoo.com/forum/help-1/inventory-receipt-in-second-warehouse-199962

closes odoo/documentation#1779

X-original-commit: bdf526af2c
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-03-30 15:32:15 +02:00
Antoine Vandevenne (anv) b467df0a49 [REF] general: move images in their respective page's folder
Codeowner regexes need images to be in the correct location, otherwise
some image files might not be assigned to a GitHub team when the regex
covering the parent folder is split into multiple codeowner rules.

closes odoo/documentation#1774

X-original-commit: 4e0a9b615f
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-03-30 14:23:01 +02:00
Donatienne Pirlot 24e7e73154 [FIX] upgrade: small fixes
task-2684744

closes odoo/documentation#1766

X-original-commit: 6a316ca86e
Signed-off-by: Castillo Jonathan (jcs) <jcs@odoo.com>
2022-03-29 11:28:48 +02:00
Jonathan Castillo (jcs) 05e86fcc9c [FIX] redirects: add missing redirection for maintain/online.rst
closes odoo/documentation#1761

X-original-commit: 73a7ec6d6e
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
Signed-off-by: Castillo Jonathan (jcs) <jcs@odoo.com>
2022-03-28 22:05:53 +02:00
Eric Macharia 185f1e9018 [FIX] install/maintain: typo in deploy.rst
closes odoo/documentation#1756

X-original-commit: 5c5ef6e603
Signed-off-by: Castillo Jonathan (jcs) <jcs@odoo.com>
2022-03-28 22:05:50 +02:00
Odoo Translation Bot 02acd8df30 [I18N] Update translation terms from Transifex 2022-03-27 00:30:38 +01:00
Donatienne Pirlot 89d5deb8c5 [IMP] upgrade: update and improve the upgrade processes and information
task ID: 2684744

closes odoo/documentation#1746

X-original-commit: 825e0ede21
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-03-26 07:12:34 +01:00
Antoine Vandevenne (anv) b176175f0f [IMP] supported_versions: flag saas-15.2 as supported
closes odoo/documentation#1742

X-original-commit: ba0e93e836
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-03-25 19:42:57 +01:00
Thibault Francois d2de65a15a [IMP] CLI: adapt cloc doc to new behavior
since https://github.com/odoo/odoo/pull/85854 cloc
also count stylesheet file and frontend file in
imported module

closes odoo/documentation#1661

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-03-21 19:14:38 +01:00
Jonathan Castillo (jcs) b550840634 [ADD] accounting/l10n: new localization for luxembourg
task-id 2780977

closes odoo/documentation#1719

X-original-commit: f0bac6998e
Signed-off-by: Castillo Jonathan (jcs) <jcs@odoo.com>
2022-03-21 18:16:24 +01:00
Zachary Straub (ZST) 5d8246c206 [ADD] general/digest_emails: add new digest emails docs
closes odoo/documentation#1446

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-03-21 10:09:19 +01:00
Odoo Translation Bot 0d2b2c42cb [I18N] Update translation terms from Transifex 2022-03-20 00:30:48 +01:00
0b11001111 355bfa70f9 [IMP] developer: extend internationalization guide
In order for javascript translations to become active, the corresponding
addon needs to follow a certain naming scheme or register explicitly.
This commit updates the internationalization guide with a respective
hint.

Fixes odoo/documentation#1676

closes odoo/documentation#1724

X-original-commit: 112b6c1267
Signed-off-by: Martin Trigaux (mat) <mat@odoo.com>
2022-03-18 16:59:27 +01:00
Antoine Vandevenne (anv) 943251b295 [FIX] odoo_theme: fix CSS issues and warnings
closes odoo/documentation#1714

X-original-commit: cb7a41b75b
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-03-18 16:59:25 +01:00
Martin Trigaux 188262022e [I18N] *: export source terms
And add administration.pot
2022-03-18 16:04:17 +01:00
bve-odoo 04ec424fa4 [FIX] dev/misc/cmdline: update url werkzeug
URL was pointing to a dead end.
Update from
http://werkzeug.pocoo.org/docs/contrib/fixers/#werkzeug.contrib.fixers.ProxyFix
to
https://werkzeug.palletsprojects.com/en/0.16.x/middleware/proxy_fix/#module-werkzeug.middleware.proxy_fix
new URL as we are using 0.16.1

closes odoo/documentation#1706

X-original-commit: 7ce175ff55
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-03-17 11:48:52 +01:00
Demesmaeker 88752379bb [IMP] payment_acquirers: add tabs for Stripe
task-2782290

closes odoo/documentation#1643

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-03-16 14:44:42 +01:00
Antoine Vandevenne (anv) a47cc70b70 [IMP] developer/cli: mention the different ways of calling the CLI
All examples on the page suggest calling the CLI with "odoo-bin" while
it is recommended to call it with "odoo" when Odoo was installed from a
distribution package. It also failed to mention the location of
"odoo-bin" relative to the source files.

The chance is also taken to rename the somewhat unclear page title to
something more clear and generic.

closes odoo/documentation#1696

X-original-commit: c018a53686
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-03-14 11:20:18 +00:00
Odoo Translation Bot 0ce72df3bd [I18N] Update translation terms from Transifex 2022-03-13 00:30:41 +01:00
Antoine Vandevenne (anv) f220a30c6c [IMP] developer/api/extract_api: rework page to get rid of switchers
task-2787415

closes odoo/documentation#1689

X-original-commit: 85b7200944
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-03-11 14:45:07 +00:00
Antoine Vandevenne (anv) 7a8640d21c [IMP] developer/api/odoo: rework page to use examples and content tabs
task-2787415

X-original-commit: 1afdec3784
Part-of: odoo/documentation#1689
2022-03-11 14:45:06 +00:00
Antoine Vandevenne (anv) 30b9f172c5 [REM] extensions: remove the 'switcher' extension
The 'sphinx-tabs' extension is better in every aspect:
- Synchronize selected tabs (group tabs feature).
- No need for extra `code-block` directive (code tabs feature).
- Better looking.
- No custom Python, JS, or CSS.

task-2787415

X-original-commit: 269173caac
Part-of: odoo/documentation#1689
2022-03-11 14:45:06 +00:00
Antoine Vandevenne (anv) 7490630d25 [IMP] contributing/documentation: document usage of code tabs
task-2787415

X-original-commit: 1e24b482b6
Part-of: odoo/documentation#1689
2022-03-11 14:45:06 +00:00
nle-odoo 3db6dc174c [FIX] developer/mixins: mail.thread method names
In d46e358d3e88aea9f9289c4845c6c87ab9491c55 some mail.thread method
names were changed: it should be changed in documentation too.

closes odoo/documentation#1683

X-original-commit: b24560e224
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-03-10 15:00:00 +00:00
Jonathan Castillo (jcs) f404826514 [IMP] install/maintain: add use of :guilabel: in domain_names
+ fix two small typos.

closes odoo/documentation#1678

X-original-commit: 787b82bab9
Signed-off-by: Castillo Jonathan (jcs) <jcs@odoo.com>
2022-03-10 14:37:10 +00:00
Elisabeth Dickinson 00eded4e42 [IMP] scss: content tabs refining
This commit removes unnecessary negative margins and makes code-blocks
inside content tabs lose their bottom margin and border.

closes odoo/documentation#1670

X-original-commit: ac28acee4a
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-03-08 16:31:26 +00:00
Elisabeth Dickinson 238444ece0 [IMP] scss: make alert full width of parent
Before this commit, the alerts would all have different widths according
to their content, some stretching and getting pushed under the
"on this page" menu. This way all alerts are aligned.

X-original-commit: b76a566522
Part-of: odoo/documentation#1670
2022-03-08 16:31:26 +00:00
Carlos Valverde fa3ed32409 [IMP] documentation: content tabs design
This commit improves current css style added by default to the Odoo
Documentation's content tabs.

This design improvement has been made by following the current theme's
style, especially in terms of palette and borders.

Tabs are responsive and have been optimised in order to have a
cross-browser compatibility.

--
Task-2755240

closes odoo/documentation#1663

X-original-commit: 7250f88b8d
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-03-08 10:16:59 +00:00
Ray Carnes ec5deec293 [IMP] accounting: improve phrasing OCR
Add link to try the OCR service, cleanup copy.

closes odoo/documentation#1657

X-original-commit: b83df4f6d2
Signed-off-by: Victor Feyens (vfe) <vfe@odoo.com>
2022-03-07 14:33:51 +00:00
Odoo Translation Bot dabe6d5053 [I18N] Update translation terms from Transifex 2022-03-06 00:30:33 +01:00
Jonathan Castillo (jcs) 01c4b71845 [IMP] install/maintain: new improved doc about domain names
task-id 2680490

closes odoo/documentation#1648

X-original-commit: d22f95362a
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
Signed-off-by: Castillo Jonathan (jcs) <jcs@odoo.com>
2022-03-03 19:00:39 +00:00
Odoo Translation Bot dbac6d8fe1 [I18N] Update translation terms from Transifex 2022-02-27 00:30:36 +01:00
Jonathan Castillo (jcs) 2fb106bace [IMP] accounting: fix a typo in eu_distance_selling.rst
closes odoo/documentation#1635

X-original-commit: 3c0b7783b8
Signed-off-by: Victor Feyens (vfe) <vfe@odoo.com>
Signed-off-by: Castillo Jonathan (jcs) <jcs@odoo.com>
2022-02-24 16:46:02 +00:00
Thibault Libioulle ff55b18aa2 [IMP] general/payment_acquirers: add Stripe Connect documentation
This commit adds the user documentation about the modification done in
the payment onboarding and the new Stripe Connect capabilities.

task-2685160

closes odoo/documentation#1447

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
Co-authored-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-02-23 16:19:47 +00:00
Antoine Vandevenne (anv) 69ff7243bf [IMP] extensions: add content tabs (backport of cf6ca0fb)
closes odoo/documentation#1626

X-original-commit: 286b01a241
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-02-23 13:55:08 +00:00
Stanislas Sobieski 3209a45f7c [FW][REV] odoo_sh: revert commit 6c48f90
closes odoo/documentation#1620

Forward-port-of: odoo/documentation#1618
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-02-22 17:05:58 +00:00
Obay Abdelgadir 1c6cbd2bd6 [IMP] install: remove deprecated ssl instruction in deploy.rst
Backport of commit d227ab66b0 on #1448

closes odoo/documentation#1614

X-original-commit: a80f3c3899
Signed-off-by: Castillo Jonathan (jcs) <jcs@odoo.com>
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-02-22 13:44:26 +00:00
Stanislas Sobieski f32dd09c96 [IMP] odoo_sh doc update
closes odoo/documentation#1607

X-original-commit: 6c48f90739
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-02-21 17:55:20 +00:00
Odoo Translation Bot 368c905d31 [I18N] Update translation terms from Transifex 2022-02-20 00:30:36 +01:00
Antoine Vandevenne (anv) 913d2c23af [FIX] conf: upper-case 'master' in the version switcher
closes odoo/documentation#1601

X-original-commit: a7f0651773
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-02-16 12:01:54 +00:00
Elisabeth Dickinson 6e17f7a40b [IMP] odoo_theme: switch admonitions' display type to inline-block
When placing an image before an admonition block and setting its
alignment to left or right, the admonition block would hide the image.
The reason for this is the use of "float" on the image. In order for
the image to reappear, we change the admonition's `display: block` to
`display: inline-block`.

task-2582954

closes odoo/documentation#1592

X-original-commit: c30f2735b8
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-02-15 08:49:24 +00:00
Odoo Translation Bot 1518074e68 [I18N] Update translation terms from Transifex 2022-02-13 00:30:37 +01:00
Antoine Vandevenne (anv) 2cf55fe863 [FIX] conf: list saas-15.2 in existing versions
closes odoo/documentation#1586

X-original-commit: a64e95d1c6
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-02-11 15:29:53 +00:00
Antoine Vandevenne (anv) 837ee962c2 [IMP] conf: show all relevant versions in the version switcher
From now on, the master branch and the latest released SaaS branch are
always shown. SaaS branches are labeled "Odoo Online".

The list of the versions shown in the switcher is hard-coded to force
their ordering.

The class `dropdown-toggle` is always added to the version|language
switcher regardless of whether other versions|languages are available,
as a quick fix to a CSS issue that occurs when the class is missing.

closes odoo/documentation#1578

X-original-commit: fb469b8211
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-02-11 14:29:57 +00:00
Jonathan Castillo (jcs) 3d3fee0add [IMP] install/maintain: add info about upgrading Odoo Online databases
closes odoo/documentation#1575

X-original-commit: 5893edda93
Signed-off-by: Castillo Jonathan (jcs) <jcs@odoo.com>
2022-02-11 10:28:45 +00:00
Antoine Vandevenne (anv) eed86bf01a [IMP] supported_versions: emphasis short-term support of SaaS versions
X-original-commit: ec8804a1e5
Part-of: odoo/documentation#1575
2022-02-11 10:28:44 +00:00
Antoine Vandevenne (anv) b772eb62e4 [IMP] supported_versions: flag saas-15.1 as supported
X-original-commit: 04992995a6
Part-of: odoo/documentation#1575
2022-02-11 10:28:44 +00:00
lejeune quentin ae7868d8ed [ADD] point_of_sale: Connect an Worldline Payment Terminal to your PoS
Documentation to explain how to configure a Worldline Payment terminal.

closes odoo/documentation#1464

Signed-off-by: Victor Feyens (vfe) <vfe@odoo.com>
Co-authored-by: perazzo loredana <lrpz@odoo.com>
Co-authored-by: lejeune quentin <qle@odoo.com>
2022-02-10 15:41:49 +00:00
ren-odoo 45726dded7 [IMP] accounting/l10n: update webinar link in colombia.rst
The current webinar link is for another version, with this commit we're adding the newest webinar link.

closes odoo/documentation#1566

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-02-10 12:28:41 +00:00
StanvanHoorn c7d8e3ecba [FIX] install/maintain: update versions in "Installing Odoo"
closes odoo/documentation#1242

Signed-off-by: Castillo Jonathan (jcs) <jcs@odoo.com>
2022-02-09 16:05:16 +00:00
Jonathan Castillo (jcs) 79a33520a1 [FIX] redirections: duplicate rule + misplaced rules
- removes a duplicate rule:
  applications/finance/sign/overview/signature_validity.rst
  applications/finance/sign.rst
- moves two rules closer to their related redirections
- adds comments to these two rules
- updates redirection to "email_servers" with the new path (line 203)

closes odoo/documentation#1553

Signed-off-by: Castillo Jonathan (jcs) <jcs@odoo.com>
2022-02-07 15:54:48 +00:00
BVE ce8a02d46a [ADD] email_communication: new documentation regarding general emailing
Creation of a new submenu under Applications/General for the Email communication.
Moved advanced of dicuss to this new submenu + adding of content regarding
frequently asked question in support.

Redirection has been done on other files pointing to Discuss/Advanced to match
the new folder email_communication.

Modified content in:
- Email servers: split and move configuration part under email_domain
- Email domain: covering information about SPF DKIM and DMARC configurations by JQU
- Email templates: (how to use the functions) by GOR
- Email common: answering frequently asked questions + common issues by ALA

closes odoo/documentation#1546

X-original-commit: bf2a9bb23f
Signed-off-by: Vergote Baptiste (bve) <bve@odoo.com>
2022-02-07 11:51:44 +00:00
Odoo Translation Bot 1236938e96 [I18N] Update translation terms from Transifex 2022-02-06 00:30:32 +01:00
Jonathan Castillo (jcs) dd33c9ad1e [FW][FIX] accounting: fix module name to install in intrastat
closes odoo/documentation#1541

Forward-port-of: odoo/documentation#1539
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
Signed-off-by: Castillo Jonathan (jcs) <jcs@odoo.com>
2022-02-04 18:05:07 +00:00
Antoine Vandevenne (anv) 5f1979b7e8 [IMP] contributing/doc: add an entry for the example admonition
closes odoo/documentation#1533

X-original-commit: ddff8f6914
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-02-04 15:25:17 +00:00
Mathieu Germain 6fb40b61c8 [REF] mrp: documentation update
- Updated Pictures with latest version, deleted old ones
- Added Quality Control section
- Deleted Kit Routings section
- Adapted Terminology, specifically work orders vs routings

closes odoo/documentation#1460

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-02-03 16:02:48 +00:00
Demesmaeker 3c526a2bc6 [IMP] integration_testing: add information about JS touring
Adding basic information about `How to make a test tour`.

task-2742841

closes odoo/documentation#1517

X-original-commit: 827270c513
Signed-off-by: Morgane Demesmaeker <edm@odoo.com>
2022-02-02 13:51:54 +00:00
Niranjan Abhyankar 7ebbd348d8 [FIX] developer/javascript_cheatsheet: fix a typo
closes odoo/documentation#1518

X-original-commit: d9e2ab6feb
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-02-02 13:46:19 +00:00
boan-odoo a9bc16bec8 [IMP] rdtraining: add links from enterprise wiki
Select links and pieces of information from Odoo Enterprise wiki
were copied over at the end Chap. 2 of the functional training.

These would be useful to have during the tutorial instead of at
the end of it.

closes odoo/documentation#1473

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
Co-authored-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-02-02 10:12:01 +00:00
Xavier (xpl) 43cea7a2d2 [ADD] Sign: section on Field Types
Task #: 2585411

closes odoo/documentation#1511

X-original-commit: 7ca24b13ef
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-02-02 07:30:45 +00:00
Odoo Translation Bot f2640a6dba [I18N] Update translation terms from Transifex 2022-01-30 00:30:38 +01:00
Fabien Meghazi e8af7270ce [IMP] supported_versions: end of support for v10 on Odoo.sh
python2 tooling will be removed gradually
2022-01-29 22:58:47 +01:00
wan 434bb66492 [ADD] extensions: add a custom example admonition
closes odoo/documentation#1503

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-01-28 11:05:14 +00:00
Jonathan Castillo (jcs) a22f7cd657 [FIX] redirects.txt: wrong path for outlook doc's redirection
These paths in redirects.txt miss the first folder level, starting from
/content/ .

closes odoo/documentation#1499

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-01-28 10:04:11 +00:00
Jonathan Castillo (jcs) 7d6757d330 [MOV] payment acquirers: from /general/ (misc. section) to /finance/
The "Payment Acquirers" category was moved to the /general/ folder
(Miscellaneous section) when the super-categories such as "Finance"
didn't exist yet. Now, it makes more sense to move this category to
"Finance".

task-id 2743227

Part-of: odoo/documentation#1499
2022-01-28 10:04:11 +00:00
“Chiara 5b14e76b40 [REM] Accounting: deprecated report removal
Task-id 2744389

closes odoo/documentation#1492

X-original-commit: b34e098551
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-01-26 17:51:37 +00:00
Jennafer 8938f27820 [FIX] rdtraining: use "deprecate" rather than "depreciate"
Fixed one typo - "depreciated" to "deprecated"

closes odoo/documentation#1490

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-01-26 14:49:07 +00:00
Antoine Vandevenne (anv) b97ca3f44d [IMP] paypal: clarify steps to properly configure PayPal
The "Enable IPN" step is also removed because this setting is overruled
by the payment request that Odoo sends to PayPal. Enabling IPN in PayPal
has no effect.

task-2744043

closes odoo/documentation#1480

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-01-26 14:17:41 +00:00
Olivier Dony ce62ec91de [FIX] legal/terms: fixups for ES translation of enterprise
closes odoo/documentation#1484

X-original-commit: 69d1d32540
Signed-off-by: Olivier Dony <odo@odoo.com>
2022-01-26 02:22:57 +00:00
Ludvig Auvens 3e1a1a579b [IMP] Legal: spanish translation of enterprise.rst
Task-id: 2501357
X-original-commit: 89042fbe92
Part-of: odoo/documentation#1484
2022-01-26 02:22:57 +00:00
Valentin Chevalier 587b2862df [IMP] payment_stripe: add PM supported by Odoo
Add payment methods supported by Odoo

This will inform users of Stripe which payment method we currently
support.

task-2685143

closes odoo/documentation#1470

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-01-25 14:49:26 +00:00
Odoo Translation Bot a869d263b3 [I18N] Update translation terms from Transifex 2022-01-23 00:30:32 +01:00
“Chiara 7ca8564473 [ADD] Accounting: new page about intrastat
Task-id 2721400

closes odoo/documentation#1476

X-original-commit: aa7a78331d
Signed-off-by: Victor Feyens (vfe) <vfe@odoo.com>
2022-01-21 16:04:59 +00:00
Odoo Translation Bot 3e0c934b3c [I18N] Update translation terms from Transifex 2022-01-16 00:30:35 +01:00
Yajo 084fb777f9 [FIX] discuss, cmdline: update for static outgoing mail addresses
This changed for Odoo 15.0 in odoo/odoo#61853 and the docs didn't
reflect that change.

MT-52 @moduon

closes odoo/documentation#1455

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-01-13 09:50:42 +00:00
Stan cdb8d51131 [IMP] qweb: mention the two possible syntaxes for t-attf
closes odoo/documentation#1454

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-01-12 09:43:14 +00:00
Demesmaeker dfdbf18afa [ADD] general/payment_acquirers: add doc on Ogone Webhook Setup
task-2703230

closes odoo/documentation#1348

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-01-03 09:52:44 +00:00
Odoo Translation Bot fc2ceb9e57 [I18N] Update translation terms from Transifex 2021-12-26 00:30:31 +01:00
Paolo (pgi) 69f198e612 [IMP] accounting: add FEC import section to l10n/france
task-id 2573140

closes odoo/documentation#1435

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2021-12-21 11:10:47 +00:00
Odoo Translation Bot f3b5f8aec9 [I18N] Update translation terms from Transifex 2021-12-19 00:30:34 +01:00
Mark Fischer, Jr f0a6403b32 [FIX] expenses: grammar and typos in expenses.rst
Backport to 13.0 of PR #1175

closes odoo/documentation#1440

X-original-commit: 7090a54670
Signed-off-by: Castillo Jonathan (jcs) <jcs@odoo.com>
2021-12-17 16:29:51 +00:00
Julien Castiaux dc832e1cc8 [FIX] developer/reference/javascript_reference
The "qweb key of the manifest" file was still mentionned even if it has
been replaced by the assets bundles.

See related task: 2352566

closes odoo/documentation#1359

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2021-12-17 11:06:11 +00:00
Jairo Llopis 53cb375406 [IMP] developer/modules: deprecate 'active' and detail 'auto_install'
1. `active` is just a deprecated field that means exactly the same as
   `auto_install`.
2. `auto_install` can be a list.

See https://github.com/odoo/odoo/blob/6cb3140ea8f62a265b76ae494295f466ca6a00c4/odoo/modules/module.py#L348-L352

Original PR: https://github.com/odoo/documentation/pull/1109

closes odoo/documentation#1429

X-original-commit: 03a54e5b37
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
Co-authored-by: Antoine Vandevenne (anv) <anv@odoo.com>
2021-12-16 10:46:36 +00:00
poma-odoo 34bc61a3d3 [FIX] developer/rdtraining: comply with the guidelines for report naming
The suggested folder structure does not comply with guidelines:
https://www.odoo.com/documentation/15.0/developer/misc/other/guidelines.html#file-naming

> Concerning printable reports which contain mainly data preparation and Qweb templates naming is
the following :

    addons/plant_nursery/
    |-- report/
    |   |-- plant_order_reports.xml (report actions, paperformat, ...)
    |   |-- plant_order_templates.xml (xml report templates)

closes odoo/documentation#1350

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2021-12-03 17:38:11 +00:00
Antoine Vandevenne (anv) a692dbdc9c [IMP] developer/*: replace occurrences of "access rule" by "record rule"
Both the functional and technical name of the `ir.rule` model is "Record
Rule". This commit makes sure that all occurrences of "Access Rule" are
replaced by the correct name "Record Rule" as it was easily confused
with "Access Rights".

Original PR: https://github.com/odoo/documentation/pull/1118

closes odoo/documentation#1422

X-original-commit: 46cb0b8e9b
Signed-off-by: Victor Feyens (vfe) <vfe@odoo.com>
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2021-12-16 09:15:49 +00:00
TwioTech 87faaaf02c [IMP] PoS: six payment method configuration
closes odoo/documentation#1331

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
Co-authored-by: LoredanaLrpz <lrpz@odoo.com>
2021-12-15 11:03:37 +00:00
Adrien Minne 9d45b861c0 [FIX] rdtraining: fix wrong suggested folder for views
The training suggests to put the views in the data/ folder instead of the views/ folder

closes odoo/documentation#1349

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2021-12-14 16:53:44 +00:00
Tymoteusz Motylewski a8fe35665b [IMP] backend/testing: add link to unittest python library
closes odoo/documentation#1414

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2021-12-14 12:08:51 +00:00
Chris Parker c6cbaee4aa [FIX] api/odoo: reflect the correct location of menu actions
closes odoo/documentation#1411

X-original-commit: beb92c9f18
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2021-12-14 12:08:48 +00:00
Perman Atayev fccd2bf235 [IMP] install/maintain: fix a typo
original commit 5098eaf93f
in PR https://github.com/odoo/documentation/pull/1345/

closes odoo/documentation#1406

X-original-commit: 806a96f8cb
Signed-off-by: Victor Feyens (vfe) <vfe@odoo.com>
2021-12-13 18:11:14 +00:00
Xavier 1b5afa3d18 [IMP] studio: fix a typo
Original commit: e1e644fc9a
in PR: #1330

closes odoo/documentation#1401

X-original-commit: a1db25d3ba
Signed-off-by: Victor Feyens (vfe) <vfe@odoo.com>
2021-12-13 10:14:51 +00:00
luxiaochuang cf1504258e [FIX] howtos: remove useless <group/> tag from training example
closes odoo/documentation#1369

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2021-12-10 15:57:17 +00:00
mdb-odoo fdeff4d4f0 [IMP] inventory: push/pull explanations
forward-port of e946f5fcfd
original commit (never merged) 427b14dcae

closes odoo/documentation#1391

X-original-commit: 71fe1e09ee
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
Signed-off-by: Castillo Jonathan (jcs) <jcs@odoo.com>
2021-12-09 15:55:58 +00:00
jedgalbraith 7f80848e54 [IMP] sales: grammar fix
closes odoo/documentation#1387

X-original-commit: 4903a9fecc
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
Signed-off-by: Castillo Jonathan (jcs) <jcs@odoo.com>
2021-12-09 15:34:08 +00:00
jedgalbraith 0a83b1ebea [IMP] inventory: word mistake
closes odoo/documentation#1383

X-original-commit: 5d72b5028f
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
Signed-off-by: Castillo Jonathan (jcs) <jcs@odoo.com>
2021-12-09 15:07:46 +00:00
Antoine Vandevenne (anv) ca4f2cd2b2 [IMP] README: remove request for review instruction
closes odoo/documentation#1377

X-original-commit: 493ebbfa9a
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2021-12-09 13:38:12 +00:00
Antoine Vandevenne (anv) 67272252e7 [REM] CODEOWNERS: rely on runbot's codeowners system
closes odoo/documentation#1372

X-original-commit: edddeb4826
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2021-12-09 12:24:03 +00:00
Moens Alexandre cca654e4d9 [IMP] hosting change: from PaaS to SaaS
Requesting a dump from the customers comming from the PaaS is useless
(since support has access to the odoo.sh projects) and counter
productive (since it only makes the migration outage longer while the
customer downloads the file, then uploads it, then we download it,
instead of just the support downloading it)

closes odoo/documentation#1366

X-original-commit: c3c054681c
Signed-off-by: Victor Feyens (vfe) <vfe@odoo.com>
2021-12-08 13:54:12 +00:00
Morgane Demesmaeker 8bfa68e930 [IMP] general/payment_acquirers: rename and swap some headings
closes odoo/documentation#1227

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2021-12-08 09:17:04 +00:00
Demesmaeker 92ad3e8658 [ADD] general/payment_acquirers: add doc on Stripe Webhook Setup
and ease the way to get the api keys

task-2574512

closes odoo/documentation#1335

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2021-12-02 15:30:41 +00:00
Rémy Baranx (bar) 57e1e31433 [FIX] conf.py: check odoo_dir is a real Odoo sources dir
In `conf.py`, we try to find a Odoo sources folder among `odoo` and
`../odoo` directories without really checking that they really are
Odoo sources folders, leading to doc generation error if it's not the case.

So, to improve that, this commit checks that the selected Odoo sources folder
contains `odoo-bin`.

While we're at it, the logging is also improved to always display the
matching odoo sources' folder and version.

closes odoo/documentation#1340

X-original-commit: f72e557f2c
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
Co-authored-by: Antoine Vandevenne <anv@odoo.com>
2021-11-29 10:59:09 +00:00
lejeune quentin afa905b9c4 [FIX] point_of_sale: Update certificate import
With the new version of chrome 95 we need adapt the documentation

closes odoo/documentation#1318

X-original-commit: 0f1f90e486
Signed-off-by: Quentin Lejeune (qle) <qle@odoo.com>
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2021-11-22 07:58:58 +00:00
Géry Debongnie 8c1003e363 [IMP] developer: small rework of assets page (frontend)
This commit applies some remarks by Antoine.

closes odoo/documentation#1327

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2021-11-19 13:24:53 +00:00
luvi 1f84bab97d [ADD] developer: scroller service added
This commit adds the documentation related to
the scroller service. This service is used for
the webclient to handle clicks on links and there
were no documentation related until now.

closes odoo/documentation#1313

Signed-off-by: Géry Debongnie (ged) <ged@openerp.com>
2021-11-19 11:36:52 +00:00
Zachary Straub (ZST) 0653e3df58 [IMP] finance: remove fiscal localization countries screenshots
closes odoo/documentation#1311

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2021-11-17 11:17:49 +00:00
Antoine Dupuis (andu) 15a1f73c28 [IMP] accounting/taxcloud: how to set up default account for new taxes
New taxes generated by the TaxCloud integration are by default created without an income or an expense account specified. By default, the journal items corresponding to these taxes therefore end up in the default income account, which is usually the 'Sales' account, when they should in fact go to the 'Tax Payable' account. Because these taxes are automatically generated on-the-fly, the user is usually not able to manually specify the Tax Payable account before the journal items are posted, leading to incorrect accounting entries which then need to be manually repaired through the use of miscellaneous operations.

To solve this issue, our video on TaxCloud integration (https://www.youtube.com/watch?v=JE-NeRNIWeU&t=616s) tells us to create a User-Defined Default for the account field of the tax.repartition.line model. This sets the default account with which new taxes are created. However, this information is missing from the documentation.

This PR brings the documentation up-to-date by explaining how to create this User-Defined Default that specifies the correct Tax Payable account.

closes odoo/documentation#1321

X-original-commit: 35d773a82a
Signed-off-by: Victor Feyens (vfe) <vfe@odoo.com>
2021-11-17 09:50:08 +00:00
Valentin Chevalier e062a7c816 [ADD] product_images: add a tutorial
This will help users to get automatically images for their products.

task-2558054

closes odoo/documentation#1007

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2021-11-15 15:18:39 +00:00
Géry Debongnie d761910466 [IMP] developer: list content of browser object (js)
closes odoo/documentation#1310

Signed-off-by: Géry Debongnie (ged) <ged@openerp.com>
2021-11-15 09:25:07 +00:00
Bruno Boi 43d838d826 [IMP] developer: more info for usePosition JS hook
closes odoo/documentation#1305

Signed-off-by: Bruno Boi <boi@odoo.com>
2021-11-10 14:21:21 +00:00
lejeune quentin 7c0c6c44bf [ADD] point_of_sale: self-signed certificate for epos printers
Add documentation to explain how to use a ePos printer in HTTPS

closes odoo/documentation#1307

X-original-commit: f8f93ec288
Signed-off-by: Castillo Jonathan (jcs) <jcs@odoo.com>
2021-11-09 17:11:42 +00:00
Simon Genin (ges) bbc85e148e [ADD] developer: add js http service
closes odoo/documentation#1293

Signed-off-by: Simon Genin (ges@odoo) <ges@odoo.com>
2021-11-09 16:56:01 +00:00
Géry Debongnie 624131f712 [IMP] developer: document formatters/parsers registries
and add entry for effects registry as well

closes odoo/documentation#1300

Signed-off-by: Géry Debongnie (ged) <ged@openerp.com>
2021-11-08 16:00:37 +00:00
Géry Debongnie 8c79319011 [IMP] developer: rewrite the page on assets
closes odoo/documentation#1299

Signed-off-by: Géry Debongnie (ged) <ged@openerp.com>
2021-11-08 15:56:49 +00:00
Géry Debongnie 11171da6b1 [IMP] developer: add section on router service
closes odoo/documentation#1292

Signed-off-by: Géry Debongnie (ged) <ged@openerp.com>
2021-11-05 14:15:36 +00:00
Géry Debongnie d551193391 [IMP] developer: add missing links in js doc
and slightly improve effect registry page

closes odoo/documentation#1296

Signed-off-by: Géry Debongnie (ged) <ged@openerp.com>
2021-11-05 10:12:35 +00:00
Raf Geens 43193d6749 [FIX] testing: Explain "new" tagging syntax
Syntax was added to explicitly specify a module, class or function with
`--test-tags`: https://github.com/odoo/odoo/commit/b729a11a121e53857063be00308904ed4d8dd2a0

The documentation was not updated to reflect this, leading to confusion
as people tried to reconcile the documentation with the actual behavior,
without necessarily having seen `odoo-bin --help` which is explicit
about it.

closes odoo/documentation#1281

X-original-commit: 77dd769b08
Signed-off-by: Victor Feyens (vfe) <vfe@odoo.com>
Signed-off-by: Raf Geens <raf@odoo.com>
2021-11-05 08:57:44 +00:00
Géry Debongnie 894165a949 [IMP] developer: normalize reference in js doc
The preferred format for (frontend) references is now:
"frontend/filename/section", or something close to that.

closes odoo/documentation#1291

Signed-off-by: Géry Debongnie (ged) <ged@openerp.com>
2021-11-04 13:43:37 +00:00
Géry Debongnie b48f0cbad8 [IMP] developer: rework section on debug mode
closes odoo/documentation#1280

Signed-off-by: Géry Debongnie (ged) <ged@openerp.com>
2021-11-03 20:01:46 +00:00
Géry Debongnie da4dae597e [IMP] developer: add sections on pyjs and domains
closes odoo/documentation#1248

Signed-off-by: Géry Debongnie (ged) <ged@openerp.com>
2021-11-03 19:48:26 +00:00
Géry Debongnie f206233ebc [MOV] developer: move section on patching javascript
This commit is a move, but the content was also slightly
updated/reformatted.

closes odoo/documentation#1244

Signed-off-by: Géry Debongnie (ged) <ged@openerp.com>
2021-11-03 17:48:14 +00:00
Géry Debongnie 91f97aff54 [IMP] developer: add Dropdown documentation
joint work with Bruno (boi)

closes odoo/documentation#1247

Signed-off-by: Géry Debongnie (ged) <ged@openerp.com>
2021-11-03 16:26:55 +00:00
Jonathan Castillo (jcs) 94b26c5fe0 [IMP] website: update a wrong link (godaddy)
task-id 2682327

closes odoo/documentation#1285

X-original-commit: edb747bca1
Signed-off-by: Castillo Jonathan (jcs) <jcs@odoo.com>
2021-11-03 16:16:45 +00:00
Christophe Monniez cbd85f1f47 [FIX] Makefile: call pysassc from python module
pysassc utility is called in the Makefile. On some system (e.g.: the latest
Dockerfile of the runbot) this utility cannot be found in the system's
paths.

As the pysassc utility is a wrapper for the python module, we can simply
call the python module by it's entrypoint.

Also, this commit fixes the requirements as the pysass package was
installed to incidentally install libsass.

closes odoo/documentation#1269

Signed-off-by: Christophe Monniez (moc) <moc@odoo.com>
2021-11-03 11:04:17 +00:00
Antoine Vandevenne (anv) 8425ddc444 [FIX] requirements.txt: Let sphinx manage docutils version
As of sphinx 3.5.4, docutils >0.17 is no longer supported. To avoid
forcing the install of an unsupported version of docutils, we let
sphinx install the appropriate version through its dependencies.

closes odoo/documentation#1275

X-original-commit: 116d9b5181
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2021-11-03 10:45:25 +00:00
Simon Genin (ges) 05a0a49a20 [IMP] js: js domain css customization
closes odoo/documentation#1206

Signed-off-by: Simon Genin (ges@odoo) <ges@odoo.com>
2021-11-03 09:19:09 +00:00
Simon Genin (ges) d72c3fdd8b [ADD] developer: effect service
closes odoo/documentation#1210

Signed-off-by: Simon Genin (ges@odoo) <ges@odoo.com>
2021-11-03 09:00:43 +00:00
Géry Debongnie 1e6c12be30 [IMP] developer: improve section on env
- add a link to services
- add a note that the env is quite powerful
- reformat the table with the list-table role, to make it easier to edit

closes odoo/documentation#1249

Signed-off-by: Victor Feyens (vfe) <vfe@odoo.com>
2021-11-03 08:36:04 +00:00
Géry Debongnie 4082906776 [IMP] developer: reorder and improve notification service
closes odoo/documentation#1265

Signed-off-by: Victor Feyens (vfe) <vfe@odoo.com>
2021-11-03 08:25:52 +00:00
Géry Debongnie b4fce0a13d [IMP] developer: add section on cookie service
and slightly improve notification information

closes odoo/documentation#1241

Signed-off-by: Géry Debongnie (ged) <ged@openerp.com>
2021-11-02 19:55:52 +00:00
Géry Debongnie f564487e56 [IMP] developer: add section on debug mode (js)
closes odoo/documentation#1250

Signed-off-by: Géry Debongnie (ged) <ged@openerp.com>
2021-11-02 19:12:36 +00:00
Géry Debongnie ce96d6c584 [IMP] developer: use js domain for registry page
This commit update the registry documentation to use the js domain
directives instead of trying to format functions with code blocks.

I am not impressed with the way it looks, but in any cases, it is
certainly better to properly structure the documentation.

closes odoo/documentation#1245

Signed-off-by: Géry Debongnie (ged) <ged@openerp.com>
2021-11-02 14:32:57 +00:00
Géry Debongnie a2a389688c [FIX] developer: document assets key in manifest, remove old info
This commit adds a pretty important missing piece of information: the
assets key in the manifest. At the same time, we remove two keys that
are no longer in use.

closes odoo/documentation#1251

Signed-off-by: Victor Feyens (vfe) <vfe@odoo.com>
2021-11-02 14:17:58 +00:00
Géry Debongnie 06b6c18972 [MOV] developer: move assets doc into frontend
Now that the reference is split into backend/frontend, it makes more
sense to have the assets page into the frontend section.

closes odoo/documentation#1243

Signed-off-by: Géry Debongnie (ged) <ged@openerp.com>
2021-11-02 13:42:38 +00:00
Géry Debongnie a76e505892 [IMP] developer: rename addons/js => backend/frontend
The terminology did not really make sense for a lot of these sub pages.
This change should have been done long ago, but was probably delayed
because some people in Odoo call the web client the "backend", which is
really misleading.

This commit also renames the title "Reference Guides" to "Reference",
since this section does not contain any guides anyway.

Part-of: odoo/documentation#1243
2021-11-02 13:42:38 +00:00
Martin Trigaux 4fb6c72d75 [FIX] conf: allow to build on python 3.6
Since odoo/odoo@794677fb6a Odoo requires python 3.7 min.
However, it still runs fine in 3.6 and this is the python version of
the build server.
Fake the version to be able to build the doc on the nightly server.

To be removed once the nightly server is migrated.

closes odoo/documentation#1257

Signed-off-by: Martin Trigaux (mat) <mat@odoo.com>
2021-11-02 13:33:59 +00:00
Géry Debongnie a8172fa67a [IMP] developer: add section on user menu registry (js)
closes odoo/documentation#1246

Signed-off-by: Victor Feyens (vfe) <vfe@odoo.com>
2021-11-02 11:07:54 +00:00
Géry Debongnie a4a0f65c5d [IMP] developer: add sections on service and systray registry
Part-of: odoo/documentation#1246
2021-11-02 11:07:54 +00:00
frln 26042f541a [IMP] administration/install, *: make 3.7 the minimum version for Python
As of commit https://github.com/odoo/odoo/commit/794677fb Python 3.7 is
the minimum required version for Python when running Odoo 15.0.

This also applies to building the version 15.0 of the documentation.

closes odoo/documentation#1218

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2021-11-02 10:51:49 +00:00
Michael (mcm) 1ea99ca48c [IMP] developer/views: update map doc
This commit updates the documentation of the map view.
There were missing map attributes, typos and wrong descriptions.

closes odoo/documentation#1253

Signed-off-by: Victor Feyens (vfe) <vfe@odoo.com>
2021-11-02 10:22:14 +00:00
Martin Trigaux bd2fe4a6fe [I18N] *: export 15.0 translations 2021-11-02 10:26:17 +01:00
Simon Genin (ges) 363e5446b5 [ADD] developer: notification service
closes odoo/documentation#1233

Signed-off-by: Simon Genin (ges@odoo) <ges@odoo.com>
2021-10-29 12:45:25 +00:00
Simon Genin (ges) eca14b6620 [Add] developer: add section on js title service
closes odoo/documentation#1230

Signed-off-by: Géry Debongnie (ged) <ged@openerp.com>
2021-10-29 12:19:44 +00:00
Géry Debongnie 05ab4a7b0a [IMP] developer: add information on bus (js)
and move the section on environment to the framework main documentation
page.

closes odoo/documentation#1228

Signed-off-by: Géry Debongnie (ged) <ged@openerp.com>
2021-10-29 10:22:49 +00:00
Simon Genin (ges) 1757e01eca [Add] developer: add js user service
closes odoo/documentation#1202

Signed-off-by: Simon Genin (ges@odoo) <ges@odoo.com>
2021-10-29 07:45:02 +00:00
Géry Debongnie 9b02ea8474 [IMP] developer: add section on context in js framework page
closes odoo/documentation#1225

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2021-10-28 09:37:41 +00:00
Géry Debongnie eea6a94411 [ADD] developer: add a reference page on hooks (js)
closes odoo/documentation#1208

Signed-off-by: Géry Debongnie (ged) <ged@openerp.com>
2021-10-26 11:13:21 +00:00
Géry Debongnie 8bdbb415b5 [ADD] developer: add page on generic components (js)
closes odoo/documentation#1209

Signed-off-by: Géry Debongnie (ged) <ged@openerp.com>
2021-10-26 08:43:38 +00:00
Jonathan Castillo (jcs) 2aeffd3950 [ADD] maintain: revert and update "db_online"
task-2601835

closes odoo/documentation#1220

X-original-commit: d7f4475901
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2021-10-25 14:08:08 +00:00
Géry Debongnie e19e13606b [MOV] developer: move assets doc into its own page
closes odoo/documentation#1196

Signed-off-by: Géry Debongnie (ged) <ged@openerp.com>
2021-10-22 13:39:37 +00:00
Julien Van Roy 1e284a4455 [FIX] developer/reference: fix missing slash in javascript/qweb, debugging section
closes odoo/documentation#1214

X-original-commit: 7fbf1c3ef2
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2021-10-22 13:18:42 +00:00
Géry Debongnie a5a669a5eb [ADD] developer: add new page on registries (js)
closes odoo/documentation#1193

Signed-off-by: Géry Debongnie (ged) <ged@openerp.com>
2021-10-22 13:13:51 +00:00
Géry Debongnie ddad75982f [ADD] developer: add page on services (js)
closes odoo/documentation#1194

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2021-10-22 12:48:55 +00:00
Géry Debongnie c6f813f4cb [ADD] developer: add javascript module page
This commit moves most of the content out of the javascript reference
and into a more visible page.

closes odoo/documentation#1192

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2021-10-22 12:33:05 +00:00
lejeune quentin 8f7695b8ba [ADD] point_of_sale: configure https in the POS
The default protocol int the POS with "other device"
is on HTTP.

This doc explain how to activate the HTTPS in the POS

closes odoo/documentation#1204

X-original-commit: a160504b8d
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2021-10-21 11:02:47 +00:00
Olivier Dony d679d45769 [ADD] legal/license: update licenses for v15 2021-10-20 11:26:49 +02:00
Olivier Dony b21528bd7b [FIX] legal/terms: fr: simplify limitation of liability
The english version has a confusing wording, using "strict ngligence"
instead of "strict liability" in this sentence:
  "(...) regardless of the form of action, whether in contract, tort
   (including strict negligence) or any other legal (...)"

In FR/BE this would seeem to refer to the notion of "responsabilité
objective" ou "responsabilité sans faute".

Yet this extra precision seems confusing and does not seem to add to the
already broad clause. It seems simpler to omit it.

The typical english wording for this clause is simply:
"regardless of the form of action, whether in contract, tort or otherwise".
2021-10-20 11:20:29 +02:00
Olivier Dony 9ddd60de3e [CHG] legal/tos: specify pricelist for global customers 2021-10-20 11:15:42 +02:00
Antoine Vandevenne (anv) b697bf28b7 [FIX] extract_api: bring back extract_api doc lost with be1653cc
closes odoo/documentation#1198

X-original-commit: 59df6b90ae
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2021-10-20 07:38:51 +00:00
Géry Debongnie b4e8e475f0 [ADD] developer: add page on owl component system
closes odoo/documentation#1178

Signed-off-by: Géry Debongnie (ged) <ged@openerp.com>
2021-10-15 15:00:57 +00:00
Géry Debongnie ff5a50856f [ADD] developer: add javascript framework overview
closes odoo/documentation#1181

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2021-10-15 14:32:39 +00:00
Jonathan Castillo (jcs) 7b1b1c795d [IMP] upgrade: create new "upgrade" section in "install and maintain"
closes odoo/documentation#1186

X-original-commit: fd006b4a3c
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
Signed-off-by: Jonathan <jcs-odoo@users.noreply.github.com>
2021-10-15 11:45:14 +00:00
Jonathan Castillo (jcs) 00df7aee21 [IMP] maintain: on premise filename change and media movement
X-original-commit: 8ca7d66faa
Part-of: odoo/documentation#1186
2021-10-15 11:45:14 +00:00
Jonathan Castillo (jcs) b1099e2218 [IMP] maintain: update versions upgrade
task-2600310

X-original-commit: 84ceee3fda
Part-of: odoo/documentation#1186
2021-10-15 11:45:13 +00:00
Olivier Dony a8c58815f3 [FIX] mail_plugins: fix outlook plugin url
The outlook plugin (v2.0.0) for v15 is not compatible with
older databases, so we need both version to be hosted
separately, and therefore a new URL.
2021-10-13 19:39:43 +02:00
Valentin Chevalier (vcr) a4aa310b85 [FIX] payment_acquirers/paypal: broken link
Users couldn't click on Paypal and saw the HTTP link instead of only 'Paypal'

closes odoo/documentation#1174

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2021-10-12 14:36:49 +00:00
Xavier 4331177bb6 [IMP] mail plugins: improve the naming consistency of plugins
The plugins were named "Odoo-Gmail Plugin" / "Gmail Plugin" and "Odoo-Outlook Plugin" /
"Outlook Plugin". I chose the later version for both plugins consistently.
I also added a reference to both the Gmail and Outlook docs in the main Mail Plugins doc.

closes odoo/documentation#1170

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2021-10-11 09:39:43 +00:00
Xavier debe8cb393 [IMP] mail plugins: add gmail plugin + update and move outlook plugin
Task ID: 2662764

closes odoo/documentation#1167

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2021-10-07 18:23:02 +00:00
Demesmaeker 3a2bbc028b [IMP] payment_acquirers: revamp online payment providers' documentation
task-2654702

closes odoo/documentation#1061

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2021-10-05 17:24:43 +00:00
Antoine Vandevenne (anv) b28e34b357 [REL] supported_versions: update list of versions and add end of support
closes odoo/documentation#1162

X-original-commit: e0c70eb5ff
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2021-10-05 15:17:53 +00:00
Antoine Vandevenne (anv) c107d76086 [IMP] contributing: adapt the GitHub workflow to the new doc theme
closes odoo/documentation#1159

X-original-commit: 8043d92b24
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2021-10-05 14:23:56 +00:00
Antoine Vandevenne (anv) b118669860 [REL] freeze 15.0 branch 2021-10-05 13:50:03 +02:00
Denis Ledoux 3218d318fe [FIX] maintain: upgrade command line link
closes odoo/documentation#1150

X-original-commit: 7276929071
Signed-off-by: Victor Feyens (vfe) <vfe@odoo.com>
2021-09-22 10:37:59 +00:00
Tiffany Chang (tic) bb3996b936 [IMP] developer/{howtos,reference}: update training to match v15 changes
- Reference v15 training solutions
- Refer to Command namespace instead of triplets (e.g.
  Command.create(values) instead of (0, 0, values)
- Add notice about OWL transition
- Add reference to @api.ondelete (instead of override unlink())
- Remove references to SavepointCase (now only TransactionCase) from
  unit test topic

- Also add missing reference documentation for ondelete

closes odoo/documentation#1146

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2021-09-20 11:47:42 +00:00
Tiffany Chang (tic) b3845ae0d8 [IMP] developer/howtos: proofread adv topics
- Cleaned up the language a tiny bit
- Fixed small errors/typos
- Add some missing info for dashboard topic
- Updated unit test exercise to match what's in the solutions repo

Part-of: odoo/documentation#1146
2021-09-20 11:47:42 +00:00
Tiffany Chang (tic) 85410bd8dc [IMP] developer/howtos: encourage linters more
There have been complaints of newbies not setting up their linters
therefore let's emphasize their use/setup more in the tutorial and hope
for the best.

Part-of: odoo/documentation#1146
2021-09-20 11:47:42 +00:00
Jonathan Castillo (jcs) 248135a48e [IMP] maintain: update test doc link in versions upgrade
closes odoo/documentation#1141

X-original-commit: 0842b682fc
Signed-off-by: Victor Feyens (vfe) <vfe@odoo.com>
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2021-09-14 16:23:07 +00:00
Raf Geens 6833379ad3 [FIX] app/accounting: Fix outdated Colombian test server url
The test server url for Carvajal T&S was out of date and has been
updated with the correct one. Carvajal has also split into 2
different companies, with new customers using the new company (CSC)
by default but the older company (CTS) still being available for
existing customers. See task 2508208. So the documentation was
updated to include both of them.

CTS (Carvajal T&S) was being used to refer to Carvajal in general,
so to avoid confusion those mentions have been changed to just
"Carvajal" since it can refer to either CTS or CSC.

closes odoo/documentation#1138

X-original-commit: 396df2abdd
Signed-off-by: Victor Feyens (vfe) <vfe@odoo.com>
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2021-09-14 16:18:51 +00:00
Jonathan Castillo (jcs) 00046cb690 [FIX] subscriptions: wrong Odoo Tutorials link
task-2636416

closes odoo/documentation#1136

X-original-commit: ebf216cc8e
Signed-off-by: Victor Feyens (vfe) <vfe@odoo.com>
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2021-09-14 12:31:13 +00:00
Antoine Vandevenne (anv) ac40d2008c [IMP] conf: hide saas branches from the version switcher 2021-09-09 17:22:27 +02:00
Antoine Vandevenne (anv) 5cef86f181 [REL] freeze saas-14.5 branch 2021-09-09 16:25:46 +02:00
3159 changed files with 479783 additions and 148527 deletions
+2
View File
@@ -0,0 +1,2 @@
# Include RST files in language statistics on GitHub.
*.rst linguist-detectable
-11
View File
@@ -1,11 +0,0 @@
# All changes to technical files (build environment and Sphinx extensions) have to be approved
/extensions/ @odoo/doc-review
.gitignore @odoo/doc-review
commit_template.txt @odoo/doc-review
conf.py @odoo/doc-review
Makefile @odoo/doc-review
requirements.txt @odoo/doc-review
# All changes to legal material have to be approved
/content/legal/ @odoo/legal
/content/legal.rst @odoo/legal
+2 -1
View File
@@ -1,6 +1,7 @@
*.pyc
.*
*.mo
.*
!.gitattributes
# Sphinx build files
_build/
+19 -14
View File
@@ -1,63 +1,68 @@
[main]
host = https://www.transifex.com
type = PO
[odoo-14-doc.applications]
[o:odoo:p:odoo-15-doc:r:administration]
file_filter = locale/<lang>/LC_MESSAGES/administration.po
source_file = locale/sources/administration.pot
source_lang = en
[o:odoo:p:odoo-15-doc:r:applications]
file_filter = locale/<lang>/LC_MESSAGES/applications.po
source_file = locale/sources/applications.pot
source_lang = en
[odoo-14-doc.finance]
[o:odoo:p:odoo-15-doc:r:finance]
file_filter = locale/<lang>/LC_MESSAGES/finance.po
source_file = locale/sources/finance.pot
source_lang = en
[odoo-14-doc.general]
[o:odoo:p:odoo-15-doc:r:general]
file_filter = locale/<lang>/LC_MESSAGES/general.po
source_file = locale/sources/general.pot
source_lang = en
[odoo-14-doc.index]
[o:odoo:p:odoo-15-doc:r:index]
file_filter = locale/<lang>/LC_MESSAGES/index.po
source_file = locale/sources/index.pot
source_lang = en
[odoo-14-doc.inventory_and_mrp]
[o:odoo:p:odoo-15-doc:r:inventory_and_mrp]
file_filter = locale/<lang>/LC_MESSAGES/inventory_and_mrp.po
source_file = locale/sources/inventory_and_mrp.pot
source_lang = en
[odoo-14-doc.marketing]
[o:odoo:p:odoo-15-doc:r:marketing]
file_filter = locale/<lang>/LC_MESSAGES/marketing.po
source_file = locale/sources/marketing.pot
source_lang = en
[odoo-14-doc.productivity]
[o:odoo:p:odoo-15-doc:r:productivity]
file_filter = locale/<lang>/LC_MESSAGES/productivity.po
source_file = locale/sources/productivity.pot
source_lang = en
[odoo-14-doc.sales]
[o:odoo:p:odoo-15-doc:r:sales]
file_filter = locale/<lang>/LC_MESSAGES/sales.po
source_file = locale/sources/sales.pot
source_lang = en
[odoo-14-doc.services]
[o:odoo:p:odoo-15-doc:r:services]
file_filter = locale/<lang>/LC_MESSAGES/services.po
source_file = locale/sources/services.pot
source_lang = en
[odoo-14-doc.theme]
[o:odoo:p:odoo-15-doc:r:theme]
file_filter = locale/<lang>/LC_MESSAGES/sphinx.po
source_file = locale/sources/sphinx.pot
source_lang = en
[odoo-14-doc.user_settings]
[o:odoo:p:odoo-15-doc:r:user_settings]
file_filter = locale/<lang>/LC_MESSAGES/settings.po
source_file = locale/sources/settings.pot
source_lang = en
[odoo-14-doc.websites]
[o:odoo:p:odoo-15-doc:r:websites]
file_filter = locale/<lang>/LC_MESSAGES/websites.po
source_file = locale/sources/websites.pot
source_lang = en
source_lang = en
+10 -4
View File
@@ -19,12 +19,14 @@ SPHINXOPTS = -D project_root=$(ROOT) -D canonical_version=$(CANONICAL_VERSIO
-D versions=$(VERSIONS) -D languages=$(LANGUAGES) -D language=$(CURRENT_LANG) \
-D is_remote_build=$(IS_REMOTE_BUILD) \
-A google_analytics_key=$(GOOGLE_ANALYTICS_KEY) \
-A plausible_script=$(PLAUSIBLE_SCRIPT) \
-A plausible_domain=$(PLAUSIBLE_DOMAIN) \
-j $(WORKERS)
SOURCE_DIR = content
HTML_BUILD_DIR = $(BUILD_DIR)/html
ifdef VERSIONS
HTML_BUILD_DIR := $(HTML_BUILD_DIR)/master
HTML_BUILD_DIR := $(HTML_BUILD_DIR)/15.0
endif
ifneq ($(CURRENT_LANG),en)
HTML_BUILD_DIR := $(HTML_BUILD_DIR)/$(CURRENT_LANG)
@@ -40,6 +42,7 @@ help:
@echo " html to build the documentation to HTML"
@echo " fast to build the documentation to HTML with shallow menu (faster)"
@echo " clean to delete the build files"
@echo " test to run the guidelines tests"
clean:
@echo "Cleaning build files..."
@@ -53,7 +56,7 @@ html: $(HTML_BUILD_DIR)/_static/style.css
# To call *after* `make html`
# Binary dependencies (Debian): texlive-fonts-recommended texlive-latex-extra
# texlive-generic-recommended texlive-fonts-extra
# texlive-fonts-extra
latexpdf:
@echo "Starting build..."
$(SPHINX_BUILD) -c $(CONFIG_DIR) -b latex $(SPHINXOPTS) $(SOURCE_DIR) $(BUILD_DIR)/latex
@@ -69,7 +72,7 @@ gettext:
$(HTML_BUILD_DIR)/_static/style.css: extensions/odoo_theme/static/style.scss extensions/odoo_theme/static/scss/*.scss
@echo "Compiling stylesheets..."
mkdir -p $(HTML_BUILD_DIR)/_static
pysassc extensions/odoo_theme/static/style.scss $(HTML_BUILD_DIR)/_static/style.css
python3 -m pysassc extensions/odoo_theme/static/style.scss $(HTML_BUILD_DIR)/_static/style.css
@echo "Compilation finished."
#=== Development and debugging rules ===#
@@ -77,6 +80,9 @@ $(HTML_BUILD_DIR)/_static/style.css: extensions/odoo_theme/static/style.scss ext
fast: SPHINXOPTS += -A collapse_menu=True
fast: html
static: $(HTML_BUILD_DIR)/static/style.css
static: $(HTML_BUILD_DIR)/_static/style.css
cp -r extensions/odoo_theme/static/* $(HTML_BUILD_DIR)/_static/
cp -r static/* $(HTML_BUILD_DIR)/_static/
test:
python tests/rst_style.py $(SOURCE_DIR)
+13 -27
View File
@@ -4,47 +4,33 @@
### Requirements
- [Git](https://www.odoo.com/documentation/master/contributing/documentation.html#install-git)
- [Python 3.6, 3.7, or 3.8](https://www.odoo.com/documentation/master/contributing/documentation.html#python)
- Python dependencies listed in the file [`requirements.txt`](https://github.com/odoo/documentation/tree/master/requirements.txt).
- [Make](https://www.odoo.com/documentation/master/contributing/documentation.html#make)
- A local copy of the [odoo/odoo repository in master](https://github.com/odoo/odoo/tree/master) (Optional)
- Git
- Python 3.6, 3.7, or 3.8
- Python dependencies listed in the file `requirements.txt`.
- Make
- A local copy of the [odoo/odoo repository](https://github.com/odoo/odoo) (optional)
### Instructions
1. In a terminal, navigate to the root directory and compile the documentation to HTML with the
following command:
```sh
make
```
1. In a terminal, navigate to the root directory of the documentation and build it `make`.
Additional commands are available with `make help`.
2. Open the file `documentation/_build/html/index.html` in your web browser to display the render.
3. See [this guide](https://www.odoo.com/documentation/master/contributing/documentation.html#preview-your-changes)
2. Open the file `documentation/_build/html/index.html` in your web browser.
3. See [this guide](https://www.odoo.com/documentation/latest/contributing/documentation.html)
for more detailed instructions.
Optional: to fully build the developer documentation with inline docstrings for documented Python
functions, place your local copy of the `odoo/odoo` repository in the root directory. Alternatively,
create a symbolic link with `odoo` as link name. If the Odoo sources are not found, a warning will
be shown.
Optional: place your local copy of the `odoo/odoo` repository in the parent directory or in the root
directory of the documentation to build the latter with the documented Python docstrings.
## Contribute to the documentation
For contributions to the content of the documentation, please refer to the
[Introduction Guide](https://www.odoo.com/documentation/master/contributing/documentation.html).
[Introduction Guide](https://www.odoo.com/documentation/latest/contributing/documentation.html).
To **report a content issue**, **request new content** or **ask a question**, use the
[repository's issue tracker](https://github.com/odoo/documentation-user/issues) as usual.
If you have a pull request that is ready for review, request one from the
[odoo/doc-review](https://github.com/orgs/odoo/teams/doc-review) team.
[repository's issue tracker](https://github.com/odoo/documentation/issues).
## Learn More
To learn more about Odoo, in addition to the documentation, have a look at
[the official eLearning](https://odoo.com/slides) and
[Scale-up, The Business Game](https://www.odoo.com/page/scale-up-business-game).
[Scale-up, The Business Game](https://www.odoo.com/page/scale-up-business-game).
+1 -1
View File
@@ -16,4 +16,4 @@
# [REM] = Removal
# [REF] = Refactoring (restructuring)
# [MOV] = Move/rename
#
#
+189 -66
View File
@@ -1,11 +1,14 @@
import re
import os
import re
import shutil
import sys
from pathlib import Path
from pygments.lexers import JsonLexer, XmlLexer
from sphinx.util import logging
import docutils
import sphinx
from pygments.lexers import JsonLexer, XmlLexer
from sphinx.ext import graphviz
from sphinx.util import logging
_logger = logging.getLogger(__name__)
@@ -16,10 +19,24 @@ _logger = logging.getLogger(__name__)
project = 'Odoo'
copyright = 'Odoo S.A.'
# `version` if the version info for the project being documented, acts as replacement for |version|,
# `version` is the version info for the project being documented, acts as replacement for |version|,
# also used in various other places throughout the built documents.
# `release` is the full version, including alpha/beta/rc tags. Acts as replacement for |release|.
version = release = 'master'
version = release = '15.0'
# `current_branch` is the technical name of the current branch.
# E.g., saas-15.4 -> saas-15.4; 12.0 -> 12.0, master -> master (*).
current_branch = version
# `current_version` is the Odoo version linked to the current branch.
# E.g., saas-15.4 -> 15.4; 12.0 -> 12; master -> master (*).
current_version = current_branch.replace('saas-', '').replace('.0', '')
# `current_major_branch` is the technical name of the major branch before the current branch.
# E.g., saas-15.4 -> 15.0; 12.0 -> 12.0; master -> master (*).
current_major_branch = re.sub(r'\.\d', '.0', current_branch.replace('saas-', ''))
# `current_major_version` is the Odoo version linked to the current major branch.
# E.g., saas-15.4 -> 15; 12.0 -> 12; master -> master (*).
current_major_version = current_major_branch.replace('.0', '')
# (*): We don't care for master.
# The minimal Sphinx version required to build the documentation.
needs_sphinx = '3.0.0'
@@ -48,52 +65,85 @@ exclude_patterns = [
# See https://docutils.sourceforge.io/docs/ref/rst/roles.html#standard-roles for other roles.
default_role = 'literal'
# Whether scaled down images should be be wrapped in a `<a/>` tag linking to the image file or not.
html_scaled_image_link = False
# If true, '()' will be appended to :func: etc. cross-reference text
add_function_parentheses = True
#=== Extensions configuration ===#
source_read_replace_vals = {
'BRANCH': current_branch,
'CURRENT_BRANCH': current_branch,
'CURRENT_VERSION': current_version,
'CURRENT_MAJOR_BRANCH': current_major_branch,
'CURRENT_MAJOR_VERSION': current_major_version,
'GITHUB_PATH': f'https://github.com/odoo/odoo/blob/{version}',
'GITHUB_ENT_PATH': f'https://github.com/odoo/enterprise/blob/{version}',
}
# Add extensions directory to PYTHONPATH
extension_dir = Path('extensions')
sys.path.insert(0, str(extension_dir.absolute()))
# Search for the directory of odoo sources to know whether autodoc should be used on the dev doc
odoo_dir = Path('odoo')
odoo_sources_candidate_dirs = (Path('odoo'), Path('../odoo'))
odoo_sources_dirs = [
d for d in odoo_sources_candidate_dirs if d.is_dir() and (d / 'odoo-bin').exists()
]
odoo_dir_in_path = False
if not odoo_dir.is_dir():
parent_odoo_dir = Path('../odoo')
if parent_odoo_dir.is_dir():
_logger.info('Using parent dir to find odoo sources')
odoo_dir = parent_odoo_dir
if not odoo_dir.is_dir():
if not odoo_sources_dirs:
_logger.warning(
f"Could not find Odoo sources directory at {odoo_dir.absolute()}.\n"
f"The 'Developer' documentation will be built but autodoc directives will be skipped.\n"
f"In order to fully build the 'Developer' documentation, clone the repository with "
f"`git clone https://github.com/odoo/odoo` or create a symbolink link."
"Could not find Odoo sources directory in neither of the following folders:\n"
"%(dir_list)s\n"
"The 'Developer' documentation will be built but autodoc directives will be skipped.\n"
"In order to fully build the 'Developer' documentation, clone the repository with "
"`git clone https://github.com/odoo/odoo` or create a symbolic link.",
{'dir_list': '\n'.join([f'\t- {d.resolve()}' for d in odoo_sources_candidate_dirs])},
)
else:
sys.path.insert(0, str(odoo_dir.absolute()))
if (3, 6) < sys.version_info < (3, 7):
# Running odoo needs python 3.7 min but monkey patch version_info to be compatible with 3.6.
sys.version_info = (3, 7, 0)
odoo_dir = odoo_sources_dirs[0].resolve()
source_read_replace_vals['ODOO_RELPATH'] = '/../' + str(odoo_sources_dirs[0])
sys.path.insert(0, str(odoo_dir))
import odoo.addons
odoo.addons.__path__.append(str(odoo_dir) + '/addons')
from odoo import release as odoo_release # Don't collide with Sphinx's 'release' config option
odoo_version = odoo_release.version if 'alpha' not in odoo_release.version else 'master'
odoo_version = odoo_release.version.replace('~', '-') \
if 'alpha' not in odoo_release.version else 'master'
if release != odoo_version:
_logger.warning(
f"Found Odoo sources directory but with version '{odoo_version}' incompatible with "
f"documentation version '{version}'.\n"
f"The 'Developer' documentation will be built but autodoc directives will be skipped.\n"
f"In order to fully build the 'Developer' documentation, checkout the matching branch"
f" with `cd odoo && git checkout {version}`."
"Found Odoo sources in %(directory)s but with version '%(odoo_version)s' incompatible "
"with documentation version '%(doc_version)s'.\n"
"The 'Developer' documentation will be built but autodoc directives will be skipped.\n"
"In order to fully build the 'Developer' documentation, checkout the matching branch"
" with `cd odoo && git checkout %(doc_version)s`.",
{'directory': odoo_dir, 'odoo_version': odoo_version, 'doc_version': version},
)
else:
_logger.info(f"Found Odoo sources directory matching documentation version {release}.")
_logger.info(
"Found Odoo sources in %(directory)s matching documentation version '%(version)s'.",
{'directory': odoo_dir, 'version': release},
)
odoo_dir_in_path = True
# Mapping between odoo models related to master data and the declaration of the
# data. This is used to point users to available xml_ids when giving values for
# a field with the autodoc_field extension.
model_references = {
'account.account.type': 'addons/account/data/data_account_type.xml',
'res.country': 'odoo/addons/base/data/res_country_data.xml',
'res.currency': 'odoo/addons/base/data/res_currency_data.xml',
}
# The Sphinx extensions to use, as module names.
# They can be extensions coming with Sphinx (named 'sphinx.ext.*') or custom ones.
extensions = [
# Parse Python docstrings (autodoc, automodule, autoattribute directives)
'sphinx.ext.autodoc' if odoo_dir_in_path else 'autodoc_placeholder',
# Link sources in other projects (used to build the reference doc)
'sphinx.ext.intersphinx',
@@ -106,23 +156,35 @@ extensions = [
# Youtube and Vimeo videos integration (youtube, vimeo directives)
'embedded_video',
'exercise_admonition',
'custom_admonitions',
# Redirection generator
'redirects',
# Code switcher (switcher and case directives)
'switcher',
# Content tabs
'sphinx_tabs.tabs',
# Spoilers
'spoilers',
# Strange html domain logic used in memento pages
'html_domain',
]
if odoo_dir_in_path:
# GitHub links generation
extensions += [
'sphinx.ext.linkcode',
'github_link',
# Parse Python docstrings (autodoc, automodule, autoattribute directives)
'sphinx.ext.autodoc',
'autodoc_field',
]
else:
extensions += [
'autodoc_placeholder',
]
extensions.append('sphinx.ext.graphviz' if shutil.which('dot') else 'graphviz_placeholder')
todo_include_todos = False
@@ -142,19 +204,36 @@ sphinx.transforms.i18n.docname_to_domain = (
sphinx.util.i18n.docname_to_domain
) = lambda docname, compact: docname.split('/')[1 if docname.startswith('applications/') else 0]
supported_languages = {
'de': 'Deutsch',
'en': 'English',
'es': 'Español',
'fr': 'Français',
'nl': 'Nederlands',
'pt_BR': 'Português (BR)',
'uk': 'українська',
'zh_CN': '简体中文',
# The version names that should be shown in the version switcher, if the config option `versions`
# is populated. If a version is passed to `versions` but is not listed here, it will not be shown.
versions_names = {
'master': "Master",
'16.0': "Odoo 16",
'saas-15.2': "Odoo Online",
'15.0': "Odoo 15",
'14.0': "Odoo 14",
'13.0': "Odoo 13",
}
# The specifications of redirect rules used by the redirects extension.
redirects_file = 'redirects.txt'
# The language names that should be shown in the language switcher, if the config option `languages`
# is populated. If a language is passed to `languages` but is not listed here, it will not be shown.
languages_names = {
'de': 'DE',
'en': 'EN',
'es': 'ES',
'fr': 'FR',
'nl': 'NL',
'pt_BR': 'PT',
'ro': 'RO',
'uk': 'UA',
'zh_CN': 'ZH',
}
# The directory in which files holding redirect rules used by the 'redirects' extension are listed.
redirects_dir = 'redirects/'
sphinx_tabs_disable_tab_closing = True
sphinx_tabs_disable_css_loading = True
#=== Options for HTML output ===#
@@ -175,8 +254,8 @@ html_favicon = os.path.join(html_theme_path[0], html_theme, 'static', 'img', 'fa
# They are copied after the builtin static files, so a file named "default.css" will overwrite the
# builtin "default.css".
html_static_path = ['static']
html_add_permalinks = '' # Sphinx < 3.5
html_permalinks = True # Sphinx >= 3.5
html_permalinks = True
# Additional JS & CSS files that can be imported with the 'custom-js' and 'custom-css' metadata.
# Lists are empty because the files are specified in extensions/themes.
html_js_files = []
@@ -198,7 +277,7 @@ latex_elements = {
'tableofcontents': '', # no TOC
# Output manually in latex docs
'releasename': '14.0',
'releasename': release,
}
latex_additional_files = ['static/latex/odoo.sty']
@@ -218,7 +297,7 @@ latex_documents = [
('legal/terms/i18n/partnership_tex_fr',
'odoo_partnership_agreement_fr.tex', 'Odoo Partnership Agreement (FR)', '', 'howto'),
('legal/terms/i18n/terms_of_sale_fr', 'terms_of_sale_fr.tex',
u'Conditions Générales de Vente Odoo', '', 'howto'),
'Conditions Générales de Vente Odoo', '', 'howto'),
('legal/terms/i18n/enterprise_tex_nl', 'odoo_enterprise_agreement_nl.tex',
'Odoo Enterprise Subscription Agreement (NL)', '', 'howto'),
@@ -238,6 +317,21 @@ latex_logo = 'static/img/odoo_logo.png'
# If true, show URL addresses after external links.
latex_show_urls = 'True'
# https://github.com/sphinx-doc/sphinx/issues/4054#issuecomment-329097229
def source_read_replace(app, docname, source):
"""Substitute parts of strings with computed values.
Since the RST substitution is not working everywhere, i.e. in directives'
options, we need to be able to input those values when reading the sources.
This is using the config `source_read_replace_vals`, mapping a name to its
replacement. This will look for the name surrounded by curly braces in the source.
Meant to be connected to the `source-read` event.
"""
result = source[0]
for key in app.config.source_read_replace_vals:
result = result.replace(f"{{{key}}}", app.config.source_read_replace_vals[key])
source[0] = result
def setup(app):
# Generate all alternate URLs for each document
@@ -246,12 +340,34 @@ def setup(app):
app.add_config_value('versions', None, 'env')
app.add_config_value('languages', None, 'env')
app.add_config_value('is_remote_build', None, 'env') # Whether the build is remotely deployed
app.add_config_value('source_read_replace_vals', {}, 'env')
app.connect('source-read', source_read_replace)
app.add_lexer('json', JsonLexer)
app.add_lexer('xml', XmlLexer)
app.connect('html-page-context', _generate_alternate_urls)
# Add a `condition` option on directives to ignore them based on config values
app.add_config_value('odoo_dir_in_path', None, 'env')
def context_eval(expr):
return eval(expr, {confval.name: confval.value for confval in app.config})
def patch(to_patch):
to_patch.option_spec['condition'] = context_eval
original_run = to_patch.run
def new_run(self):
if not self.options.get('condition', True):
return []
return original_run(self)
to_patch.run = new_run
for to_patch in (
sphinx.directives.code.LiteralInclude,
docutils.parsers.rst.directives.tables.CSVTable,
):
patch(to_patch)
def _generate_alternate_urls(app, pagename, templatename, context, doctree):
""" Add keys of required alternate URLs for the current document in the rendering context.
@@ -283,15 +399,18 @@ def _generate_alternate_urls(app, pagename, templatename, context, doctree):
The entry 'version' is added by Sphinx in the rendering context.
"""
# If the list of versions is not set, assume that the project has no alternate version
_alternate_versions = app.config.versions and app.config.versions.split(',') or []
context['alternate_versions'] = [
(_alternate_version, _build_url(_version=_alternate_version))
for _alternate_version in sorted(_alternate_versions, reverse=True)
if _alternate_version != version and (
_alternate_version != 'master' or pagename.startswith('developer')
)
]
context['version_display_name'] = versions_names[version]
# If the list of versions is not set, assume the project has no alternate version
_provided_versions = app.config.versions and app.config.versions.split(',') or []
# Map alternate versions to their display names and URLs.
context['alternate_versions'] = []
for _alternate_version, _display_name in versions_names.items():
if _alternate_version in _provided_versions and _alternate_version != version:
context['alternate_versions'].append(
(_display_name, _build_url(_alternate_version))
)
def _localize():
""" Add the pairs of (lang, code, url) for the current document in the rendering context.
@@ -301,20 +420,24 @@ def _generate_alternate_urls(app, pagename, templatename, context, doctree):
The entry 'language' is added by Sphinx in the rendering context.
"""
_current_lang = app.config.language or 'en'
# Replace the context value by its translated description ("Français" instead of "french")
context['language'] = supported_languages.get(_current_lang)
# Replace the context value by its upper-cased value ("FR" instead of "fr")
context['language'] = languages_names.get(_current_lang)
context['language_code'] = _current_lang
# If the list of languages is not set, assume that the project has no alternate language
_alternate_languages = app.config.languages and app.config.languages.split(',') or []
context['alternate_languages'] = [
(
supported_languages.get(_alternate_lang),
_alternate_lang.split('_')[0] if _alternate_lang != 'en' else 'x-default',
_build_url(_lang=_alternate_lang),
)
for _alternate_lang in _alternate_languages
if _alternate_lang in supported_languages and _alternate_lang != _current_lang
]
_provided_languages = app.config.languages and app.config.languages.split(',') or []
# Map alternate languages to their display names and URLs.
context['alternate_languages'] = []
for _alternate_lang, _display_name in languages_names.items():
if _alternate_lang in _provided_languages and _alternate_lang != _current_lang:
context['alternate_languages'].append(
(
_display_name,
_alternate_lang.split('_')[0] if _alternate_lang != 'en' else 'x-default',
_build_url(_lang=_alternate_lang),
)
)
def _build_url(_version=None, _lang=None):
if app.config.is_remote_build:
+1
View File
@@ -18,4 +18,5 @@ These guides provide instructions on how to install, maintain and upgrade Odoo d
administration/install
administration/maintain
administration/upgrade
administration/odoo_sh
+2
View File
@@ -4,6 +4,8 @@
Install
=======
.. If you add content on this page, remove the redirect rule 'install -> install/install'
.. toctree::
install/install
+3 -3
View File
@@ -7,7 +7,7 @@ internet-facing server. It follows :ref:`installation <setup/install>`, and is
not generally necessary for a development systems that is not exposed on the
internet.
.. warning:: If you are setting up a public server, be sure to check our :ref:`security` recommandations!
.. warning:: If you are setting up a public server, be sure to check our :ref:`security` recommendations!
.. _db_filter:
@@ -299,7 +299,7 @@ in ``/etc/nginx/sites-enabled/odoo.conf`` set:
}
server {
listen 443;
listen 443 ssl;
server_name odoo.mycompany.com;
proxy_read_timeout 720s;
proxy_connect_timeout 720s;
@@ -312,7 +312,6 @@ in ``/etc/nginx/sites-enabled/odoo.conf`` set:
proxy_set_header X-Real-IP $remote_addr;
# SSL parameters
ssl on;
ssl_certificate /etc/ssl/nginx/server.crt;
ssl_certificate_key /etc/ssl/nginx/server.key;
ssl_session_timeout 30m;
@@ -517,6 +516,7 @@ security-related topics:
Blocking Brute Force Attacks
----------------------------
For internet-facing deployments, brute force attacks on user passwords are very common, and this
threat should not be neglected for Odoo servers. Odoo emits a log entry whenever a login attempt
is performed, and reports the result: success or failure, along with the target login and source IP.
@@ -4,19 +4,22 @@ Email gateway
The Odoo mail gateway allows you to inject directly all the received emails in Odoo.
Its principle is straightforward: your SMTP server executes the "mailgate" script for every new incoming email.
Its principle is straightforward: your SMTP server executes the "mailgate" script for every new
incoming email.
The script takes care of connecting to your Odoo database through XML-RPC, and send the emails via
the `MailThread.message_process()` feature.
Prerequisites
-------------
- Administrator access to the Odoo database.
- Your own mail server such as Postfix or Exim.
- Technical knowledge on how to configure an email server.
For Postfix
-----------
In you alias config (:file:`/etc/aliases`):
.. code-block:: text
@@ -33,6 +36,7 @@ In you alias config (:file:`/etc/aliases`):
For Exim
--------
.. code-block:: text
*: |/odoo-directory/addons/mail/static/scripts/odoo-mailgate.py -d <database-name> -u <userid> -p <password>
@@ -44,4 +48,4 @@ For Exim
.. tip::
If you don't have access/manage your email server, use :ref:`inbound messages
<discuss/email_servers/inbound_messages>`.
<email_communication/inbound_messages>`.
+191 -103
View File
@@ -33,7 +33,7 @@ Editions
========
There are two different Editions_ of Odoo: the Community and Enterprise versions.
Using the Enterprise version is possible on our SaaS_ and accessing the code is
Using the Enterprise version is possible on `Odoo Online`_ and accessing the code is
restricted to Enterprise customers and partners. The Community version is freely
available to anyone.
@@ -55,17 +55,17 @@ around and try things out with no commitment.
Demo_ instances require no local installation, just a web browser.
SaaS
----
Odoo Online
-----------
Trivial to start with, fully managed and migrated by Odoo S.A., Odoo's SaaS_
Trivial to start with, fully managed and migrated by Odoo S.A., `Odoo Online`_
provides private instances and starts out free. It can be used to discover and
test Odoo and do non-code customizations (i.e. incompatible with custom modules
or the Odoo Apps Store) without having to install it locally.
Can be used for both testing Odoo and long-term production use.
Like demo_ instances, SaaS_ instances require no local installation, a web
Like demo_ instances, `Odoo Online`_ instances require no local installation, a web
browser is sufficient.
@@ -105,12 +105,13 @@ Linux
-----
Debian/Ubuntu
'''''''''''''
~~~~~~~~~~~~~
Odoo 13.0 'deb' package currently supports `Debian Buster`_, `Ubuntu 18.04`_ or above.
Odoo {CURRENT_MAJOR_VERSION} 'deb' package currently supports `Debian 11 (Bullseye)`_,
`Ubuntu 20.04 (Focal)`_ or above.
Prepare
^^^^^^^
*******
Odoo needs a `PostgreSQL`_ server to run properly. The default configuration for
the Odoo 'deb' package is to use the PostgreSQL server on the same host as your
@@ -126,7 +127,7 @@ Odoo instance. Execute the following command in order to install the PostgreSQL
details on the various versions.
Repository
^^^^^^^^^^
**********
Odoo S.A. provides a repository that can be used with Debian and Ubuntu distributions. It can be
used to install *Odoo Community Edition* by executing the following commands **as root**:
@@ -134,7 +135,7 @@ used to install *Odoo Community Edition* by executing the following commands **a
.. code-block:: console
# wget -O - https://nightly.odoo.com/odoo.key | apt-key add -
# echo "deb http://nightly.odoo.com/13.0/nightly/deb/ ./" >> /etc/apt/sources.list.d/odoo.list
# echo "deb http://nightly.odoo.com/{CURRENT_MAJOR_BRANCH}/nightly/deb/ ./" >> /etc/apt/sources.list.d/odoo.list
# apt-get update && apt-get install odoo
You can then use the usual `apt-get upgrade` command to keep your installation up-to-date.
@@ -142,7 +143,7 @@ You can then use the usual `apt-get upgrade` command to keep your installation u
At this moment, there is no nightly repository for the Enterprise Edition.
Deb Package
^^^^^^^^^^^
***********
Instead of using the repository as described above, the 'deb' packages for both the *Community* and
*Enterprise* editions can be downloaded from the `official download page <download_>`_.
@@ -178,12 +179,13 @@ and automatically start the server.
$ sudo pip3 install num2words
Fedora
''''''
~~~~~~
Odoo 13.0 'rpm' package supports Fedora 30.
Odoo {CURRENT_MAJOR_VERSION} 'rpm' package supports Fedora 34.
Prepare
^^^^^^^
*******
Odoo needs a `PostgreSQL`_ server to run properly. Make sure that the `sudo` command is available
and well configured and, only then, execute the following command in order to install the PostgreSQL
server:
@@ -201,7 +203,7 @@ server:
details on the various versions.
Repository
^^^^^^^^^^
**********
Odoo S.A. provides a repository that can be used with the Fedora distributions.
It can be used to install *Odoo Community Edition* by executing the following
@@ -209,13 +211,13 @@ commands:
.. code-block:: console
$ sudo dnf config-manager --add-repo=https://nightly.odoo.com/13.0/nightly/rpm/odoo.repo
$ sudo dnf config-manager --add-repo=https://nightly.odoo.com/{CURRENT_MAJOR_BRANCH}/nightly/rpm/odoo.repo
$ sudo dnf install -y odoo
$ sudo systemctl enable odoo
$ sudo systemctl start odoo
RPM package
^^^^^^^^^^^
***********
Instead of using the repository as described above, the 'rpm' packages for both the *Community* and
*Enterprise* editions can be downloaded from the `official download page <download_>`_.
@@ -224,7 +226,7 @@ Once downloaded, the package can be installed using the 'dnf' package manager:
.. code-block:: console
$ sudo dnf localinstall odoo_13.0.latest.noarch.rpm
$ sudo dnf localinstall odoo_{CURRENT_MAJOR_BRANCH}.latest.noarch.rpm
$ sudo systemctl enable odoo
$ sudo systemctl start odoo
@@ -237,9 +239,8 @@ Source Install
The source "installation" is really about not installing Odoo, and running it directly from source
instead.
This can be more convenient for module developers as the Odoo source is more easily accessible
than using packaged installation (for information or to build this documentation and have it
available offline).
It can be more convenient for module developers as the Odoo source is more easily accessible than
using packaged installation.
It also makes starting and stopping Odoo more flexible and explicit than the services set up by the
packaged installations, and allows overriding settings using
@@ -248,16 +249,18 @@ packaged installations, and allows overriding settings using
Finally it provides greater control over the system's set up, and allows to more easily keep
(and run) multiple versions of Odoo side-by-side.
.. _setup/install/source/windows:
Windows
-------
Fetch the sources
'''''''''''''''''
~~~~~~~~~~~~~~~~~
There are two ways to obtain the source code of Odoo: as a zip **archive** or through **git**.
Archive
^^^^^^^
*******
Community Edition:
@@ -270,45 +273,56 @@ Enterprise Edition:
* `Official download page <download_>`_
* `GitHub repository <enterprise-repository_>`_
.. _setup/install/source/windows/git:
Git
^^^
***
The following requires git_ to be installed on your machine and that you have basic knowledge of
git commands.
The following requires `Git <git_>`_ to be installed on your machine and that you have basic
knowledge of Git commands. To clone a Git repository, you must choose between cloning with HTTPS or
SSH. If you do not know the difference between the two, the best option is most likely HTTPS. If you
are following the :doc:`Getting started </developer/howtos/rdtraining>` developer tutorial, or plan
on contributing to Odoo source code, choose SSH.
Community Edition:
.. note::
**The Enterprise Git repository does not contain the full Odoo source code**. It is only a
collection of extra add-ons. The main server code is in the Community version. Running the
Enterprise version actually means running the server from the Community version with the
addons-path option set to the folder with the Enterprise version. You need to clone both the
Community and Enterprise repository to have a working Odoo Enterprise installation. See
:ref:`setup/install/editions` to get access to the Enterprise repository.
.. code-block:: doscon
.. tabs::
C:\> git clone https://github.com/odoo/odoo.git
.. tab:: Clone with HTTPS
.. code-block:: doscon
Enterprise Edition: (see :ref:`setup/install/editions` to get access)
C:\> git clone https://github.com/odoo/odoo.git
C:\> git clone https://github.com/odoo/enterprise.git
.. code-block:: doscon
.. tab:: Clone with SSH
C:\> git clone https://github.com/odoo/enterprise.git
.. code-block:: doscon
.. note:: **The Enterprise git repository does not contain the full Odoo source code**. It is only
a collection of extra add-ons. The main server code is in the Community version. Running
the Enterprise version actually means running the server from the Community version with
the addons-path option set to the folder with the Enterprise version. You need to clone
both the Community and Enterprise repository to have a working Odoo Enterprise
installation.
C:\> git clone git@github.com:odoo/odoo.git
C:\> git clone git@github.com:odoo/enterprise.git
.. _setup/install/source/windows/prepare:
Prepare
'''''''
~~~~~~~
Python
^^^^^^
******
Odoo requires Python 3.6 or later to run. Visit `Python's download page <https://www.python.org/downloads/windows/>`_
Odoo requires Python 3.7 or later to run. Visit `Python's download page <https://www.python.org/downloads/windows/>`_
to download and install the latest version of Python 3 on your machine.
During installation, check **Add Python 3 to PATH**, then click **Customize Installation** and make
sure that **pip** is checked.
.. note:: If Python 3 is already installed, make sure that the version is 3.6 or above, as previous
.. note:: If Python 3 is already installed, make sure that the version is 3.7 or above, as previous
versions are not compatible with Odoo.
.. code-block:: doscon
@@ -322,7 +336,7 @@ sure that **pip** is checked.
C:\> pip --version
PostgreSQL
^^^^^^^^^^
**********
Odoo uses PostgreSQL as database management system. `Download and install PostgreSQL <https://www.postgresql.org/download/windows/>`_
(supported version: 10.0 and later).
@@ -343,7 +357,7 @@ create a new PostgreSQL user:
`Yes`.
Dependencies
^^^^^^^^^^^^
************
Before installing the dependencies, you must download and install the
`Build Tools for Visual Studio <https://visualstudio.microsoft.com/downloads/#build-tools-for-visual-studio-2019>`_.
@@ -383,7 +397,7 @@ needed:
(typically: `C:\\Users\\<user>\\AppData\\Roaming\\npm\\`).
Running Odoo
''''''''''''
~~~~~~~~~~~~
Once all dependencies are set up, Odoo can be launched by running `odoo-bin`, the
command-line interface of the server. It is located at the root of the Odoo Community directory.
@@ -409,19 +423,34 @@ A typical way to run the server would be:
Where `CommunityPath` is the path of the Odoo Community installation, `dbuser` is the
PostgreSQL login, `dbpassword` is the PostgreSQL password
and `mydb` is the default database to serve on `localhost:8069`. You can add other
directory paths separated by a comma to ``addons`` at the end of the addons-path option.
and `mydb` is the name of the PostgreSQL database.
After the server has started (the INFO log `odoo.modules.loading: Modules loaded.` is printed), open
http://localhost:8069 in your web browser and log in with the base administrator account: Use
`admin` for the :guilabel:`Email` and, again, `admin` for the :guilabel:`Password`. That's it, you
just logged into your own Odoo database!
.. tip::
- From there, you can create and manage new :doc:`users
</applications/general/users/manage_users>`.
- The user account you use to log into Odoo's web interface differs from the :option:`--db_user
<odoo-bin -r>` CLI argument.
.. seealso::
:doc:`The exhaustive list of CLI arguments for odoo-bin </developer/cli>`.
.. _setup/install/source/linux:
Linux
-----
Fetch the sources
'''''''''''''''''
~~~~~~~~~~~~~~~~~
There are two ways to obtain the source code of Odoo: as a zip **archive** or through **git**.
Archive
^^^^^^^
*******
Community Edition:
@@ -434,42 +463,53 @@ Enterprise Edition:
* `Official download page <download_>`_
* `GitHub repository <enterprise-repository_>`_
.. _setup/install/source/linux/git:
Git
^^^
***
The following requires git_ to be installed on your machine and that you have basic knowledge of
git commands.
The following requires `Git <git_>`_ to be installed on your machine and that you have basic
knowledge of Git commands. To clone a Git repository, you must choose between cloning with HTTPS or
SSH. If you do not know the difference between the two, the best option is most likely HTTPS. If you
are following the :doc:`Getting started </developer/howtos/rdtraining>` developer tutorial, or plan
on contributing to Odoo source code, choose SSH.
Community Edition:
.. note::
**The Enterprise Git repository does not contain the full Odoo source code**. It is only a
collection of extra add-ons. The main server code is in the Community version. Running the
Enterprise version actually means running the server from the Community version with the
addons-path option set to the folder with the Enterprise version. You need to clone both the
Community and Enterprise repository to have a working Odoo Enterprise installation. See
:ref:`setup/install/editions` to get access to the Enterprise repository.
.. code-block:: console
.. tabs::
$ git clone https://github.com/odoo/odoo.git
.. tab:: Clone with HTTPS
.. code-block:: console
Enterprise Edition: (see :ref:`setup/install/editions` to get access)
$ git clone https://github.com/odoo/odoo.git
$ git clone https://github.com/odoo/enterprise.git
.. code-block:: console
.. tab:: Clone with SSH
$ git clone https://github.com/odoo/enterprise.git
.. code-block:: console
.. note:: **The Enterprise git repository does not contain the full Odoo source code**. It is only
a collection of extra add-ons. The main server code is in the Community version. Running
the Enterprise version actually means running the server from the Community version with
the addons-path option set to the folder with the Enterprise version. You need to clone
both the Community and Enterprise repository to have a working Odoo Enterprise
installation.
$ git clone git@github.com:odoo/odoo.git
$ git clone git@github.com:odoo/enterprise.git
.. _setup/install/source/linux/prepare:
Prepare
'''''''
~~~~~~~
Python
^^^^^^
******
Odoo requires Python 3.6 or later to run. Use your package manager to download and install Python 3
Odoo requires Python 3.7 or later to run. Use your package manager to download and install Python 3
on your machine if it is not already done.
.. note:: If Python 3 is already installed, make sure that the version is 3.6 or above, as previous
.. note:: If Python 3 is already installed, make sure that the version is 3.7 or above, as previous
versions are not compatible with Odoo.
.. code-block:: console
@@ -483,7 +523,7 @@ on your machine if it is not already done.
$ pip3 --version
PostgreSQL
^^^^^^^^^^
**********
Odoo uses PostgreSQL as database management system. Use your package manager to download and install
PostgreSQL (supported version: 10.0 and later).
@@ -506,7 +546,7 @@ create a new PostgreSQL user:
connect to the database without password.
Dependencies
^^^^^^^^^^^^
************
For libraries using native code, it is necessary to install development tools and native
dependencies before the Python dependencies of Odoo. They are available in `-dev` or `-devel`
@@ -551,7 +591,7 @@ needed:
$ sudo npm install -g rtlcss
Running Odoo
''''''''''''
~~~~~~~~~~~~
Once all dependencies are set up, Odoo can be launched by running `odoo-bin`, the
command-line interface of the server. It is located at the root of the Odoo Community directory.
@@ -578,19 +618,34 @@ A typical way to run the server would be:
$ python3 odoo-bin --addons-path=addons -d mydb
Where `CommunityPath` is the path of the Odoo Community installation
and `mydb` is the default database to serve on `localhost:8069`. You can add other
directory paths separated by a comma to ``addons`` at the end of the addons-path option.
and `mydb` is the name of the PostgreSQL database.
After the server has started (the INFO log `odoo.modules.loading: Modules loaded.` is printed), open
http://localhost:8069 in your web browser and log in with the base administrator account: Use
`admin` for the :guilabel:`Email` and, again, `admin` for the :guilabel:`Password`. That's it, you
just logged into your own Odoo database!
.. tip::
- From there, you can create and manage new :doc:`users
</applications/general/users/manage_users>`.
- The user account you use to log into Odoo's web interface differs from the :option:`--db_user
<odoo-bin -r>` CLI argument.
.. seealso::
:doc:`The exhaustive list of CLI arguments for odoo-bin </developer/cli>`.
.. _setup/install/source/mac_os:
Mac OS
------
Fetch the sources
'''''''''''''''''
~~~~~~~~~~~~~~~~~
There are two ways to obtain the source code of Odoo: as a zip **archive** or through **git**.
Archive
^^^^^^^
*******
Community Edition:
@@ -603,42 +658,53 @@ Enterprise Edition:
* `Official download page <download_>`_
* `GitHub repository <enterprise-repository_>`_
.. _setup/install/source/mac_os/git:
Git
^^^
***
The following requires git_ to be installed on your machine and that you have basic knowledge of
git commands.
The following requires `Git <git_>`_ to be installed on your machine and that you have basic
knowledge of Git commands. To clone a Git repository, you must choose between cloning with HTTPS or
SSH. If you do not know the difference between the two, the best option is most likely HTTPS. If you
are following the :doc:`Getting started </developer/howtos/rdtraining>` developer tutorial, or plan
on contributing to Odoo source code, choose SSH.
Community Edition:
.. note::
**The Enterprise Git repository does not contain the full Odoo source code**. It is only a
collection of extra add-ons. The main server code is in the Community version. Running the
Enterprise version actually means running the server from the Community version with the
addons-path option set to the folder with the Enterprise version. You need to clone both the
Community and Enterprise repository to have a working Odoo Enterprise installation. See
:ref:`setup/install/editions` to get access to the Enterprise repository.
.. code-block:: console
.. tabs::
$ git clone https://github.com/odoo/odoo.git
.. tab:: Clone with HTTPS
.. code-block:: console
Enterprise Edition: (see :ref:`setup/install/editions` to get access)
$ git clone https://github.com/odoo/odoo.git
$ git clone https://github.com/odoo/enterprise.git
.. code-block:: console
.. tab:: Clone with SSH
$ git clone https://github.com/odoo/enterprise.git
.. code-block:: console
.. note:: **The Enterprise git repository does not contain the full Odoo source code**. It is only
a collection of extra add-ons. The main server code is in the Community version. Running
the Enterprise version actually means running the server from the Community version with
the addons-path option set to the folder with the Enterprise version. You need to clone
both the Community and Enterprise repository to have a working Odoo Enterprise
installation.
$ git clone git@github.com:odoo/odoo.git
$ git clone git@github.com:odoo/enterprise.git
.. _setup/install/source/mac_os/prepare:
Prepare
'''''''
~~~~~~~
Python
^^^^^^
******
Odoo requires Python 3.6 or later to run. Use your preferred package manager (homebrew_, macports_)
Odoo requires Python 3.7 or later to run. Use your preferred package manager (homebrew_, macports_)
to download and install Python 3 on your machine if it is not already done.
.. note:: If Python 3 is already installed, make sure that the version is 3.6 or above, as previous
.. note:: If Python 3 is already installed, make sure that the version is 3.7 or above, as previous
versions are not compatible with Odoo.
.. code-block:: console
@@ -652,11 +718,16 @@ to download and install Python 3 on your machine if it is not already done.
$ pip3 --version
PostgreSQL
^^^^^^^^^^
**********
Odoo uses PostgreSQL as database management system. Use `postgres.app <https://postgresapp.com>`_
to download and install PostgreSQL (supported version: 10.0 and later).
.. tip::
To make the command line tools bundled with `postgres.app` available, make sure to setup your
`$PATH` variable by following the `Postgres.app CLI Tools Instructions
<https://postgresapp.com/documentation/cli-tools.html>`_.
By default, the only user is `postgres` but Odoo forbids connecting as `postgres`, so you need to
create a new PostgreSQL user:
@@ -669,7 +740,7 @@ create a new PostgreSQL user:
connect to the database without password.
Dependencies
^^^^^^^^^^^^
************
Odoo dependencies are listed in the `requirements.txt` file located at the root of the Odoo
community directory.
@@ -713,7 +784,7 @@ needed:
$ sudo npm install -g rtlcss
Running Odoo
''''''''''''
~~~~~~~~~~~~
Once all dependencies are set up, Odoo can be launched by running `odoo-bin`, the
command-line interface of the server. It is located at the root of the Odoo Community directory.
@@ -740,9 +811,26 @@ A typical way to run the server would be:
$ python3 odoo-bin --addons-path=addons -d mydb
Where `CommunityPath` is the path of the Odoo Community installation
and `mydb` is the default database to serve on `localhost:8069`. You can add other
directory paths separated by a comma to ``addons`` at the end of the addons-path option.
and `mydb` is the name of the PostgreSQL database.
.. warning::
Some versions of python on Mac might lead to the following error message: `current limit exceeds
maximum limit`. In that case, add the following parameter `--limit-memory-hard 0` to avoid the
problem.
After the server has started (the INFO log `odoo.modules.loading: Modules loaded.` is printed), open
http://localhost:8069 in your web browser and log in with the base administrator account: Use
`admin` for the :guilabel:`Email` and, again, `admin` for the :guilabel:`Password`. That's it, you
just logged into your own Odoo database!
.. tip::
- From there, you can create and manage new :doc:`users
</applications/general/users/manage_users>`.
- The user account you use to log into Odoo's web interface differs from the :option:`--db_user
<odoo-bin -r>` CLI argument.
.. seealso::
:doc:`The exhaustive list of CLI arguments for odoo-bin </developer/cli>`.
.. _setup/install/docker:
@@ -750,20 +838,20 @@ Docker
======
The full documentation on how to use Odoo with Docker can be found on the
official Odoo `docker image <https://registry.hub.docker.com/_/odoo/>`_ page.
official Odoo `docker image <https://hub.docker.com/_/odoo/>`_ page.
.. _Debian Buster: https://www.debian.org/releases/buster/
.. _Debian 11 (Bullseye): https://www.debian.org/releases/bullseye/
.. _demo: https://demo.odoo.com
.. _docker: https://www.docker.com
.. _download: https://www.odoo.com/page/download
.. _Ubuntu 18.04: http://releases.ubuntu.com/18.04/
.. _Ubuntu 20.04 (Focal): http://releases.ubuntu.com/20.04/
.. _EPEL: https://fedoraproject.org/wiki/EPEL
.. _PostgreSQL: http://www.postgresql.org
.. _the official installer:
.. _install pip:
https://pip.pypa.io/en/latest/installing.html#install-pip
.. _Quilt: http://en.wikipedia.org/wiki/Quilt_(software)
.. _saas: https://www.odoo.com/page/start
.. _Odoo Online: https://www.odoo.com/page/start
.. _the wkhtmltopdf download page: https://github.com/wkhtmltopdf/wkhtmltopdf/releases/tag/0.12.5
.. _UAC: http://en.wikipedia.org/wiki/User_Account_Control
.. _wkhtmltopdf: http://wkhtmltopdf.org
+6 -2
View File
@@ -6,9 +6,13 @@ Maintain
.. toctree::
maintain/domain_names
maintain/azure_oauth
maintain/google_oauth
maintain/mailjet_api
maintain/update
maintain/db_upgrade
maintain/enterprise
maintain/hosting_changes
maintain/db_premise
maintain/odoo_online
maintain/on_premise
maintain/supported_versions
@@ -0,0 +1,216 @@
=======================================================
Connect Microsoft Outlook 365 to Odoo using Azure OAuth
=======================================================
Odoo is compatible with Microsoft's Azure OAuth for Microsoft 365. In order to send and receive
secure emails from a custom domain, all that is required is to configure a few settings on the
Azure platform and on the back end of the Odoo database. This configuration works with either a
personal email address or an address created by a custom domain.
.. seealso::
`Microsoft Learn: Register an application with the Microsoft identity platform
<https://learn.microsoft.com/azure/active-directory/develop/quickstart-register-app>`_
Setup in Microsoft Azure Portal
===============================
Create a new application
------------------------
To get started, go to `Microsoft's Azure Portal <https://portal.azure.com/>`_. Log in with the
:guilabel:`Microsoft Outlook Office 365` account if there is one, otherwise log in with the
personal :guilabel:`Microsoft account`. A user with administrative access to the Azure Settings
will need to connect and perform the following configuration. Next, navigate to the section
labeled :guilabel:`Manage Azure Active Directory`.
Now, click on :guilabel:`Add (+)`, located in the top menu, and then select :guilabel:`App
registration`. On the :guilabel:`Register an application` screen, rename the :guilabel:`Name` to
`Odoo` or something recognizable. Under the :guilabel:`Supported account types` section select
:guilabel:`Accounts in any organizational directory (Any Azure AD directory - Multitenant) and
personal Microsoft accounts (e.g. Skype, Xbox)`.
Under the :guilabel:`Redirect URL` section, select :guilabel:`Web` as the platform, and then input
`https://<odoo base url>/microsoft_outlook/confirm` in the :guilabel:`URL` field. The Odoo base URL
is the canonical domain at which your Odoo instance can be reached in the URL field.
.. example::
*mydatabase.odoo.com*, where *mydatabase* is the actual prefix of the database's subdomain,
assuming it's hosted on Odoo.com
After the URL has been added to the field, :guilabel:`Register` the application so it is created.
API permissions
---------------
The :guilabel:`API permissions` should be set next. Odoo will need specific API permissions to be
able to read (IMAP) and send (IMAP) emails in the Microsoft 365 setup. First, click the
:guilabel:`API permissions` link, located in the left menu bar. Next, click on the :guilabel:`(+)
Add a Permission` button and select :guilabel:`Microsoft Graph` under :guilabel:`Commonly Used
Microsoft APIs`. After, select the :guilabel:`Delegated Permissions` option.
In the search bar, search for the following :guilabel:`Deregulated permissions` and click
:guilabel:`Add permissions` for each one:
- :guilabel:`SMTP.Send`
- :guilabel:`IMAP.AccessAsUser.All`
.. note::
The :guilabel:`User.Read` permission will be added by default.
.. image:: azure_oauth/permissions.png
:align: center
:alt: API permissions needed for Odoo integration are listed under the Microsoft Graph.
Assign users and groups
=======================
After adding the API permissions, navigate back to the :guilabel:`Overview` of the
:guilabel:`Application` in the top of the left sidebar menu.
Now, add users to this application. Under the :guilabel:`Essentials` overview table, click on the
link labeled :guilabel:`Managed Application in Local Directory`, or the last option on the bottom
right-hand side of the table.
.. image:: azure_oauth/managed-application.png
:align: center
:alt: Add users/groups by clicking the Managed application in local directory link for the
created application.
In the left sidebar menu, select :guilabel:`Users and Groups`. Next, click on :guilabel:`(+) Add
User/Group`. Depending on the account, either a :guilabel:`Group` and a :guilabel:`User` can be
added, or only :guilabel:`Users`. Personal accounts will only allow for :guilabel:`Users` to be
added.
Under :guilabel:`Users` or :guilabel:`Groups`, click on :guilabel:`None Selected` and add the users
or group of users that will be sending emails from the :guilabel:`Microsoft account` in Odoo.
:guilabel:`Add` the users/groups, click :guilabel:`Select`, and then :guilabel:`Assign` them to the
application.
Create credentials
------------------
Now that the Microsoft Azure app is set up, credentials need to be created for the Odoo setup.
These include the :guilabel:`Client ID` and :guilabel:`Client Secret`. To start, the
:guilabel:`Client ID` can be copied from the :guilabel:`Overview` page of the app. The
:guilabel:`Client ID` or :guilabel:`Application ID` is located under the :guilabel:`Display Name`
in the :guilabel:`Essentials` overview of the app.
.. image:: azure_oauth/application-id.png
:align: center
:alt: Application/Client ID located in the Overview of the app.
Next, the :guilabel:`Client Secret Value` needs to be retrieved. To get this value, click on
:guilabel:`Certificates & Secrets` in the left sidebar menu. Then, a :guilabel:`Client Secret`
needs to be produced. In order to do this, click on the :guilabel:`(+) New Client Secret` button.
A window on the right will populate with a button labeled :guilabel:`Add a client secret`. Under
:guilabel:`Description`, type in `Odoo Fetchmail` or something recognizable, and then set the
:guilabel:`expiration date`.
.. important::
A new :guilabel:`Client Secret` will need to be produced and configured if the first one
expires. In this event, there could be an interruption of service, so the expiration date should
be noted and set to the furthest possible date.
Next, click on :guilabel:`Add` when these two values are entered. A :guilabel:`Client Secret Value`
and :guilabel:`Secret ID` will be created. It is important to copy the :guilabel:`Value` or
:guilabel:`Client Secret Value` into a notepad as it will become encrypted after leaving this page.
The :guilabel:`Secret ID` is not needed.
.. image:: azure_oauth/secretvalue.png
:align: center
:alt: Client Secret Value or Value in the app's credentials.
After these steps, the following items should be ready to be set up in Odoo:
- A client ID (:guilabel:`Client ID` or :guilabel:`Application ID`)
- A client secret (:guilabel:`Value` or :guilabel:`Client Secret Value`)
This completes the setup on the :guilabel:`Microsoft Azure Portal` side.
Setup in Odoo
=============
Enter Microsoft Outlook credentials
-----------------------------------
First, open the Odoo database and navigate to the :guilabel:`Apps` module. Then, remove the
:guilabel:`Apps` filter from the search bar and type in `Outlook`. After that, install the module
called :guilabel:`Microsoft Outlook`.
Next, navigate to :menuselection:`Settings --> General Settings`, and under the :guilabel:`Discuss`
section, ensure that the checkbox for :guilabel:`Custom Email Servers` is checked. This populates
a new option for :guilabel:`Outlook Credentials`.
:guilabel:`Save` the progress.
Then, copy and paste the :guilabel:`Client ID` (Application ID) and :guilabel:`Client Secret
(Client Secret Value)` into the respective fields and :guilabel:`Save` the settings.
.. image:: azure_oauth/outlookcreds.png
:align: center
:alt: Outlook Credentials in Odoo General Settings.
Configure outgoing email server
-------------------------------
On the :guilabel:`General Settings` page, under the :guilabel:`Custom Email Servers` setting,
click the :guilabel:`Outgoing Email Servers` link to configure the Microsoft account.
Then, create a new email server and check the box for :guilabel:`Outlook`. Next, fill in the
:guilabel:`Name` (it can be anything) and the Microsoft Outlook email :guilabel:`Username`.
If the :guilabel:`From Filter` field is empty, enter either a :ref:`domain or email address
<email_communication/default_from>`.
Then, cick on :guilabel:`Connect your Outlook account`.
A new window from Microsoft opens to complete the :guilabel:`authorization process`. Select the
appropriate email address that is being configured in Odoo.
.. image:: azure_oauth/verify-outlook.png
:align: center
:alt: Permission page to grant access between newly created app and Odoo.
Then, allow Odoo to access the Microsoft account by clicking on :guilabel:`Yes`. After this, the
page will navigate back to the newly configured :guilabel:`Outgoing Mail Server` in Odoo. The
configuration automatically loads the :guilabel:`token` in Odoo, and a tag stating
:guilabel:`Outlook Token Valid` appears in green.
.. image:: azure_oauth/outlook-token.png
:align: center
:alt: Valid Outlook Token indicator.
Finally, click :guilabel:`Test Connection`. A confirmation message should appear. The Odoo database
can now send safe, secure emails through Microsoft Outlook using OAuth authentication.
Multiple user configuration
~~~~~~~~~~~~~~~~~~~~~~~~~~~
Each user should have a separate server set up. The :guilabel:`from-filter` should be set so that
only the user's email is sent from that server. In other words, only a user with an email address
that matches the set :guilabel:`from-filter` is able to use this server.
After setting the :guilabel:`from-filter`, set up a fallback email account to allow for the sending
of :guilabel:`notifications`. The fallback email must be configured as a :guilabel:`general
transactional server`. The :guilabel:`mail.default.from` system parameter must be set to the
:guilabel:`username` of the general transactional server account. For more information see
:ref:`Use a default email address <email_communication/default>`.
.. note::
The :guilabel:`System Parameters` can be accessed by activating
:doc:`../../applications/general/developer_mode` in the :menuselection:`Settings --> Technical
--> Parameters --> System Parameters` menu.
Configure incoming email server
-------------------------------
The incoming account should be configured in a similar way to the outgoing email account. Navigate
to the :guilabel:`Incoming Mail Servers` in the :guilabel:`Technical Menu` and :guilabel:`Create` a
new configuration. Check or Select the button next to :guilabel:`Outlook Oauth Authentication` and
enter the :guilabel:`Microsoft Outlook username`. Click on :guilabel:`Connect your Outlook
account`. Odoo will state: :guilabel:`Outlook Token Valid` Now :guilabel:`Test and Confirm` the
account. The account should be ready to receive email to the Odoo database.
.. seealso::
:doc:`../../applications/general/email_communication/email_servers`
Binary file not shown.

After

Width:  |  Height:  |  Size: 54 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 38 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 47 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 23 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 18 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 26 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 64 KiB

@@ -1,413 +0,0 @@
.. |assistance-contact| replace::
If you need Odoo assistance on this matter, please contact your Odoo Account Manager or contact
our `Sales department`_.
.. _Sales department: mailto:sales@odoo.com
.. _db-upgrade:
================
Versions upgrade
================
.. _db-upgrade/overview:
Overview
========
.. _db-upgrade/process:
The upgrade process
-------------------
This documentation is for our *On-Premise* (self-hosted) and *Odoo.sh* customers.
.. _db-upgrade/definition:
Definition
~~~~~~~~~~
An upgrade is switching to a newer version of Odoo (e.g., Odoo 13.0 to Odoo 14.0)
An upgrade does not cover:
* changing :ref:`Editions <db-upgrade/faq/editions-change>` (i.e., Community to Enterprise edition)
* switching :ref:`hosting type <db-upgrade/faq/hosting-types-switch>` (i.e., On-Premise to Online or
Odoo.sh)
* migration from another ERP to Odoo
.. note:: |assistance-contact|
.. _db-upgrade/process-workflow:
Process workflow
~~~~~~~~~~~~~~~~
The upgrade process in a nutshell:
#. You create a test upgrade request.
#. | The request is processed by Odoo:
| This happens via an automated process that runs the database through an upgrade script and
takes between 20 and 120 minutes. Only if an issue(s) arises will we have to intervene
manually and adjust the script specifically to your database until the upgrade succeeds.
#. Odoo delivers a test database.
#. You test your database for possible discrepancies (see :ref:`db-upgrade/test-guidance`)
#. If there are any discrepancies, you report them to the Upgrade support team via the
:ref:`Help portal <db-upgrade/test-assistance>`.
#. We will fix the issues and send you a new test database.
#. Once you completed the testing and are happy with the result, you decide on a date and time when
you stop users from accessing Odoo, freeze all data entries and create an upgrade request for the
production upgrade.
#. Odoo delivers the production database through the automated process.
#. You restore it in your Production environment a few short hours later and continue working on the
newly upgraded database.
.. _db-upgrade/service-level:
Service Level Agreement
-----------------------
What is covered by the Enterprise Licence?
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Databases hosted on Odoos Cloud platforms (Saas and Odoo.sh) or On-Premise (Self-Hosting) enjoy the
following service at all times.
The upgrade of:
* standard applications
* Studio customization (as long as the Studio app is still active)
* customizations done by our consulting and developer services *if* they are covered by a
Maintenance of Customisations subscription
The Upgrade Service is limited to the technical conversion and adaptation of your database (standard
modules and data) to make it compatible with the targeted version.
What upgrading does NOT cover
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
* The cleaning of pre-existing data & configuration while upgrading
* Any new developments and/or upgrade of your own :ref:`custom modules
<db-upgrade/faq/custom-modules>`
* `Training <https://www.odoo.com/learn>`_ on the new version
You can get more information about your Enterprise Licence on our :ref:`Odoo Enterprise Subscription
Agreement <upgrade>` page.
.. note:: |assistance-contact|
.. _db-upgrade/get-started:
Get started
===========
The upgrade process varies depending on where your database is hosted.
.. _db-upgrade/online:
Online (SaaS)
-------------
If you are hosted Online, please check your `database manager <https://www.odoo.com/my/databases>`_.
.. _db-upgrade/odoo-sh:
Odoo.sh
-------
If you are Odoo.sh hosted, check our :doc:`specific instructions to be able to upgrade
<../odoo_sh/advanced/upgrade_your_database>`.
.. _db-upgrade/on-premise:
On-Premise
----------
There are two possibilities:
#. Via the interface of our `website form <https://upgrade.odoo.com>`_
#. | For technically-advanced users and partners, via the following command line (to be used on the
machine where your database is hosted):
| ``python <(curl -s beta.upgrade.odoo.com/upgrade) test -d <your db name> -t 14.0``
What does it do?
~~~~~~~~~~~~~~~~
The above command will dump your database to a file, then send it to the upgrade platform for
upgrade, displaying you the live logs, then restore the upgraded database back on your server as a
duplicate test database.
.. _db-upgrade/steps:
Steps
=====
.. _db-upgrade/steps-test:
The testing phase
-----------------
.. _db-upgrade/test-process:
Test process
~~~~~~~~~~~~
Also referred to as the pre-production phase, the test phase allows you to review an upgraded
version of your database without affecting your production database in any way.
We suggest that you run the test upgrade process at least once, but you can do it as often as you
want (one at a time).
Once you receive your upgraded test database, you should check that all data, processes and
functionality are still correct and working as expected.
If you do find discrepancies, you'll be able to:
* | :ref:`Report your issues <db-upgrade/test-assistance>`
| and/or
* Ask for a new :ref:`test request <db-upgrade/test-db-request>` after the reported issues have
been fixed in the upgrade script.
When you do not find any discrepancies, you'll be able to:
* Move on to the upgrade of your :ref:`production database <db-upgrade/production-live>`.
.. _db-upgrade/test-db-request:
Request a test database
~~~~~~~~~~~~~~~~~~~~~~~
When filling the `website form <https://upgrade.odoo.com>`_, select *Testing* purpose.
.. image:: media/db-upgrade-test-purpose.png
:align: center
:alt: Selection of the "Testing" purpose in the upgrade form on Odoo
.. _db-upgrade/test-guidance:
Test guidance
~~~~~~~~~~~~~
Every business and organization has its own operational needs and will have to test its specific
Odoo instance respectively. However, we recommend you look at `the test scenario
<https://drive.google.com/open?id=1Lm4JqbsHBirB1wMi14UChoz_YHLjx5ec>`_ we created, a high-level idea
of what you should test and look out for.
.. todo:: change link "test scenario" once the related doc is published
.. _db-upgrade/test-assistance:
Assistance
~~~~~~~~~~
If you encounter issues or problems in the **test database**, please contact the Odoo Upgrade
Support:
#. Connect to our `Odoo Support page <https://www.odoo.com/help>`_.
#. Under the *Ticket Description* section, select *An issue related to my upgrade* ticket type.
.. image:: media/db-upgrade-test-assistance.png
:align: center
:alt: Selection of "An issue related to my upgrade" as Ticket Type in the support form on Odoo
.. warning::
If you choose another *Ticket Description* type, the request will be redirected to another
team than the upgrade one and will slow down the processing and response time.
#. Please provide as much detail as you can. Where applicable, illustrate the current and previous
flows with videos and/or screenshots. This will avoid clarifying questions and speed up the
resolution process significantly.
.. image:: media/db-upgrade-test-assistance-details.png
:align: center
:alt: "Detailed Description" field in the support form on Odoo
.. note::
* The purpose of the test phase is not to correct existing data or configurations in your
database.
* |assistance-contact|
.. _db-upgrade/steps-production:
The production launch
---------------------
.. _db-upgrade/production-live:
Production goes live
~~~~~~~~~~~~~~~~~~~~
The production upgrade request is when you decide to upgrade your current database with all your
production data (invoices, VAT returns, inventories, current orders) to a new version of your choice.
After your :ref:`tests <db-upgrade/steps-test>` are completed to your satisfaction, submit the
request to upgrade your production database via our `website form <https://upgrade.odoo.com>`_.
Select *Production* purpose.
.. image:: media/db-upgrade-production-purpose.png
:align: center
:alt: Selection of the "Production" purpose in the upgrade form on Odoo
.. danger::
Going into production without first testing may lead to:
- business interruptions (e.g. no longer having the possibility to validate an action)
- poor customer experiences (e.g. an eCommerce website that does not work correctly)
.. _db-upgrade/production-assistance:
Assistance
~~~~~~~~~~
If you encounter issues or problems in the **production database**, please contact the **Odoo
Support**:
#. Connect to our `Odoo Support page <https://www.odoo.com/help>`_.
#. Under the *Ticket Description* section, select the appropriate type related to your issue but
**do not select** the option *An issue related to my upgrade*.
.. note::
After upgrading to production, the support will be provided by the Support team instead of the
Upgrade team.
#. Please provide as much detail as you can. Where applicable, illustrate the current and previous
flows with videos and/or screenshots. This will avoid clarifying questions and speed up the
resolution process significantly.
.. image:: media/db-upgrade-production-assistance-details.png
:align: center
:alt: "Detailed Description" field in the support form on Odoo
.. warning::
If you choose *An issue related to my upgrade* as ticket type, the request will be redirected
to another team than the support one and will slow down the processing and response time.
.. _db-upgrade/faq:
FAQ
===
.. _db-upgrade/faq/why:
Why upgrade?
------------
* You benefit from the latest features of the :ref:`new major version
<db-upgrade/faq/release-notes>` released by Odoo.
* If you are in an :ref:`unsupported version <db-upgrade/supported-versions>`, you get a new version
with support.
.. _db-upgrade/faq/when:
When to upgrade?
----------------
Whenever you want. You can make your upgrade request as soon as a new version is released on our
`website form <https://upgrade.odoo.com>`_.
.. _db-upgrade/faq/availability:
Availability of the new version
-------------------------------
Please kindly note that as soon as we announce the release of a new major version (usually at the
end of year), the Upgrade Service team needs to adapt the upgrade scripts to it, which is why the
new version is not immediately available for existing databases.
.. _db-upgrade/faq/finalization:
Finalization of the upgrade (:abbr:`ETA (Estimated Time of Arrival)`)
---------------------------------------------------------------------
Unfortunately, it is impossible to give time estimates for every upgrade request. Odoo offers so
many possibilities (e.g. branding, workflows, customization, etc) that it can get tricky to upgrade,
and translate to the new structure. If you use multiple apps managing sensitive data (e.g.,
Accounting, Inventory, etc.), some cases may still require a human intervention, making the process
slower.
This is especially true during the first months following the release of a new major version, which
can significantly lengthen the upgrade delay.
In general, the smaller the database, the quickest the upgrade. A single-user database that uses
only CRM will be processed faster than a multi-company, multi-user database that uses Accounting,
Sales, Purchase, and Manufacturing.
So, in a nutshell, what can impact your upgrade lead time?
* Source & targeted versions
* Installed apps
* Volume of data
* Amount of customization (models, fields, methods, workflows, reports, website, etc.)
* Installation of new apps or configuration changes after the start of the test phase
Usually, the delays experienced during the first request (waiting time between the time you
submitted your first request for a test upgrade) can generally give you an idea of the time to wait
for the production request.
.. _db-upgrade/faq/custom-modules:
Upgrade of the custom modules
-----------------------------
As stated in our :doc:`/legal/terms/enterprise`, section :ref:`charges_standard`, this optional
service is subject to additional fees.
If you have a custom code, you can choose to have it upgraded by our services, by one of our
`partners <https://www.odoo.com/partners>`_ or you can do it yourself.
.. note:: |assistance-contact|
.. _db-upgrade/faq/editions-change:
Editions change (from Community to Enterprise)
----------------------------------------------
An upgrade does not cover a change of `Editions <https://www.odoo.com/page/editions>`_
.. note:: |assistance-contact|
.. _db-upgrade/faq/hosting-types-switch:
Switching the hosting types (Self-hosted vs Online vs Odoo.sh)
--------------------------------------------------------------
An upgrade does not cover a change of `Hosting types <https://www.odoo.com/page/hosting-types>`_.
Open the following link to get :doc:`more information about how to change your hosting type
<hosting_changes>`.
.. note:: |assistance-contact|
.. _db-upgrade/faq/release-notes:
Release Notes by version
------------------------
Open our `Release Note <https://www.odoo.com/page/release-notes>`_ page to get a summary of the new
features and improvements made in each version.
.. _db-upgrade/assistance:
Assistance
==========
.. _db-upgrade/contact:
Contact our Upgrade service support
-----------------------------------
Should you have any more questions about the upgrade, do not hesitate to send a message to `Odoo
Upgrade Team <mailto:upgrade@odoo.com>`_. We will be very pleased to answer it as soon as possible.
.. _db-upgrade/supported-versions:
Supported versions
------------------
Please note that Odoo provides support and bug fixing only for the three last major versions of Odoo.
This is a factor to take into consideration before upgrading. If you are on an older version, we
suggest you to prefer the most recent version to benefit from a longer support (before having to
upgrade again).
You can get more information about our :doc:`supported versions <supported_versions>`.
@@ -0,0 +1,336 @@
============
Domain names
============
A **domain name** works as an address for your website. It makes the Internet much more accessible
as it allows users to type a meaningful web address, such as ``www.odoo.com``, rather than its
server's IP address with a series of numbers.
You can use a custom domain name to access your Odoo database and websites:
- By :ref:`registering a free domain name with Odoo <domain-name/odoo-register>` (for Odoo Online
databases)
- By :ref:`configuring a custom domain that you already own <domain-name/existing>`.
.. note::
Odoo Online and Odoo.sh databases, including their websites, use by default a subdomain of
``odoo.com`` for both the URL and the emails (e.g., ``https://example.odoo.com``).
.. important::
Odoo offers a :ref:`free custom domain name <domain-name/odoo-register>` to all Odoo Online
databases for one year. Visitors can then access your website with an address such as
``www.example.com`` rather than the default ``example.odoo.com``.
.. seealso::
- `Odoo Tutorials: Register a Free Domain Name
<https://www.odoo.com/slides/slide/register-a-free-domain-name-1663>`_
- `Odoo Quick Tips: Get a free domain name! <https://www.youtube.com/watch?v=eAfgeNOHLP4>`_
.. _domain-name/about:
About domain names
==================
Having a **good domain name** is as important to your branding as the name of your business or
organization as it is the first thing your visitors will notice. We recommend you keep them *simple,
short, easy to remember and spell*.
A **subdomain** is a domain that is a part of another domain. It often refers to the additional part
that comes before the main domain name. Traditionally, most websites use the ``www.`` subdomain,
but any string of letters can be used as well. You can use subdomains to direct your visitors to
other websites than your main website or to specific pages (e.g., ``experience.odoo.com`` points to
a specific page.)
All domain names are referenced in the **Domain Name System**, or **DNS**, which works as a giant
directory for the Internet. There are many DNS servers, so any modification to the DNS can take up
to 72 hours to propagate worldwide on all servers.
.. _domain-name/odoo-register:
Register a free domain name with Odoo
=====================================
You can register a domain name for your Odoo Online database directly from Odoo Website or your
database manager.
.. important::
- Your domain name is **free for one year** if you register it with Odoo!
- The domain name is registered with `Gandi <https://www.gandi.net/>`_, the domain name
registrar.
- You are the owner of the domain name and can use it for other purposes.
- Odoo manages payment and technical support for you.
- This offer doesn't include any mailbox. However, you can :ref:`configure your MX records
<domain-name/odoo-manage>` to use your own email server or solution such as Google Workspace.
To do so, go to :menuselection:`Website --> Go to website --> Promote --> Domain Name`.
Alternatively, open your `database manager <https://www.odoo.com/my/databases>`_, click on the
:guilabel:`settings` button next to your database, then on :guilabel:`Domain names`.
.. image:: domain_names/register-promote.png
:align: center
:alt: Clicking on Domain Names from an Odoo website
Search for the domain name of your choice to check its availability, then select the one you want to
register for your website.
.. image:: domain_names/register-search.png
:align: center
:alt: The search of the domain name example.com shows which associated domains are available.
Next, fill in the form with your information to become the domain name owner.
Your domain name is directly linked to your database, but you still have to :ref:`map your domain
name with your website <domain-name/website-map>`.
.. note::
- Free domain names are also available for free Odoo Online databases (if you installed one app
only, for example). In this case, Odoo reviews your request and your website to avoid abuse.
This process may take up to three days.
- This is not available for Odoo.sh databases yet.
.. _domain-name/odoo-manage:
Manage your domain name registered with Odoo
--------------------------------------------
To manage the DNS records of your domain name registered with Odoo or to visualize the contacts
associated with it, open your `database manager <https://www.odoo.com/my/databases>`_, click on the
:guilabel:`settings` button next to your database, on :guilabel:`Domain names`, and then on
:guilabel:`Contacts` or :guilabel:`DNS`.
.. image:: domain_names/manage.png
:align: center
:alt: Management of the domain names linked to an Odoo database
.. note::
Please `submit a support ticket <https://www.odoo.com/help>`_ if you need further assistance to
manage your domain name.
.. _domain-name/existing:
Configure your existing domain name
===================================
If you already own a domain name, you can use it to point to your website.
To avoid any issue with the :ref:`SSL certificate validation <domain-name/ssl>`, we highly recommend
that you proceed with the following actions in this order:
#. :ref:`Add a CNAME record <domain-name/cname>` on your domain name's DNS zone.
#. :ref:`Map your domain name with your Odoo database <domain-name/db-map>`.
#. :ref:`Map your domain name with your Odoo website <domain-name/website-map>`.
.. _domain-name/cname:
Add a CNAME record
------------------
A **CNAME record** is a type of DNS record that points to the domain of another website rather than
directly to an IP address.
You need a CNAME record that points to your Odoo database. The requirements are detailed in your
database manager.
.. tabs::
.. group-tab:: Odoo Online
The target address is the current address of your database, as defined at its creation (e.g.,
``example.odoo.com``)
.. group-tab:: Odoo.sh
Your project's main address is defined in :menuselection:`Settings --> Project Name`.
If you want to target a specific branch (production, staging or development), go to
:menuselection:`Branches --> select your branch --> Settings --> Custom domains`, and click on
:guilabel:`How to set up my domain?`. A message indicates which address your CNAME record
should target.
#. Open your domain name's manager dashboard.
#. Open the **DNS zone** management page for the domain name you want to configure.
#. Create a **CNAME record** pointing to the address of your database.
While Odoo suggests creating a CNAME record for your ``www.`` subdomain (``www.example.com``), you
can of course use any domain name of your choice, with any subdomain (e.g.,
``anything.example.com``).
.. example::
You own the domain name ``example.com``, and you have an Odoo Online database at the address
``example.odoo.com``. You want to access your Odoo database primarily with the domain
``www.example.com`` but also with the :ref:`naked domain <domain-name/naked-domain>`
``example.com``.
To do so, you create a CNAME record for the ``www`` subdomain, with ``example.odoo.com`` as the
target. The DNS zone manager generates the following rule and adds it to your DNS zone: ``www IN
CNAME example.odoo.com.``
You also create a redirection from ``example.com`` to ``wwww.example.com``.
Your new DNS records are propagated to all DNS servers.
.. note::
Here are some specific guidelines to create a CNAME record:
- `GoDaddy <https://www.godaddy.com/help/add-a-cname-record-19236>`_
- `Namecheap <https://www.namecheap.com/support/knowledgebase/article.aspx/9646/2237/how-to-create-a-cname-record-for-your-domain>`_
- `OVH <https://docs.ovh.com/us/en/domains/web_hosting_how_to_edit_my_dns_zone/#add-a-new-dns-record>`_
- `CloudFlare <https://support.cloudflare.com/hc/en-us/articles/360019093151>`_
- `Google Domains <https://support.google.com/domains/answer/3290350?hl=en>`_
.. _domain-name/naked-domain:
Naked domain
~~~~~~~~~~~~
A **naked domain** is a domain name that doesn't have any subdomain at the beginning of the address
(e.g., ``odoo.com`` instead of ``www.odoo.com``).
You may want your naked domain to redirect to your website as some visitors may not type the full
domain name to access your website.
#. Open your domain name's manager dashboard.
#. Create a **redirection** from the naked domain (``example.com``) to your main domain name
(``www.example.com``).
.. note::
Depending on your domain name registrar, this redirection may be already pre-configured.
.. _domain-name/db-map:
Map your domain name with your Odoo database
--------------------------------------------
.. tabs::
.. group-tab:: Odoo Online
Open your `database manager <https://www.odoo.com/my/databases>`_, click on the
:guilabel:`settings` button next to your database, on :guilabel:`Domain names`, and then on
:guilabel:`Use my own domain` at the bottom of the right column.
Type the domain name you want to add to this database, then click on :guilabel:`Verify` to
check if the CNAME record is correctly configured. Once done, click on :guilabel:`I confirm,
it's done`.
.. image:: domain_names/online-map.png
:align: center
:alt: Verification of the CNAME records of a domain name before mapping it with a database
.. group-tab:: Odoo.sh
Go to :menuselection:`Branches --> select your branch --> Settings --> Custom domains`, type
the domain name you want to add to this database, then click on :guilabel:`Add domain`.
.. image:: domain_names/odoo-sh-map.png
:align: center
:alt: Mapping a domain name with an Odoo.sh branch
.. seealso::
- :ref:`Odoo.sh branches: settings tab <odoosh-gettingstarted-branches-tabs-settings>`
.. warning::
Make sure to :ref:`add a CNAME record <domain-name/cname>` to your domain name's DNS **before**
mapping your domain name with your Odoo database.
Failing to do so may impede the validation of the :ref:`SSL certificate <domain-name/ssl>` and
would result in a *certificate name mismatch* error. This is often displayed by web browsers as a
warning such as *"Your connection is not private"*.
If this is the case and you have added the domain name to your database's settings less than five
days ago, wait 24 hours as the validation may still happen. Otherwise, please `submit a support
ticket <https://www.odoo.com/help>`_ including screenshots of your CNAME records.
.. _domain-name/ssl:
SSL encryption (HTTPS protocol)
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
**SSL encryption** is an encryption-based Internet security protocol. It allows your visitors to
navigate your website through a secure connection, which appears as an ``https://`` protocol at the
beginning of your web address, rather than a non-secure ``http://`` protocol.
Odoo generates a separate SSL certificate for each domain :ref:`mapped in the database manager
<domain-name/db-map>`, using integration with `Let's Encrypt Certificate Authority and ACME protocol
<https://letsencrypt.org/how-it-works/>`_.
.. note::
- The certificate generation may take up to 24h.
- Several attempts to validate your certificate are made during the five days following the
moment you add your domain name in your database's settings.
- If you already use another service, you can keep using it or simply change for Odoo.
.. _domain-name/web-base-url:
Web base URL of a database
~~~~~~~~~~~~~~~~~~~~~~~~~~
.. note::
If you have Odoo Website, you can disregard this part and directly :ref:`map your domain name
with your website <domain-name/website-map>`.
The **web base URL** of a database, or **root URL** affects your main website address and all the
links sent to your customers (e.g., quotations, portal links, etc.).
To configure it, access your Odoo database with your custom address, then log in as an administrator
of your database (any user in the *Settings* group) from the login screen.
.. warning::
Connecting to your database with the original Odoo subdomain address (e.g., ``example.odoo.com``
also updates the web base URL of your database. See below to prevent these automatic updates.
Alternatively, you can do it manually. To do so, activate the :ref:`developer mode
<developer-mode>`, then go to :menuselection:`Settings --> Technical --> System Parameters`.
Find the key called ``web.base.url`` (or create it if it does not exist) and enter the full address
of your website as value, such as ``https://www.example.com``.
.. note::
The URL must include the protocol ``https://`` (or ``http://``) and must not end with a slash
(``/``).
To prevent the automatic update of the web base URL when an administrator logs in the database, you
can create the following System Parameter:
- key: ``web.base.url.freeze``
- value: ``True``
.. _domain-name/website-map:
Map your domain name with your website
======================================
Mapping your domain name to your website isn't the same as mapping it with your database:
- It defines your domain name as the main one for your website, helping search engines to index your
website properly.
- It defines your domain name as the base URL for your database, including the portal links sent by
email to your customers.
- If you have multiple websites, it maps your domain name with the appropriate website.
Go to :menuselection:`Website --> Configuration --> Settings --> Website Info`. If you have multiple
websites, select the one you want to configure.
In the :guilabel:`Domain` field, fill in the web address of your website (e.g.,
``https://www.example.com``) and click on :guilabel:`Save`.
.. image:: domain_names/website-settings.png
:align: center
:alt: Configuring https://www.example.com as the Domain of the website
.. warning::
Mapping your domain name with your Odoo website prevents Google from indexing both your custom
domain name ``www.example.com`` and your original odoo database address ``example.odoo.com``.
If both addresses are already indexed, it may take some time before Google removes the indexation
of the second address. You may also try using the `Google Search Console
<https://search.google.com/search-console/welcome>`_ to fix this.
.. note::
If you have multiple websites and companies on your database, make sure that you select the
right :guilabel:`Company` in the website settings, next to the :guilabel:`Domain` settings. Doing
so indicates Odoo which URL to use as the :ref:`base URL <domain-name/web-base-url>` according to
the company in use.
.. seealso::
- :doc:`/applications/general/email_communication/email_servers`
Binary file not shown.

After

Width:  |  Height:  |  Size: 12 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 8.9 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 22 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 38 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 32 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 7.2 KiB

@@ -41,7 +41,7 @@ On Linux, using an installer
.. code-block:: console
$ sudo dpkg -i <path_to_enterprise_deb>
* Update your database to the enterprise packages using
.. code-block:: console
@@ -0,0 +1,192 @@
========================================
Connect Gmail to Odoo using Google OAuth
========================================
Odoo is compatible with Google's OAuth for Gmail. In order to send secure emails from a custom
domain, all that is required is to configure a few settings on Google's *Workspace* platform, as
well as on the back end of the Odoo database. This configuration works by using either a personal
email address or an address created by a custom domain.
.. tip::
For more information, visit `Google's documentation
<https://support.google.com/cloud/answer/6158849>`_ on setting up OAuth.
Setup in Google
===============
Create a new project
--------------------
To get started, go to the `Google API Platform
<https://console.cloud.google.com/apis/credentials/consent>`_. Log in with your *Google Workspace*
account if you have one, otherwise log in with your personal Gmail account (this should match the
email address you want to configure in Odoo).
After that, click on :guilabel:`Create Project`, located on the far right of the OAuth consent
screen. If a project has already been created in this account, then the :guilabel:`New Project`
option will be located on the top left under the :guilabel:`Select a project` drop-down menu.
On the :guilabel:`New Project` screen, rename the :guilabel:`Project name` to `Odoo` and browse for
the :guilabel:`Location`. Set the :guilabel:`Location` as the `Google Workspace` organization. If
you are using a personal Gmail account, then leave the :guilabel:`Location` as `No Organization`.
.. image:: google_oauth/new-project.png
:align: center
:alt: Project Name and Location for Google Oauth.
Click on :guilabel:`Create` to finish this step. On the next screen, :guilabel:`User Type` options,
select the :guilabel:`External` option, and then click on :guilabel:`Create` again, which will
finally navigate to the :guilabel:`Edit app registration` page.
Edit app registration
---------------------
- On the :guilabel:`Oauth consent screen` step, under the :guilabel:`App information` section,
enter `Odoo` in the :guilabel:`App name` field. Select the organization's email address under the
:guilabel:`User support` email field.
- Next, under :menuselection:`App Domain --> Authorized domains`, click on :guilabel:`Add Domain`
and enter `odoo.com`.
- After that, under the :guilabel:`Developer contact information` section, enter the organization's
email address. Google uses this email address to notify the organization about any changes to
your project.
- Next, click on the :guilabel:`Save and Continue` button.
- Then, skip the :guilabel:`Scopes` page by scrolling to the bottom and clicking on
:guilabel:`Save and Continue`.
- Next, add the email being configured under the :guilabel:`Test users` step by clicking on
:guilabel:`Add Users` and then the :guilabel:`Save and Continue` button. A summary of the
:guilabel:`App registration` appears.
- Finally, scroll to the bottom and click on :guilabel:`Back to Dashboard`.
Create Credentials
------------------
Now that you have set up the project, you need to create credentials, which includes the
:guilabel:`Client ID` and :guilabel:`Client Secret`. First, click on :guilabel:`Credentials` in the
left sidebar menu.
Then, click on :guilabel:`Create Credentials` in the top menu and select
:guilabel:`OAuth client ID` from the dropdown menu.
- Under :guilabel:`Application Type`, select :guilabel:`Web Application` from the dropdown menu.
- In the :guilabel:`Client ID` field, enter `Odoo`.
- Under the :guilabel:`Authorized redirect URIs` label, click the button :guilabel:`ADD URI`, and
then input `https://yourdbname.odoo.com/google_gmail/confirm` in the :guilabel:`URIs 1` field. Be
sure to replace the *yourdbname* part of the URL with your actual Odoo database name.
- Next, click on :guilabel:`Create` to generate an OAuth :guilabel:`Client ID` and
:guilabel:`Client Secret`. Finally, copy each generated value for later use when configuring in
Odoo, and then navigate to the Odoo database.
.. image:: google_oauth/client-credentials.png
:align: center
:alt: Client ID and Client Secret for Google OAuth.
Setup in Odoo
=============
Enter Google Credentials
------------------------
First, open Odoo and navigate to the :guilabel:`Apps` module. Then, remove the :guilabel:`Apps`
filter from the search bar and type in `Google`. Install the module called :guilabel:`Google Gmail`.
Next, navigate to :menuselection:`Settings --> General Settings`, and under the :guilabel:`Discuss`
section, ensure that the checkbox for :guilabel:`Custom Email Servers` is checked. This populates a
new option for :guilabel:`Gmail Credentials`. Then, copy and paste the :guilabel:`Client ID` and
:guilabel:`Client Secret` into the respective fields and :guilabel:`Save` the settings.
Configure outgoing email server
-------------------------------
After that, on the :guilabel:`General Settings` page, under :guilabel:`Custom Email Servers`, click
:guilabel:`Outgoing Email Servers` to configure the external Gmail account.
.. image:: google_oauth/outgoing-servers.png
:align: center
:alt: Configure Outgoing Email Servers in Odoo.
Then, :guilabel:`Create` a new email server and select the option for :guilabel:`Gmail`. Next, fill
in the :guilabel:`Description` (can be anything) and the email :guilabel:`Username` and click on
:guilabel:`Connect your Gmail account`.
A new window from :guilabel:`Google` opens to complete the authorization process. Select the
appropriate email address that is being configured in Odoo.
If the email address is a personal account, an extra step pops up, click :guilabel:`Continue` to
allow the verification and connect the Gmail account to Odoo.
Then, allow Odoo to access the Google account by clicking on :guilabel:`Continue` or
:guilabel:`Allow`. After that, the page navigates back to the newly configured outgoing email
server in Odoo. The configuration automatically loads the token in Odoo, and a tag stating
:guilabel:`Gmail Token Valid` appears in green.
.. image:: google_oauth/green-token.png
:align: center
:alt: Configure Outgoing Email Servers in Odoo.
Finally, save the settings and :guilabel:`Test the Connection`. A confirmation message should
appear. The Odoo database can now send safe, secure emails through Google using OAuth
authentication.
Google OAuth FAQ
================
Production VS Testing Publishing Status
---------------------------------------
Choosing :guilabel:`Production` as the :guilabel:`Publishing Status` (instead of Testing) will
display the following warning message:
.. image:: google_oauth/published-status.png
:align: center
:alt: OAuth is Limited to 100 Sensitive Scope Logins.
To correct this warning, navigate to the `Google API Platform
<https://console.cloud.google.com/apis/credentials/consent>`_. If the :guilabel:`Publishing status`
is :guilabel:`In Production`, click :guilabel:`Back to Testing` to correct the issue.
No Test Users Added
-------------------
If no test users are added to the OAuth consent screen, then a 403 access denied error will
populate.
.. image:: google_oauth/403-error.png
:align: center
:alt: 403 Access Denied Error.
To correct this error, return to the :guilabel:`OAuth consent screen` under
:guilabel:`APIs & Services` and add test user(s) to the app. Add the email that you are configuring
in Odoo.
Gmail Module not updated
------------------------
If the :guilabel:`Gmail Module` in Odoo has not been updated to the latest version, then a
:guilabel:`Forbidden` error message populates.
.. image:: google_oauth/forbidden-error.png
:align: center
:alt: Forbidden you don't have the permission to access the requested resource.
To correct this error, go to the :guilabel:`Apps` module and clear out the search terms. Then,
search for `Gmail` or `Google` and upgrade the :guilabel:`Google Gmail` module. Finally, click on
the three dots on the upper right of the module and select :guilabel:`Upgrade`.
Application Type
----------------
When creating the :guilabel:`Credentials` (OAuth Client ID and Client Secret), if
:guilabel:`Desktop App` is selected for the :guilabel:`Application Type`, an
:guilabel:`Authorization Error` appears.
.. image:: google_oauth/error-400.png
:align: center
:alt: Error 400 Redirect URI Mismatch.
To correct this error, delete the credentials already created and create new credentials, selecting
:guilabel:`Web Application` for the :guilabel:`Application Type`. Then, under
:guilabel:`Authorized redirect URIs`, click :guilabel:`ADD URI` and type:
`https://yourdbname.odoo.com/google_gmail/confirm` in the field.
.. note::
Replace *yourdbname* in the URL with the Odoo database name.
Binary file not shown.

After

Width:  |  Height:  |  Size: 16 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 25 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 7.5 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 10 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 25 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 9.8 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 16 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 6.1 KiB

@@ -11,8 +11,6 @@ Depending on the platforms, you have to do it by yourself or contact our support
From on-premises to Odoo Online
===============================
.. warning:: Odoo Online is not compatible with **non-standard apps**.
1. Create a :ref:`duplicate <duplicate_premise>` of your database: in this duplicate, uninstall all the **non-standard apps**.
2. Grab a "dump with filestore" of your database by using the Database Manager.
3. **If you have time constraints, contact us earlier to schedule the transfer.**
@@ -20,6 +18,11 @@ From on-premises to Odoo Online
5. We will make sure your database is compatible and upload it to our cloud. In case of technical issues, we will get in touch with you.
6. It's done!
.. important::
- Odoo Online is not compatible with **non-standard apps**.
- The database you are moving to Odoo Online must be in a :doc:`supported version
<supported_versions>`.
From on-premises to Odoo.sh
===========================
@@ -45,17 +48,40 @@ From Odoo Online to Odoo.sh
From Odoo.sh to Odoo Online
===========================
.. warning:: Odoo Online is not compatible with **non-standard apps**.
#. Uninstall all the **non-standard apps**.
#. `Create a support ticket <https://www.odoo.com/help>`_ and include the following:
1. Uninstall all the **non-standard apps**: test it in a staging build first, then do it in your production build.
2. **If you have time constraints, contact us earlier to schedule the transfer.**
3. `Create a support ticket <https://www.odoo.com/help>`_ and attach the dump (if the file is too large, use any file transfer service and attach the link to your ticket). Also include your subscription number and the URL you want to use for your database (e.g.: my-company.odoo.com).
4. We will make sure your database is compatible and upload it to our cloud. In case of technical issues, we will get in touch with you.
5. It's done!
- Your subscription number
- The URL you want to use for your database (e.g., `example.odoo.com`)
- Which branch you want to migrate
- In which region you want to be hosted:
- Americas
- Europe
- Asia
- Which user(s) will be the administrator(s)
- When (and in which timezone) you want the database to be up and running
#. We will make sure your database is compatible and upload it to our cloud. In case of technical
issues, we will get in touch with you.
#. All done!
.. important::
- Odoo Online is not compatible with **non-standard apps**.
- Make sure to uninstall all the **non-standard apps** in a staging build before doing it in your
production build.
.. note::
- Make sure you select the **region** that is closest to your users to reduce latency.
- The future **administrator(s)** must have an odoo.com account.
- The specific **date and time** at which you want the database to be up and running are mainly
helpful to organize the switch from the odoo.sh server to the Odoo Online servers.
- Databases are **not reachable** during their migration.
- **If you have time constraints, contact us earlier to schedule the transfer**.
From Odoo.sh to on-premises
===========================
1. Grab a :ref:`backup of your Odoo.sh production database <odoo_sh_branches_backups>`.
2. Restore it from the database manager on your local server.
@@ -0,0 +1,218 @@
===========
Mailjet API
===========
Odoo is compatible with Mailjet's :abbr:`API (Application Programming Interface)` for mass mailing.
Set up a dedicated mass mailing server through Mailjet by configuring settings in the Mailjet
account and the Odoo database. In some circumstances, settings need to be configured on the custom
domain's :abbr:`DNS (Domain Name System)` settings as well.
Set up in Mailjet
=================
Create API credentials
----------------------
To get started, sign in to the `Mailjet Account Information <https://app.mailjet.com/account>`_
page. Next, navigate to the :guilabel:`Senders & Domains` section and click on :guilabel:`SMTP and
SEND API Settings`.
.. image:: mailjet_api/api-settings.png
:align: center
:alt: SMTP and Send API Settings link in the Senders & Domains section of Mailjet.
Then, copy the :abbr:`SMTP (Simple Mail Transfer Protocol)` configuration settings onto a notepad.
They can be found under the :guilabel:`Configuration (SMTP only)` section. The :abbr:`SMTP (Simple
Mail Transfer Protocol)` configuration settings include the server address, the security option
needed (Use :abbr:`SSL (Secure Sockets Layer)`/:abbr:`TLS (Transport Layer Security)`), and the
port number. The settings are needed to configure Mailjet in Odoo, which is covered in the
:ref:`last section <maintain/mailjet-api/odoo-setup>`.
.. seealso::
`Mailjet: How can I configure my SMTP parameters?
<https://documentation.mailjet.com/hc/articles/360043229473>`_
.. important::
Odoo blocks `port 25` on Odoo Online and Odoo.sh databases. :ref:`See reference here
<email_servers/restriction>`.
.. image:: mailjet_api/smtp-config.png
:align: center
:alt: SMTP configuration from Mailjet.
Next, click on the button labeled :guilabel:`Retrieve your API credentials` to retrieve the Mailjet
API credentials.
Then, click on the eye icon to reveal the :guilabel:`API key`. Copy this key to a notepad, as this
serves as the :guilabel:`Username` in the Odoo configuration. Next, click on the
:guilabel:`Generate Secret Key` button to generate the :guilabel:`Secret Key`. Copy this key to a
notepad, as this serves as the :guilabel:`Password` in the Odoo configuration.
Add verified sender address(es)
-------------------------------
The next step is to add a sender address or a domain to the Mailjet account settings so that the
email address or domain is approved to send emails using Mailjet's servers. First, navigate to the
`Mailjet Account Information <https://app.mailjet.com/account>`_ page. Next, click on the
:guilabel:`Add a Sender Domain or Address` link under the :guilabel:`Senders & Domains` section.
.. image:: mailjet_api/add-domain-email.png
:align: center
:alt: Add a sender domain or address in the Mailjet interface.
Determine if a sender's email address or the entire domain needs to be added to the Mailjet
settings. It may be easier to configure the domain as a whole if :abbr:`DNS (Domain Name System)`
access is available. Jump to the :ref:`Add a domain <maintain/mailjet-api/add-domain>` section for
steps on adding the domain.
.. note::
Either all email addresses of the Odoo database users who are sending emails using Mailjet's
servers need to be configured or the domain(s) of the users' email addresses can be configured.
By default, the email address originally set up in the Mailjet account is added as a trusted
sender. To add another email address, click on the button labeled :guilabel:`Add a sender address`.
Then, add the email address that is configured to send from the custom domain.
At minimum the following email addresses should be set up in the provider and verified in Mailjet:
- notifications\@yourdomain.com
- bounce\@yourdomain.com
- catchall\@yourdomain.com
.. note::
Replace `yourdomain` with the custom domain for the Odoo database. If there isn't one, then use
the :guilabel:`mail.catchall.domain` system parameter.
After that, fill out the :guilabel:`Email Information` form, making sure to select the appropriate
email type: transactional email or mass emails. After completing the form, an activation email is
sent to the email address and the trusted sender can be activated.
It is recommended to set up the :abbr:`SPF (Sender Policy Framework)`/:abbr:`DKIM (DomainKeys
Identified Mail)`/:abbr:`DMARC (Domain-based Message Authentication, Reporting, and
Conformance)` settings on the domain of the sender.
.. seealso::
`Mailjet's SPF/DKIM/DMARC documentation <https://documentation.mailjet.com/hc/articles/
360042412734-Authenticating-Domains-with-SPF-DKIM>`_
.. important::
If the database is not using a custom domain, then in order to verify the sender's address, a
temporary alias (of the three email addresses mentioned above) should be set up in Odoo CRM to
create a lead. Then, the database is able to receive the verification email and verify the
accounts.
.. _maintain/mailjet-api/add-domain:
Add a domain
------------
By adding an entire domain to the Mailjet account, all the sender addresses related to that domain
are automatically validated for sending emails using Mailjet servers. First, navigate to the
`Mailjet Account Information <https://app.mailjet.com/account>`_ page. Next, click on
:guilabel:`Add a Sender Domain or Address` link under the :guilabel:`Senders & Domains` section.
Then, click on :guilabel:`Add domain` to add the custom domain.
.. note::
The domain needs to be added to the Mailjet account and then validated through the :abbr:`DNS
(Domain Name System)`.
After that, fill out the :guilabel:`Add a new Domain` page on Mailjet and click
:guilabel:`Continue`.
After adding the domain, a validation page will populate. Unless the Odoo database is on-premise
(in which case, choose :guilabel:`Option 1`), choose :guilabel:`Option 2: Create a DNS Record`.
Copy the TXT record information to a notepad and then navigate to the domain's :abbr:`DNS (Domain
Name System)` provider to complete validation.
.. image:: mailjet_api/host-value-dns.png
:align: center
:alt: The TXT record information to input on the domain's DNS.
Setup in the domain's DNS
~~~~~~~~~~~~~~~~~~~~~~~~~
After getting the TXT record information from the Mailjet account, add a TXT record to the domain's
:abbr:`DNS (Domain Name System)`. This process varies depending on the :abbr:`DNS (Domain Name
System)` provider. Consult the provider for specific configuration processes. The TXT record
information consists of the :guilabel:`Host` and :guilabel:`Value`. Paste these into
the corresponding fields in the TXT record.
Return to Mailjet account information
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
After adding the TXT record to the domain's :abbr:`DNS (Domain Name System)`, navigate back to the
Mailjet account. Then, navigate to :menuselection:`Account Information --> Add a Sender Domain or
Address`, click the gear icon next to :guilabel:`Domain`, and select :guilabel:`Validate`.
This action can also be done by going to the `Sender domains & addresses <https://app.mailjet.com/
account/sender>`_ page on the Mailjet account information and clicking on :guilabel:`Manage`.
Next, click :guilabel:`Check Now` to validate the TXT record that was added on the domain. A
success screen will appear if the domain is configured correctly.
.. image:: mailjet_api/check-dns.png
:align: center
:alt: Check DNS record in Mailjet.
After successfully setting up the domain, there is an option to :guilabel:`Authenticate this domain
(SPF/DKIM)`. This button populates :abbr:`SPF (Sender Policy Framework)` & :abbr:`DKIM (DomainKeys
Identified Mail) records to input into the :abbr:`DNS (Domain Name System)` provider.
.. seealso::
`Mailjet's SPF/DKIM/DMARC documentation <https://documentation.mailjet.com/hc/articles/
360042412734-Authenticating-Domains-with-SPF-DKIM>`_
.. image:: mailjet_api/authenticate.png
:align: center
:alt: Authenticate the domain with SPF/DKIM records in Mailjet.
.. _maintain/mailjet-api/odoo-setup:
Set up in Odoo
==============
To complete the setup, navigate to the Odoo database and go to the :guilabel:`Settings`. With
:ref:`developer-mode` turned on, go to the :menuselection:`Technical Menu --> Email --> Outgoing
Mail Servers`. Then, create a new outgoing server configuration by clicking on the
:guilabel:`Create` button.
Next, input the `SMTP server` (in-v3.mailjet.com), `port number` (587 or 465), and `Security
(SSL/TLS)` that was copied earlier from the Mailjet account. They can also be found `here
<https://app.mailjet.com/account/setup>`_. It is recommended to use :abbr:`SSL (Secure Sockets
Layer)`/:abbr:`TLS (Transport Layer Security)` even though Mailjet may not require it.
For the :guilabel:`Username`, input the :guilabel:`API KEY`. For the :guilabel:`Password`, input
the :guilabel:`SECRET KEY` that was copied from the Mailjet account to the notepad earlier. These
settings can be found on :menuselection:`Mailjet --> Account Settings --> SMTP and SEND API
Settings`.
Then, if the Mailjet server is used for mass emailing, set the :guilabel:`Priority` value higher
than that of any transactional email server(s). Finally, save the settings and :guilabel:`Test the
Connection`.
.. image:: mailjet_api/server-settings.png
:align: center
:alt: Odoo outgoing email server settings.
.. important::
In order for the notifications feature to work using Mailjet, there are three settings that need
to be set in Odoo.
#. The :guilabel:`From Filter` needs to be set on the server configuration. It is recommended
to set it as a domain and not a full email address. It should match the domain in the two
proceeding steps. More information can be referenced :ref:`here
<email_servers/outgoing-email-server>`.
#. The :guilabel:`mail.default.from` system parameter must have the value
`notifications\@yourdomain.com`.
#. The :guilabel:`mail.default.from_filter` system parameter must have the value
`yourdomain.com`. Replace `yourdomain` with the custom domain for the Odoo database. If there
isn't one, then use the :guilabel:`mail.catchall.domain` system parameter.
For more information see :ref:`Using a default email address <email_communication/default>`.
The :guilabel:`System Parameters` can be accessed by activating
:doc:`../../applications/general/developer_mode` in the :menuselection:`Settings --> Technical
--> Parameters --> System Parameters` menu.
Once the setup is complete, the Odoo database is ready to use the Mailjet email server for mass
mailing or transactional emails!
Binary file not shown.

After

Width:  |  Height:  |  Size: 17 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 18 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 24 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 35 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 38 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 16 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 24 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 9.5 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 2.8 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 13 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 8.7 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 2.9 KiB

@@ -0,0 +1,155 @@
===============================
Odoo Online database management
===============================
To manage a database, sign in to https://www.odoo.com and access the `database management page
<https://www.odoo.com/my/databases>`_ by clicking on the user icon, then on *My Databases*.
.. image:: odoo_online/my-databases.png
:align: center
:alt: Clicking on the user icon opens a drop-down menu. "My databases" button is highlighted.
.. note::
Make sure you are connected as the administrator of the database you want to manage.
.. image:: odoo_online/dropdown-menu.png
:align: right
:alt: Clicking on the gear icon opens the drop-down menu.
Open the drop-down menu next to the database you want to manage by clicking on the gear icon.
Several actions are available:
- :ref:`odoo_online/upgrade`
- :ref:`odoo_online/duplicate`
- :ref:`odoo_online/rename`
- :ref:`odoo_online/download`
- :ref:`odoo_online/domains`
- :ref:`odoo_online/tags`
- :ref:`odoo_online/delete`
- :ref:`odoo_online/contact-support`
- :ref:`odoo_online/users`
.. _odoo_online/upgrade:
Upgrade
=======
If you are *not* on the latest **Online version**, you should receive an invitation to :doc:`upgrade
<../upgrade>` your database. A **Rolling Release button** on your database's main screen proposes an
upgrade to the latest version (e.g., 13.0 to 15.1).
.. important::
- | **If your Odoo database's version is lower than the latest major release:**
| You must upgrade your database within two months. After these two months, an automatic
upgrade is initiated.
- | **If your Odoo database's version is equal to or higher than the latest major release:**
| You can disregard the invitation to upgrade as you probably wouldn't benefit from new
features every two months.
.. note::
Versions that are not supported anymore become deprecated and need to be updated to avoid
security issues. We recommend you initiate the upgrade of the database yourself, as this method
allows you to request a test upgrade of your database to check for any discrepancies.
.. seealso::
- :doc:`../upgrade`
- :doc:`supported_versions`
.. _odoo_online/duplicate:
Duplicate
=========
Make an exact copy of the database to be able to perform testing without compromising the daily
operations.
.. important::
- By checking *For testing purposes*, all external communication (emails, payments, delivery
orders, etc.) are disabled by default on the duplicated database.
- Duplicate databases expire automatically after 15 days.
.. _odoo_online/rename:
Rename
======
Rename the database and its URL.
.. _odoo_online/download:
Download
========
Download instantly a ZIP file with a backup of the database.
.. note::
Databases are backed up daily according to the `Odoo Cloud SLA
<https://www.odoo.com/cloud-sla>`_.
.. _odoo_online/domains:
Domains
=======
Configure custom domains to access the database via another URL.
.. seealso::
- :doc:`domain_names`
.. _odoo_online/tags:
Tags
====
Add tags to sort your databases out. You can search the tags in the search bar.
.. _odoo_online/delete:
Delete
======
Delete a database instantly.
.. danger::
Deleting a database means that all data is permanently lost. The deletion is instant and for all
users. It is recommended to create a backup of the database before deleting it.
Read carefully the warning message that pops up and proceed only if you fully understand the
implications of deleting a database:
.. image:: odoo_online/delete.png
:align: center
:alt: A warning message is prompted before deleting a database.
.. note::
- Only an administrator can delete a database.
- The database name is immediately available for a new database.
- It is not possible to delete a database if it is expired or linked to a subscription. If
needed, please get in touch with `Odoo Support <https://www.odoo.com/help>`_.
- To delete your account, please get in touch with `Odoo Support <https://www.odoo.com/help>`_.
.. _odoo_online/contact-support:
Contact Support
===============
Access the Odoo `support page <https://www.odoo.com/help>`_ with your database's details already
pre-filled.
.. _odoo_online/users:
Invite / Remove Users
=====================
To invite users, fill out the email address of the new user and click on *Invite*. To add multiple
users, click on *Add more users*.
.. image:: odoo_online/invite-users.png
:align: center
:alt: Clicking on "Add more users" adds additional email fields.
To remove users, select the users to remove and click on *Remove*.
.. seealso::
- :doc:`/applications/general/users/manage_users`
Binary file not shown.

After

Width:  |  Height:  |  Size: 19 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 5.5 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 6.0 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 9.6 KiB

@@ -1,9 +1,6 @@
.. _db_premise:
===============================
On-premises Database management
===============================
==============================
On-premise database management
==============================
Register a database
===================
@@ -12,7 +9,7 @@ To register your database, you just need to enter your Subscription Code in the
banner in the App Switcher. Make sure you do not add extra spaces before or after
your subscription code. If the registration is successful, it will turn green and
will provide you with the Expiration Date of your freshly-registered database. You
can check this Epiration Date in the About menu (Odoo 9) or in the Settings Dashboard
can check this Expiration Date in the About menu (Odoo 9) or in the Settings Dashboard
(Odoo 10).
Registration Error Message
@@ -21,13 +18,13 @@ Registration Error Message
If you are unable to register your database, you will likely encounter this
message:
.. image:: media/error_message_sub_code.png
:align: center
:alt: Something went wrong while registering your database,
you can try again or contact Odoo Help
.. image:: on_premise/error_message_sub_code.png
:align: center
:alt: Something went wrong while registering your database, you can try again or contact Odoo
Help
Solutions
'''''''''
~~~~~~~~~
* Do you have a valid Enterprise subscription?
@@ -44,16 +41,14 @@ Solutions
* You can unlink the old database yourself on your `Odoo Contract
<https://accounts.odoo.com/my/subscription>`__ with the button "Unlink database"
.. image:: media/unlink_single_db.png
:align: center
.. image:: on_premise/unlink_single_db.png
:align: center
A confirmation message will appear; make sure this is the correct database as
it will be deactivated shortly:
.. image:: media/unlink_confirm_enterprise_edition.png
:align: center
.. image:: on_premise/unlink_confirm_enterprise_edition.png
:align: center
* Do you have the updated version of Odoo 9?
@@ -65,9 +60,8 @@ Solutions
<https://accounts.odoo.com/my/subscription>`__, a short message will appear
specifying which database is problematic:
.. image:: media/unlink_db_name_collision.png
:align: center
.. image:: on_premise/unlink_db_name_collision.png
:align: center
In this case, you need to change the UUID on your test databases to solve this
issue. You will find more information about this in :ref:`this section <duplicate_premise>`.
@@ -88,25 +82,22 @@ Solutions
* Once you activated your database, you must keep these ports open, as the
Update notification runs once a week.
Error message due to too many users
-----------------------------------
If you have more users in your local database than provisionned in your
Odoo Enterprise subscription, you may encounter this message:
.. image:: media/add_more_users.png
:align: center
:alt: This database will expire in X days, you
have more users than your subscription allows
.. image:: on_premise/add_more_users.png
:align: center
:alt: This database will expire in X days, you have more users than your subscription allows
When the message appears you have 30 days before the expiration.
The countdown is updated everyday.
Solutions
'''''''''
~~~~~~~~~
- **Add more users** on your subscription: follow the link and Validate
the upsell quotation and pay for the extra users.
@@ -125,16 +116,15 @@ Database expired error message
If your database reaches its expiration date before your renew your subscription,
you will encounter this message:
.. image:: media/database_expired.png
:align: center
:alt: This database has expired.
.. image:: on_premise/database_expired.png
:align: center
:alt: This database has expired.
This **blocking** message appears after a non-blocking message that lasts 30 days.
If you fail to take action before the end of the countdown, the database is expired.
Solutions
'''''''''
~~~~~~~~~
* Renew your subscription: follow the link and renew your subscription - note that
if you wish to pay by Wire Transfer, your subscription will effectively be renewed
@@ -145,7 +135,6 @@ Solutions
None of those solutions worked for you? Please contact our
`Support <https://www.odoo.com/help>`__
.. _force_ping:
.. _duplicate_premise:
@@ -157,9 +146,8 @@ You can duplicate your database by accessing the database manager on your
server (<odoo-server>/web/database/manager). In this page, you can easily
duplicate your database (among other things).
.. image:: media/db_manager.gif
:align: center
.. image:: on_premise/db_manager.gif
:align: center
When you duplicate a local database, it is **strongly** advised to change
the duplicated database's uuid (Unniversally Unique Identifier), since this
@@ -167,13 +155,14 @@ uuid is how your database identifies itself with our servers. Having two
databases with the same uuid could result in invoicing problems or registration
problems down the line.
.. note:: From July 2016 onward, Odoo 9 now automatically change the uuid of a
duplicated database; a manual operation is no longer required.
.. note::
From July 2016 onward, Odoo 9 now automatically change the uuid of a duplicated database; a
manual operation is no longer required.
The database uuid is currently accessible from the menu :menuselection:`Settings --> Technical -->
System Parameters`, we advise you to use a `uuid generator <https://www.uuidtools.com>`_ or to
use the unix command ``uuidgen`` to generate a new uuid. You can then simply replace it like any
other record by clicking on it and using the edit button.
.. image:: media/db_uuid.png
:align: center
.. image:: on_premise/db_uuid.png
:align: center

Before

Width:  |  Height:  |  Size: 9.5 KiB

After

Width:  |  Height:  |  Size: 9.5 KiB

Before

Width:  |  Height:  |  Size: 4.6 KiB

After

Width:  |  Height:  |  Size: 4.6 KiB

Before

Width:  |  Height:  |  Size: 89 KiB

After

Width:  |  Height:  |  Size: 89 KiB

Before

Width:  |  Height:  |  Size: 17 KiB

After

Width:  |  Height:  |  Size: 17 KiB

Before

Width:  |  Height:  |  Size: 6.9 KiB

After

Width:  |  Height:  |  Size: 6.9 KiB

Before

Width:  |  Height:  |  Size: 18 KiB

After

Width:  |  Height:  |  Size: 18 KiB

Before

Width:  |  Height:  |  Size: 14 KiB

After

Width:  |  Height:  |  Size: 14 KiB

@@ -5,13 +5,16 @@
Supported versions
==================
Odoo provides support and bug fixing **for the 3 last major versions** of Odoo.
Users hosted on **Odoo Online** may use intermediary versions (sometimes called *SaaS versions*) that are
supported as well. These versions are not published for Odoo.sh or On-Premise
installations.
.. note::
Odoo releases intermediary versions called **Online versions** on the :doc:`Odoo Online
<odoo_online>` hosting every two months. Odoo Online users can then benefit from the latest
features of Odoo.
- Admins of Odoo Online databases are invited to :doc:`upgrade <../upgrade>` them regularly.
- Online versions are *not* released for Odoo.sh and On-Premise installations.
- Online versions are listed below as *SaaS*.
What's the support status of my Odoo?
=====================================
@@ -20,38 +23,43 @@ This matrix shows the support status of every version.
**Major releases are in bold type.**
+--------------------+-------------+----------+--------------+----------------+----------------------------------------------+
| | Odoo Online | Odoo.sh | On-Premise | Release date | |
+====================+=============+==========+==============+================+==============================================+
| **Odoo 14.0** | |green| | |green| | |green| | October 2020 | |
+--------------------+-------------+----------+--------------+----------------+----------------------------------------------+
| Odoo 13.saas~4 | |green| | N/A | N/A | August 2019 | |
+--------------------+-------------+----------+--------------+----------------+----------------------------------------------+
| **Odoo 13.0** | |green| | |green| | |green| | October 2019 | |
+--------------------+-------------+----------+--------------+----------------+----------------------------------------------+
| Odoo 12.saas~3 | |green| | N/A | N/A | August 2019 | |
+--------------------+-------------+----------+--------------+----------------+----------------------------------------------+
| **Odoo 12.0** | |green| | |green| | |green| | October 2018 | *End-of-support is planned for October 2021* |
+--------------------+-------------+----------+--------------+----------------+----------------------------------------------+
| Odoo 11.saas~3 | |orange| | N/A | N/A | April 2018 | |
+--------------------+-------------+----------+--------------+----------------+----------------------------------------------+
| **Odoo 11.0** | |orange| | |orange| | |red| | October 2017 | |
+--------------------+-------------+----------+--------------+----------------+----------------------------------------------+
| Odoo 10.saas~15 | |orange| | N/A | N/A | March 2017 | |
+--------------------+-------------+----------+--------------+----------------+----------------------------------------------+
| Odoo 10.saas~14 | |orange| | N/A | N/A | January 2017 | |
+--------------------+-------------+----------+--------------+----------------+----------------------------------------------+
| **Odoo 10.0** | |orange| | |orange| | |red| | October 2016 | |
+--------------------+-------------+----------+--------------+----------------+----------------------------------------------+
| Odoo 9.saas~11 | |orange| | N/A | N/A | May 2016 | |
+--------------------+-------------+----------+--------------+----------------+----------------------------------------------+
| **Odoo 9.0** | |orange| | N/A | |red| | October 2015 | |
+--------------------+-------------+----------+--------------+----------------+----------------------------------------------+
| Odoo 8.saas~6 | |orange| | N/A | N/A | February 2015 | |
+--------------------+-------------+----------+--------------+----------------+----------------------------------------------+
| **Odoo 8.0** | |orange| | N/A | |red| | September 2014 | |
+--------------------+-------------+----------+--------------+----------------+----------------------------------------------+
+-----------------+-------------+----------+-------------+----------------+------------------------+
| | Odoo Online | Odoo.sh | On-Premise | Release date | End of support |
+=================+=============+==========+=============+================+========================+
| **Odoo 16.0** | |green| | |green| | |green| | October 2022 | October 2025 (planned) |
+-----------------+-------------+----------+-------------+----------------+------------------------+
| Odoo saas~15.2 | |green| | N/A | N/A | March 2022 | January 2023 |
+-----------------+-------------+----------+-------------+----------------+------------------------+
| Odoo saas~15.1 | |red| | N/A | N/A | February 2022 | July 2022 |
+-----------------+-------------+----------+-------------+----------------+------------------------+
| **Odoo 15.0** | |green| | |green| | |green| | October 2021 | October 2024 (planned) |
+-----------------+-------------+----------+-------------+----------------+------------------------+
| **Odoo 14.0** | |green| | |green| | |green| | October 2020 | October 2023 (planned) |
+-----------------+-------------+----------+-------------+----------------+------------------------+
| **Odoo 13.0** | |red| | |red| | |red| | October 2019 | October 2022 |
+-----------------+-------------+----------+-------------+----------------+------------------------+
| Odoo saas~12.3 | |red| | N/A | N/A | August 2019 | |
+-----------------+-------------+----------+-------------+----------------+------------------------+
| **Odoo 12.0** | |red| | |red| | |red| | October 2018 | October 2021 |
+-----------------+-------------+----------+-------------+----------------+------------------------+
| Odoo saas~11.3 | |red| | N/A | N/A | April 2018 | |
+-----------------+-------------+----------+-------------+----------------+------------------------+
| **Odoo 11.0** | |red| | |red| | |red| | October 2017 | October 2020 |
+-----------------+-------------+----------+-------------+----------------+------------------------+
| Odoo 10.saas~15 | |red| | N/A | N/A | March 2017 | |
+-----------------+-------------+----------+-------------+----------------+------------------------+
| Odoo 10.saas~14 | |red| | N/A | N/A | January 2017 | |
+-----------------+-------------+----------+-------------+----------------+------------------------+
| **Odoo 10.0** | |red| | |red| | |red| | October 2016 | October 2019 |
+-----------------+-------------+----------+-------------+----------------+------------------------+
| Odoo 9.saas~11 | |red| | N/A | N/A | May 2016 | |
+-----------------+-------------+----------+-------------+----------------+------------------------+
| **Odoo 9.0** | |red| | N/A | |red| | October 2015 | October 2018 |
+-----------------+-------------+----------+-------------+----------------+------------------------+
| Odoo 8.saas~6 | |red| | N/A | N/A | February 2015 | |
+-----------------+-------------+----------+-------------+----------------+------------------------+
| **Odoo 8.0** | |red| | N/A | |red| | September 2014 | October 2017 |
+-----------------+-------------+----------+-------------+----------------+------------------------+
.. note::
@@ -61,19 +69,15 @@ This matrix shows the support status of every version.
N/A Never released for this platform
|orange| Some of our older customers may still run this version on our Odoo Online servers, we provide help only on blocking issues and advise you to upgrade.
🏁 Future version, not released yet
.. |green| raw:: html
.. |green| image:: data:image/svg+xml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHZpZXdCb3g9IjAgMCAyMzIuMTkgMjMyLjE5Ij48Y2lyY2xlIGN4PSIxMTYuMDkiIGN5PSIxMTYuMDkiIHI9IjExNi4wOSIgc3R5bGU9ImZpbGw6IzAwYTcwMCIvPjwvc3ZnPg==
:width: 15
<span class="text-success" style="font-size: 32px; line-height: 0.5">●</span>
.. |red| image:: data:image/svg+xml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHZpZXdCb3g9IjAgMCAyMzIuMTkgMjMyLjE5Ij48Y2lyY2xlIGN4PSIxMTYuMDkiIGN5PSIxMTYuMDkiIHI9IjExNi4wOSIgc3R5bGU9ImZpbGw6I2QwMDAwMCIvPjwvc3ZnPg==
:width: 15
.. |red| raw:: html
.. |orange| image:: data:image/svg+xml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHZpZXdCb3g9IjAgMCAyMzIuMTkgMjMyLjE5Ij48Y2lyY2xlIGN4PSIxMTYuMDkiIGN5PSIxMTYuMDkiIHI9IjExNi4wOSIgc3R5bGU9ImZpbGw6I2ZmYTcwMCIvPjwvc3ZnPg==
:width: 15
<span class="text-danger" style="font-size: 32px; line-height: 0.5">●</span>
I run an older version of Odoo/OpenERP/TinyERP
==============================================
@@ -104,6 +104,7 @@ and you're all set.
Source Install (Tarball)
------------------------
If you have originally installed Odoo with the "tarball" version (source code archive), you have
to replace the installation directory with a newer version. First download the latest tarball
from Odoo.com. They are updated daily and include the latest security fixes (see step #1)
@@ -123,6 +124,7 @@ Finally, restart the Odoo service or reboot the machine, and you are all set.
Source Install (Github)
-----------------------
If you have originally installed Odoo with a full Github clone of the official repositories, the
update procedure requires you to pull the latest source code via git.
Change into the directory for each repository (the main Odoo repository, and the Enterprise
+2 -3
View File
@@ -1,13 +1,12 @@
:nosearch:
=================
========
Advanced
=================
========
.. toctree::
:titlesonly:
advanced/containers
advanced/submodules
advanced/upgrade_your_database
advanced/frequent_technical_questions
@@ -1,7 +1,7 @@
==================================
==========
Containers
==================================
==========
Overview
========
@@ -17,7 +17,7 @@ The platform will take care to install these dependencies in your containers.
`The pip requirements specifiers <https://pip.pypa.io/en/stable/reference/pip_install/#requirement-specifiers>`_
documentation can help you write a :file:`requirements.txt` file.
To have a concrete example,
check out the `requirements.txt file of Odoo <https://github.com/odoo/odoo/blob/14.0/requirements.txt>`_.
check out the `requirements.txt file of Odoo <{GITHUB_PATH}/requirements.txt>`_.
The :file:`requirements.txt` files of submodules are taken into account as well. The platform
looks for :file:`requirements.txt` files in each folder containing Odoo modules: Not in the module folder itself,
@@ -167,16 +167,16 @@ In the above commands, the argument:
* ``--stop-after-init`` will immediately shutdown the server instance after it completed the operations you asked.
More options are available and detailed in the
:doc:`CLI documentation </developer/misc/other/cmdline>`.
:doc:`CLI documentation </developer/cli>`.
You can find in the logs (*~/logs/odoo.log*) the addons path used by Odoo.sh to run your server.
Look for "*odoo: addons paths*":
::
2018-02-19 10:51:39,267 4 INFO ? odoo: Odoo version 13.0
2018-02-19 10:51:39,267 4 INFO ? odoo: Odoo version {BRANCH}
2018-02-19 10:51:39,268 4 INFO ? odoo: Using configuration file at /home/odoo/.config/odoo/odoo.conf
2018-02-19 10:51:39,268 4 INFO ? odoo: addons paths: ['/home/odoo/data/addons/13.0', '/home/odoo/src/user', '/home/odoo/src/enterprise', '/home/odoo/src/themes', '/home/odoo/src/odoo/addons', '/home/odoo/src/odoo/odoo/addons']
2018-02-19 10:51:39,268 4 INFO ? odoo: addons paths: ['/home/odoo/data/addons/{BRANCH}', '/home/odoo/src/user', '/home/odoo/src/enterprise', '/home/odoo/src/themes', '/home/odoo/src/odoo/addons', '/home/odoo/src/odoo/odoo/addons']
**Be careful**, especially with your production database.
Operations that you perform running this Odoo server instance are not isolated:
@@ -232,6 +232,6 @@ Save the file and then run the Odoo Shell:
Finally, *via* the Odoo Shell, you can trigger the piece of code/function/method
you want to debug.
.. image:: ./media/pdb_sh.png
.. image:: containers/pdb_sh.png
:align: center
:alt: Console screenshot showing ``pdb`` running in an Odoo.sh shell.

Before

Width:  |  Height:  |  Size: 72 KiB

After

Width:  |  Height:  |  Size: 72 KiB

@@ -1,9 +1,9 @@
.. _odoosh-advanced-frequent_technical_questions:
==================================
============================
Frequent Technical Questions
==================================
============================
"Scheduled actions do not run at the exact time they were expected"
-------------------------------------------------------------------
@@ -29,4 +29,3 @@ We advise that:
- Your scheduled actions should be
`idempotent <https://stackoverflow.com/a/1077421/3332416>`_: they must not
cause side-effects if they are started more often than expected.
@@ -1,9 +1,9 @@
.. _odoosh-advanced-submodules:
==================================
==========
Submodules
==================================
==========
Overview
========
@@ -44,7 +44,7 @@ On Odoo.sh, in the branches view of your project, choose the branch in which you
In the upper right corner, click on the *Submodule* button, and then on *Run*.
.. image:: ./media/advanced-submodules-button.png
.. image:: submodules/advanced-submodules-button.png
:align: center
A dialog with a form is shown. Fill the inputs as follows:
@@ -53,18 +53,18 @@ A dialog with a form is shown. Fill the inputs as follows:
* Branch: The branch you want to use.
* Path: The folder in which you want to add this submodule in your branch.
.. image:: ./media/advanced-submodules-dialog.png
.. image:: submodules/advanced-submodules-dialog.png
:align: center
On Github, you can get the repository URL with the *Clone or download* button of the repository. Make sure to *use SSH*.
.. image:: ./media/advanced-submodules-github-sshurl.png
.. image:: submodules/advanced-submodules-github-sshurl.png
:align: center
.. _odoosh-advanced-submodules-withgit:
With Git (advanced)
---------------------
-------------------
In a terminal, in the folder where your Git repository is cloned,
checkout the branch in which you want to add a submodule:
@@ -1,48 +0,0 @@
=====================
Upgrade your database
=====================
.. _odoosh-advanced-upgrade_your_database:
Download and Upload your database
=================================
Download a dump of your database (from the :ref:`Builds view <odoosh-gettingstarted-builds-download-dump>`), choose the
exact copy and without filestore options. Upload the .sql.gz dump on https://upgrade.odoo.com/upload and
select the Testing Purpose. If you have custom code, you can choose to have it upgraded by us, or do it yourself. Once
it's processed, you'll get a dump of the database in return.
.. warning::
Do *not* upload *backups* of your production database (found in the Backups tab of the production branch) as these
are incompatible with the Upgrade platform - they contain your complete sources, etc. that are not needed for the
upgrade. Make sure to download a **Dump** instead - either through the Backups tab using the *Download Dump* button
or through the Builds page by using the *Download Dump* entry of the contextual menu of your latest production build.
Test your upgraded database
===========================
Create a staging branch that will run the upgraded database. Either make sure your production branch's code is
compatible between the two Odoo versions and fork your production branch, or make a new staging branch containing
the upgraded code.
Once the staging build is done (it doesn't matter if it failed due to the version incompatibility), import your
upgraded dump in the backups tab of the branch. The platform will automatically detect the version of the dump and
change the version of Odoo's source code to the corresponding version for the build.
Test the upgraded database and make sure everything runs as it's supposed to.
Replace your existing production database
=========================================
Once you've tested everything and you're satisfied, start the process over to get an up-to-date upgraded dump:
* Make a new dump of your production database (as described in step 1)
* Upload it on upgrade.odoo.com and select the Production purpose
* Receive the newly upgraded dump and import it in your production branch. The build might get marked as failed because
the platform will run it with the upgraded databases' Odoo version together with the old custom code.
* Merge or commit the upgraded custom code in the production branch
If anything goes wrong, remember you can restore a backup. The platform will always make one before you make any
Odoo.sh operation on the production database. If the restored backup comes from a previous version, the platform will
detect it and change the project's Odoo version back if it needs to.
@@ -1,8 +1,8 @@
:nosearch:
=================
===========
Get started
=================
===========
.. toctree::
:titlesonly:
@@ -1,32 +1,32 @@
==================================
========
Branches
==================================
========
Overview
========
The branches view gives you an overview of the different branches your repository has.
.. image:: ./media/interface-branches.png
.. image:: branches/interface-branches.png
:align: center
.. _odoosh-gettingstarted-branches-stages:
Stages
===============
======
Odoo.sh offers three different stages for your branches: production, staging and development.
You can change the stage of a branch by drag and dropping it into the stage section title.
.. image:: ./media/interface-branches-stagechange.png
.. image:: branches/interface-branches-stagechange.png
:align: center
.. _stage_production:
Production
----------
This is the branch holding the code on which your production database runs.
There can be only one production branch.
@@ -42,7 +42,7 @@ instance will be held temporarily unavailable for maintenance reason.
This method is equivalent to perform an upgrade of the module through the Apps menu,
or through the :code:`-u` switch of
:doc:`the command line </developer/misc/other/cmdline>`.
:doc:`the command line </developer/cli>`.
In the case the changes in the commit prevent the server to restart,
or if the modules update fails,
@@ -59,6 +59,7 @@ will automatically be set back to the development stage after 30 days.
Staging
-------
Staging branches are meant to test your new features using the production data without compromising
the actual production database with test records. They will create databases that are neutralized
duplicates of the production database.
@@ -83,9 +84,9 @@ The unit tests are not performed as, in Odoo, they currently rely on the demo da
production database. In the future, if Odoo supports to run the unit tests without the demo data,
Odoo.sh will then consider running the tests on staging databases.
Development
-----------
Development branches create new databases using the demo data to run the unit tests.
The installed modules are the ones included in your branches. You can change this list of modules
to install in your :ref:`project Settings <odoosh-gettingstarted-settings-modules-installation>`.
@@ -107,9 +108,10 @@ After that, they can be automatically garbage collected to make room for new dat
Merging your branches
---------------------
You can merge your branches easily by drag and dropping them into each other.
.. image:: ./media/interface-branches-merge.png
.. image:: branches/interface-branches-merge.png
:align: center
When you want to test the changes of your development branches with the production data,
@@ -147,16 +149,17 @@ If you test configuration changes in staging branches, and want them to be appli
.. _odoosh-gettingstarted-branches-tabs:
Tabs
=============
====
History
-------
An overview of your branch history:
* The messages of the commits and their authors,
* The various events linked to the platform, such as stage changes, database imports, backup restores.
.. image:: ./media/interface-branches-history.png
.. image:: branches/interface-branches-history.png
:align: center
For each event, a status is displayed in the top right-hand corner.
@@ -168,36 +171,38 @@ When an operation is successful, you can access the database thanks to the *conn
Mails
-----
This tab contains the mail catcher. It displays an overview of the emails sent by your database.
The mail catcher is available for your development and
staging branches as the emails of your production database are really sent instead of being intercepted.
.. image:: ./media/interface-branches-mails.png
.. image:: branches/interface-branches-mails.png
:align: center
:scale: 50%
Shell
-----
A shell access to your container. You can perform basic linux commands (:code:`ls`, :code:`top`)
and open a shell on your database by typing :code:`psql`.
.. image:: ./media/interface-branches-shell.png
.. image:: branches/interface-branches-shell.png
:align: center
You can open multiple tabs and drag-and-drop them to arrange the layout as you wish,
for instance side by side.
.. Note::
Long running shell instances are not guaranteed. Idle shells can be
disconnected at anytime in order to free up resources.
Editor
------
An online integrated development environment (IDE) to edit the source code.
You can also open terminals, Python consoles and even Odoo Shell consoles.
.. image:: ./media/interface-branches-editor.png
.. image:: branches/interface-branches-editor.png
:align: center
You can open multiple tabs and drag-and-drop them to arrange the layout as you wish,
@@ -205,19 +210,23 @@ for instance side by side.
Monitoring
----------
This link contains various monitoring metrics of the current build.
.. image:: ./media/interface-branches-monitoring.png
.. image:: branches/interface-branches-monitoring.png
:align: center
You can zoom, change the time range or select a specific metric on each graph.
On the graphs, annotations help you relate to changes on the build (database import, git push, etc...).
.. _odoosh/logs:
Logs
----
A viewer to have a look to your server logs.
.. image:: ./media/interface-branches-logs.png
.. image:: branches/interface-branches-logs.png
:align: center
Different logs are available:
@@ -238,10 +247,11 @@ The fetching is automatically stopped after 5 minutes. You can restart it using
Backups
-------
A list of the backups available for download and restore, the ability to perform a manual backup and to import a
database.
.. image:: ./media/interface-branches-backups.png
.. image:: branches/interface-branches-backups.png
:align: center
Odoo.sh makes daily backups of the production database. It keeps 7 daily, 4 weekly and 3 monthly backups.
@@ -257,16 +267,16 @@ This server only keeps one month of backups: 7 daily and 4 weekly backups.
Dedicated backup servers keep the same backups, as well as 3 additional monthly backups.
To restore or download one of these monthly backups, please `contact us <https://www.odoo.com/help>`_.
If you merge a commit updating the version of one or several modules (in :file:`__manifest__.py`), or their linked python
dependencies (in :file:`requirements.txt`), then Odoo.sh performs a backup automatically (flagged with type Update in the list),
as either the container will be changed by the installation of new pip packages, either the database itself will be
changed with the module update triggered afterwards. In these two cases, we are doing a backup as it may potentially
If you merge a commit updating the version of one or several modules (in :file:`__manifest__.py`), or their linked python
dependencies (in :file:`requirements.txt`), then Odoo.sh performs a backup automatically (flagged with type Update in the list),
as either the container will be changed by the installation of new pip packages, either the database itself will be
changed with the module update triggered afterwards. In these two cases, we are doing a backup as it may potentially
break things.
If you merge a commit that only changes some code without the above-mentioned modifications, then no backup is done
by Odoo.sh, as neither the container nor the database is modified so the platform considers this safe enough. Of course,
as an extra precaution, you can make a backup manually before making big changes in your production sources in case
something goes wrong (those manual backups are available for about one week). To avoid abuse, we limit manual backups
If you merge a commit that only changes some code without the above-mentioned modifications, then no backup is done
by Odoo.sh, as neither the container nor the database is modified so the platform considers this safe enough. Of course,
as an extra precaution, you can make a backup manually before making big changes in your production sources in case
something goes wrong (those manual backups are available for about one week). To avoid abuse, we limit manual backups
to 5 per day.
The *import database* feature accepts database archives in the format provided by:
@@ -277,13 +287,24 @@ The *import database* feature accepts database archives in the format provided b
* the Odoo.sh backup download button of this *Backups* tab,
* the Odoo.sh dump download button in the :ref:`Builds view <odoosh-gettingstarted-builds>`.
.. _odoo_sh/upgrade:
Upgrade
-------
Available for production and staging branches for valid projects.
.. seealso::
:doc:`Upgrade - Odoo.sh <../../upgrade/odoo_sh>`
.. _odoosh-gettingstarted-branches-tabs-settings:
Settings
--------
Here you can find a couple of settings that only apply to the currently selected branch.
.. image:: ./media/interface-branches-settings.jpg
.. image:: branches/interface-branches-settings.jpg
:align: center
**Behaviour upon new commit**
@@ -300,7 +321,7 @@ back from staging to development will automatically be set to 'Do nothing'.
Choose the modules to install automatically for your development builds.
.. image:: ./media/interface-settings-modulesinstallation.png
.. image:: branches/interface-settings-modulesinstallation.png
:align: center
* *Install only my modules* will install the modules of the branch only. This is the default option.
@@ -382,18 +403,19 @@ we are considering the feature if there is enough demand.
In case the domain of your users email addresses use SPF (Sender Policy Framework) or DKIM
(DomainKeys Identified Mail), don't forget to authorize Odoo as a sending host in your domain name
settings to increase the deliverability of your outgoing emails.
The configuration steps are explained in the :ref:`Discuss app documentation <discuss-email_servers-spf-compliant>`.
The configuration steps are explained in the documentation about :ref:`SPF
<email_communication/spf_compliant>` and :ref:`DKIM <email_communication/dkim_compliant>`.
.. Warning::
Forgetting to configure your SPF or DKIM to authorize Odoo as a sending host can lead to the
delivery of your emails as spam in your contacts inbox.
Shell commands
==============
In the top right-hand corner of the view, different shell commands are available.
.. image:: ./media/interface-branches-shellcommands.png
.. image:: branches/interface-branches-shellcommands.png
:align: center
Each command can be copied in the clipboard to be used in a terminal,
@@ -403,6 +425,7 @@ such as ``<URL>``, ``<PATH>``, ...
Clone
-----
Download the Git repository.
.. code-block:: bash
@@ -418,6 +441,7 @@ The *run* button is not available for this command, as it is meant to be used on
Fork
----
Create a new branch based on the current branch.
.. code-block:: bash
@@ -434,6 +458,7 @@ Uploads the new branch *feature-1* on your remote repository.
Merge
-----
Merge the current branch in another branch.
.. code-block:: bash
@@ -450,8 +475,10 @@ Uploads the changes you just added in the *master* branch on your remote reposit
SSH
---
Setup
~~~~~
In order to use SSH, you have to set up your profile SSH public key (if it is not already done).
To do so, follow these steps:
@@ -462,12 +489,12 @@ To do so, follow these steps:
(only apply the step 1)
#. Paste the copied content to your profile SSH keys and press "Add"
.. image:: ./media/SSH-key-pasting.png
.. image:: branches/SSH-key-pasting.png
:align: center
#. The key should appear below
.. image:: ./media/SSH-key-appearing.png
.. image:: branches/SSH-key-appearing.png
:align: center
Connection
@@ -481,7 +508,7 @@ To connect to your builds using ssh use the following command in a terminal:
You will find a shortcut for this command into the SSH tab in the upper right corner.
.. image:: ./media/SSH-panel.png
.. image:: branches/SSH-panel.png
:align: center
Provided you have the :ref:`correct access rights <odoosh-gettingstarted-settings-collaborators>` on the project,
@@ -491,7 +518,6 @@ you'll be granted ssh access to the build.
Long running ssh connections are not guaranteed. Idle connections will be
disconnected in order to free up resources.
Submodule
---------

Before

Width:  |  Height:  |  Size: 6.1 KiB

After

Width:  |  Height:  |  Size: 6.1 KiB

Before

Width:  |  Height:  |  Size: 23 KiB

After

Width:  |  Height:  |  Size: 23 KiB

Before

Width:  |  Height:  |  Size: 4.7 KiB

After

Width:  |  Height:  |  Size: 4.7 KiB

@@ -1,19 +1,20 @@
.. _odoosh-gettingstarted-builds:
==================================
======
Builds
==================================
======
Overview
========
In Odoo.sh, a build is considered as a database loaded by an Odoo server
(`odoo/odoo <https://github.com/odoo/odoo>`_ & `odoo/enterprise <https://github.com/odoo/enterprise>`_)
running on a specific revision of your project repository in a containerized environment.
Its purpose is to test the well-behavior of the server, the database and the features with this revision.
(`odoo/odoo <https://github.com/odoo/odoo>`_ & `odoo/enterprise
<https://github.com/odoo/enterprise>`_) running on a specific revision of your project repository in
a containerized environment. Its purpose is to test the well-behavior of the server, the database
and the features with this revision.
.. image:: ./media/interface-builds.png
.. image:: builds/interface-builds.png
:align: center
In this view, a row represents a branch, and a cell of a row represents a build of this branch.
@@ -28,13 +29,13 @@ A successful build is highlighted in green.
A build is considered failed if errors come up during its creation.
A failed build is highlighted in red.
If warnings come up during the creation, but there are no errors, the build is considered almost successful.
It is highlighted in yellow to notify the developer warnings were raised.
If warnings come up during the creation, but there are no errors, the build is considered almost
successful. It is highlighted in yellow to notify the developer warnings were raised.
Builds do not always create a database from scratch.
For instance, when pushing a change on the production branch, the build created just starts the server
with your new revision and tries to load the current production database on it.
If no errors come up, the build is considered successful, and otherwise failed.
Builds do not always create a database from scratch. For instance, when pushing a change on the
production branch, the build created just starts the server with your new revision and tries to load
the current production database on it. If no errors come up, the build is considered successful, and
otherwise failed.
Stages
======
@@ -48,14 +49,15 @@ If this build is successful, this database is considered as the production datab
From then, pushes on the production branch will create new builds that attempt to load the database
using a server running with the new revision.
If the build is successful, or has warnings but no errors, the production database will now run with this build, along
with the revision associated to this build.
If the build is successful, or has warnings but no errors, the production database will now run with
this build, along with the revision associated to this build.
If the build fails to load or update the database, then the previous successful build is re-used to load the database,
and therefore the database will run using a server running with the previous successful revision.
If the build fails to load or update the database, then the previous successful build is re-used to
load the database, and therefore the database will run using a server running with the previous
successful revision.
The build used to run the production database is always the first of the builds list. If a build fails, it is
put after the build currently running the production database.
The build used to run the production database is always the first of the builds list. If a build
fails, it is put after the build currently running the production database.
Staging
-------
@@ -63,18 +65,17 @@ Staging
Staging builds duplicate the production database,
and try to load this duplicate with the revisions of the staging branches.
Each time you push a new revision on a staging branch, the build created uses a new copy of the production database.
The databases are not re-used between builds of the same branch. This ensures:
Each time you push a new revision on a staging branch, the build created uses a new copy of the
production database. The databases are not re-used between builds of the same branch. This ensures:
* staging builds use databases that are close to what the production looks like,
so you do not make your tests with outdated data,
* staging builds use databases that are close to what the production looks like, so you do not make
your tests with outdated data,
* you can play around as much as you want in the same staging database,
and you can then ask for a rebuild when you want to restart with a new copy of the production.
* you can play around as much as you want in the same staging database, and you can then ask for a
rebuild when you want to restart with a new copy of the production.
Nevertheless, this means that if you make configuration changes in staging databases
and do not apply them in the production,
they will not be passed on the next build of the same staging branch.
Nevertheless, this means that if you make configuration changes in staging databases and do not
apply them in the production, they will not be passed on the next build of the same staging branch.
Development
-----------
@@ -86,38 +87,38 @@ as they are meant to raise errors if something wrong occurs.
If all tests pass, and there is no error, the build will be considered successful.
According to the list of modules to install and test, a development build can take up to 1 hour to be ready.
This is due to the large number of tests set in the default Odoo modules suite.
According to the list of modules to install and test, a development build can take up to 1 hour to
be ready. This is due to the large number of tests set in the default Odoo modules suite.
Features
========
The production branch will always appear first,
and then the other branches are ordered by last build created. You can filter out the branches.
The production branch will always appear first, and then the other branches are ordered by last
build created. You can filter out the branches.
.. image:: ./media/interface-builds-branches.png
.. image:: builds/interface-builds-branches.png
:align: center
For each branch, you can access the last build's database using the *Connect* link and jump to the branch code using
the *Github* link. For other branches than the production, you can create a new build which will use the latest revision
of the branch using the link *rebuild*. This last link is not available when there is already a build in progress for
the branch.
For each branch, you can access the last build's database using the *Connect* link and jump to the
branch code using the *Github* link. For other branches than the production, you can create a new
build which will use the latest revision of the branch using the link *rebuild*. This last link is
not available when there is already a build in progress for the branch.
.. image:: ./media/interface-builds-build.png
.. image:: builds/interface-builds-build.png
:align: center
For each build, you can access the revision changes using the button with the Github icon.
You can access the build's database as the administrator using the *Connect* button.
Also, you can access the database with another user using the *Connect as* button,
in the dropdown menu of the *Connect* button.
For each build, you can access the revision changes using the button with the Github icon. You can
access the build's database as the administrator using the *Connect* button. Also, you can access
the database with another user using the *Connect as* button, in the dropdown menu of the *Connect*
button.
.. _odoosh-gettingstarted-builds-download-dump:
.. image:: ./media/interface-builds-build-dropdown.png
.. image:: builds/interface-builds-build-dropdown.png
:align: center
.. _odoosh-gettingstarted-builds-dropdown-menu:
In the dropdown menu of the build, you can access the same features than in :ref:`the branches view <odoosh-gettingstarted-branches-tabs>`:
*Logs*, *Web Shell*, *Editor*, *Outgoing e-mails*.
You also have the possibility to *Download a dump* of the build's database.
In the dropdown menu of the build, you can access the same features than in :ref:`the branches view
<odoosh-gettingstarted-branches-tabs>`: *Logs*, *Web Shell*, *Editor*, *Outgoing e-mails*. You also
have the possibility to *Download a dump* of the build's database.

Some files were not shown because too many files have changed in this diff Show More