Compare commits

...

238 Commits

Author SHA1 Message Date
Alvaro Fuentes f7407ebae9 [FIX] config: werkzeug 1.0.x docs are no longer online
```
❯ curl -sw '%{http_code}\n' -o /dev/null https://werkzeug.palletsprojects.com/en/1.0.x/
404

❯ curl -sw '%{http_code}\n' -o /dev/null https://werkzeug.palletsprojects.com/en/2.0.x/
200
```

closes odoo/documentation#5219

Related: odoo/enterprise#44640
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2023-07-27 12:23:39 +02:00
Odoo Translation Bot cbc3b8e38d [I18N] Update translation terms from Transifex 2023-01-22 02:40:12 +01:00
Odoo Translation Bot 1d3065fcab [I18N] Update translation terms from Transifex 2023-01-15 02:40:12 +01:00
Odoo Translation Bot 88d0554331 [I18N] Update translation terms from Transifex 2023-01-08 02:40:14 +01:00
Odoo Translation Bot cb9f65b63f [I18N] Update translation terms from Transifex 2023-01-01 02:40:15 +01:00
Odoo Translation Bot 7e62ec190b [I18N] Update translation terms from Transifex 2022-12-25 02:40:16 +01:00
Odoo Translation Bot da0c547c69 [I18N] Update translation terms from Transifex 2022-12-18 02:40:11 +01:00
Odoo Translation Bot 42e394fc5b [I18N] Update translation terms from Transifex 2022-12-11 02:40:10 +01:00
Odoo Translation Bot c023cb4381 [I18N] Update translation terms from Transifex 2022-11-27 02:40:15 +01:00
Odoo Translation Bot 6f60d2b8b7 [I18N] Update translation terms from Transifex 2022-11-20 02:40:15 +01:00
Loan (lse) 21edc4fcc7 [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#2730

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-11-14 09:35:38 +01:00
Odoo Translation Bot f71ad61221 [I18N] Update translation terms from Transifex 2022-11-13 02:40:15 +01:00
Odoo Translation Bot 137b107016 [I18N] Update translation terms from Transifex 2022-10-30 02:40:21 +02:00
Odoo Translation Bot d1879e91b8 [I18N] Update translation terms from Transifex 2022-10-23 02:40:16 +02:00
Odoo Translation Bot ba71ee7aa3 [I18N] Update translation terms from Transifex 2022-10-16 02:40:18 +02:00
Olivier Dony 166198cf8b [CHG] legal: enterprise terms for fall 2022 pricing
- removal of "per app" notion
- addition of "subscription plan" notion
2022-10-13 12:13:21 +02:00
Antoine Vandevenne (anv) 3c61d24b1d [IMP] supported_version: release 16.0 and deprecate 13.0
closes odoo/documentation#2808

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-10-11 18:31:47 +02:00
Odoo Translation Bot 32d8485fbc [I18N] Update translation terms from Transifex 2022-10-09 02:40:23 +02:00
Odoo Translation Bot a1920e9bfe [I18N] Update translation terms from Transifex 2022-10-02 02:40:25 +02:00
Odoo Translation Bot 3f9692102e [I18N] Update translation terms from Transifex 2022-09-25 02:40:28 +02:00
Fabrice Henrion dad110c7cc [FIX] accounting: grammar fix in ponto
closes odoo/documentation#2753

Signed-off-by: Castillo Jonathan (jcs) <jcs@odoo.com>
2022-09-23 09:35:07 +02:00
Jonathan Quique (jqu) d1317812e1 [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#2075

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-09-20 17:03:47 +02:00
Martin Trigaux b407bd53c0 [I18N] *: export 13.0 source terms 2022-09-19 16:11:51 +02:00
Odoo Translation Bot f321410b74 [I18N] Update translation terms from Transifex 2022-09-18 02:40:40 +02:00
Xavier 1d48967962 [ADD] accounting: data inalterability check report
Task ID: 2977343

closes odoo/documentation#2703

Signed-off-by: Victor Feyens (vfe) <vfe@odoo.com>
2022-09-13 10:49:24 +02:00
Odoo Translation Bot 770769955c [I18N] Update translation terms from Transifex 2022-09-11 02:40:39 +02:00
Valentin Vallaeys (vava) 8061470577 [FIX] coding_guidelines: fix typos and add sql contraints
task-2977263

closes odoo/documentation#2696

Signed-off-by: Victor Feyens (vfe) <vfe@odoo.com>
2022-09-08 13:23:20 +02:00
Jonathan Castillo (jcs) 9089a78602 [IMP] install/maintain: add note about mailboxes in domain_names
task-2973080

closes odoo/documentation#2675

Signed-off-by: Castillo Jonathan (jcs) <jcs@odoo.com>
2022-09-05 12:13:42 +02:00
Odoo Translation Bot f8a750b0eb [I18N] Update translation terms from Transifex 2022-09-04 02:40:38 +02:00
frin-odoo f39a43f697 [IMP] crm: grammar on google_spreadsheets
closes odoo/documentation#1844

Signed-off-by: Castillo Jonathan (jcs) <jcs@odoo.com>
2022-09-02 13:02:45 +02:00
Martin Trigaux b24ce6463d [I18N] *: export 13.0 source terms 2022-09-01 14:28:46 +02:00
William Henrotin 1a10dced12 [FIX] inventory: fix typo
closes odoo/documentation#1842

Signed-off-by: Castillo Jonathan (jcs) <jcs@odoo.com>
2022-08-31 13:43:51 +02:00
Tom Aarab (toaa) 4b9517ead1 [IMP] accounting: stripe page update
Ambiguous note which implied local payment methods were supported even if not listed.

Forward up to V14, create new for V15.

task id: 2942093

closes odoo/documentation#2635

Signed-off-by: Castillo Jonathan (jcs) <jcs@odoo.com>
2022-08-26 16:16:23 +02:00
Jonathan Castillo (jcs) a8e6e6c23b [FIX] accounting: new tutorial link in payment_terms
task-2963526

closes odoo/documentation#2629

Signed-off-by: Castillo Jonathan (jcs) <jcs@odoo.com>
2022-08-26 10:06:11 +02:00
Tom Aarab (toaa) bc7c65fbf6 [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#2619

Signed-off-by: Castillo Jonathan (jcs) <jcs@odoo.com>
2022-08-23 14:43:32 +02:00
Odoo Translation Bot cbfd6d6ba1 [I18N] Update translation terms from Transifex 2022-08-21 02:40:14 +02:00
Julian Roussieau f52be8da2a [FIX] odoo_sh: change img who explain storage space
closes odoo/documentation#2607

Signed-off-by: Castillo Jonathan (jcs) <jcs@odoo.com>
2022-08-19 08:52:09 +02:00
Moens Alexandre a92671bd85 [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#2583

Signed-off-by: Castillo Jonathan (jcs) <jcs@odoo.com>
2022-08-18 10:54:52 +02:00
Jonathan Castillo (jcs) 81a23de57d [FIX] iot: typo in devices/scale
task-2956495

closes odoo/documentation#2593

Signed-off-by: Castillo Jonathan (jcs) <jcs@odoo.com>
2022-08-18 09:16:54 +02:00
Antoine Vandevenne (anv) 80a9cfb68f [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#2543

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-08-17 14:11:03 +02:00
Odoo Translation Bot eb5f98d4d0 [I18N] Update translation terms from Transifex 2022-08-14 02:40:16 +02:00
Odoo Translation Bot e8aadf2b88 [I18N] Update translation terms from Transifex 2022-08-07 02:40:20 +02:00
Wesley Kao (weka) 8c665643ce [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#2560

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-08-05 11:09:40 +02:00
Odoo Translation Bot 0129170503 [I18N] Update translation terms from Transifex 2022-07-31 02:40:14 +02:00
Odoo Translation Bot f0234ed947 [I18N] Update translation terms from Transifex 2022-07-24 02:40:18 +02:00
Stanislas Sobieski 815acb64c4 [IMP] install/maintain: update info about upgrade process on Odoo.sh
closes odoo/documentation#2426

Id: 2744270
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
Co-authored-by: Stanislas <sts@odoo.com>
Co-authored-by: Donatienne <dopi@odoo.com>
2022-07-18 10:34:20 +02:00
Odoo Translation Bot fab6d933c7 [I18N] Update translation terms from Transifex 2022-07-17 02:40:16 +02:00
Victor Feyens 6402988ed9 [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

closes odoo/documentation#2349

Signed-off-by: Victor Feyens (vfe) <vfe@odoo.com>
2022-07-14 16:39:58 +02:00
Sam Lieber (sali) 9b75dfd2ac [ADD] maintain: google oauth doc
Added document and media files on the setup of Google Gmail using OAuth with Odoo.

closes odoo/documentation#2274

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-07-13 17:09:55 +02:00
Antoine Vandevenne (anv) c1c16ea388 [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#2438

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-07-13 11:53:26 +02:00
Antoine Vandevenne (anv) c6b0c1f60d [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.

Part-of: odoo/documentation#2438
Co-authored-by: Elisabeth Dickinson (edi) <edi@odoo.com>
2022-07-13 11:53:25 +02:00
Antoine Vandevenne (anv) d9a8f7b4ab [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

Part-of: odoo/documentation#2438
2022-07-13 11:53:25 +02:00
Antoine Vandevenne (anv) 5e0f14f683 [FIX] odoo_theme: fix the display of modal images in mobile
task-2908330

closes odoo/documentation#2439

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-07-12 13:32:02 +02:00
Romain Derie 2222142127 [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#2382

Related: odoo/odoo#95232
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-07-12 13:31:54 +02:00
Antoine Vandevenne (anv) 2481e3d842 [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#2431

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-07-11 11:52:10 +02:00
Odoo Translation Bot 4b5a6c5682 [I18N] Update translation terms from Transifex 2022-07-10 02:40:15 +02:00
“Lau-Odoo” 7307dac6a6 [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#2384

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-07-07 15:01:42 +02:00
LoredanaLrpz 7ba4af1e99 [IMP] pos: add a warning about Six unusability in July
Task ID:3835
Since Six payment terminal won't be usable starting in July 2022, I
added this warning.

closes odoo/documentation#2387

Signed-off-by: Castillo Jonathan (jcs) <jcs@odoo.com>
2022-07-07 14:07:41 +02:00
Demesmaeker 471d0c2094 [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#2366

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-07-07 10:30:14 +02:00
Odoo Translation Bot 8bf569fd1a [I18N] Update translation terms from Transifex 2022-07-03 02:40:13 +02:00
“Lau-Odoo” c40059e0a7 [IMP] website: broken link removal
task - 2841794

closes odoo/documentation#2351

Signed-off-by: Auvens Ludvig (lau) <lau@odoo.com>
2022-07-01 10:34:42 +02:00
Antoine Vandevenne (anv) ad374af15d [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#2337

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-06-30 16:12:41 +02:00
Antoine Vandevenne (anv) 120ae78553 [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#2324

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-06-27 17:05:05 +02:00
Odoo's Mergebot 934f45cf4d [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#2264

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-06-27 14:35:22 +02:00
Elisabeth Dickinson c82d95b17c [REF] odoo_theme: replace values with variables in SCSS files 2022-06-27 14:24:54 +02:00
Elisabeth Dickinson 7fa153594d [REF] odoo_theme: move stray mixins into the _mixins.scss file 2022-06-27 14:24:54 +02:00
Elisabeth Dickinson fca78f44db [CLN] odoo_theme: remove unnecessary css 2022-06-27 14:24:54 +02:00
Elisabeth Dickinson 383e3d4206 [CLN] odoo_theme: remove old doc's unused variables 2022-06-27 14:24:54 +02:00
Elisabeth Dickinson b9ca38215d [REF] odoo_theme: move scrollbar styling to .o_side_nav-inner 2022-06-27 14:24:54 +02:00
Elisabeth Dickinson 9a2e8eefef [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.
2022-06-27 14:24:54 +02:00
Elisabeth Dickinson 994d273a59 [IMP] odoo_theme: replace "hide search matches" by a close button 2022-06-27 14:24:54 +02:00
Elisabeth Dickinson 794e42f78b [IMP] odoo_theme: improve spacing around code blocks on reference pages 2022-06-27 14:24:54 +02:00
Elisabeth Dickinson 0b536debac [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.
2022-06-27 14:24:54 +02:00
Elisabeth Dickinson 26bc1cd707 [FIX] odoo_theme: remove the horizontal scroll bar 2022-06-27 14:24:54 +02:00
Elisabeth Dickinson 91cb3ca026 [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.
2022-06-27 14:24:54 +02:00
Elisabeth Dickinson 2e693b3c4a [IMP] odoo_theme: improve general spacings and paddings 2022-06-27 14:24:54 +02:00
Elisabeth Dickinson 7239986484 [IMP] odoo_theme: improve special terms styling
Including the `:command:`, `:file:` and `:dfn:` roles, and code-styled
text in alerts.

task-2790284
2022-06-27 14:24:54 +02:00
Jonathan Castillo (jcs) 9ff312298d [IMP] contributing: update the rst cheat sheet
task - 2810468

closes odoo/documentation#1825

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
Co-authored-by: Antoine Vandevenne (anv) <anv@odoo.com>
Co-authored-by: Elisabeth Dickinson (edi) <edi@odoo.com>
2022-06-27 12:43:35 +02:00
Valentin Chevalier 0db39e3564 [ADD] payment_acquirers/adyen: add doc configuration of Adyen
Following a technical task regarding the migration of the Adyen hosted
payment page integration to Adyen PayByLink, some new parameters have
been introduced and some have been removed.

This new addition to the documentation will help users configure their
acquirer.

task-2802921

closes odoo/documentation#1737

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-06-27 09:12:46 +02:00
Odoo Translation Bot 4f846a1f62 [I18N] Update translation terms from Transifex 2022-06-26 02:40:18 +02:00
LoredanaLrpz 610aeb1563 [ADD] pos: adyen payment terminal
Task ID: 2808584
Do not Forward port r+

closes odoo/documentation#2017

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-06-24 17:47:37 +02:00
LoredanaLrpz 63792faa92 [IMP] pos: change titles
Part-of: odoo/documentation#2017
2022-06-24 17:47:37 +02:00
Tom Aarab (toaa) 103c17f235 [IMP] accounting: added specification about payment flow for payment acquirer
V13 and V14 do not allow customers with no account on Odoo.com portal to pay through payment acquirers with payment flow "Payment from Odoo"

task - 2711962

closes odoo/documentation#2239

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-06-23 18:12:24 +02:00
Antoine Vandevenne (anv) 2a867b4f60 [IMP] odoo_theme: open images in a modal
task-2358082

closes odoo/documentation#1687

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
Co-authored-by: Elisabeth Dickinson (edi) <edi@odoo.com>
2022-06-23 10:44:43 +02:00
Antoine Vandevenne (anv) 9e84b6f681 [FIX] odoo_theme: correctly test for fallback URLs when using switchers
closes odoo/documentation#2266

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-06-22 17:21:53 +02:00
Antoine Vandevenne (anv) 80c7b27827 [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#2265

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-06-22 16:31:52 +02:00
“Chiara 2c59116ef5 [REM] 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#2243

Signed-off-by: Victor Feyens (vfe) <vfe@odoo.com>
2022-06-20 16:45:06 +02:00
Elisabeth Dickinson a689ea236d [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#2215

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-06-15 11:16:41 +02:00
Odoo's Mergebot 10f62b6a49 [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#2206

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-06-15 10:30:46 +02:00
Antoine Vandevenne (anv) 98e98f65c9 [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 '/'.
2022-06-15 09:56:46 +02:00
Elisabeth Dickinson 3fd32fe92a [FIX] odoo_theme: fix searchbox's highlight-link
task-2800937
2022-06-15 09:56:16 +02:00
Elisabeth Dickinson 4ed8c2238a [IMP] odoo_theme: revamp side menu to add overlay
task-2800937
2022-06-15 09:56:07 +02:00
Elisabeth Dickinson 9c53901db9 [FIX] odoo_theme: fix menu scrolling
task-2800937
2022-06-15 09:55:55 +02:00
Elisabeth Dickinson 7284b11a36 [IMP] odoo_theme: add side menu collapse icon
task-2800937
2022-06-15 09:55:44 +02:00
Elisabeth Dickinson dee96ad2da [IMP] odoo_theme: change collapsing menu orientation
task-2800937
2022-06-15 09:55:25 +02:00
Elisabeth Dickinson 411e1cb1d3 [IMP] odoo_theme: add subheader and adapt switchers and searchbar
task-2800937
2022-06-15 09:55:05 +02:00
Elisabeth Dickinson b1fa30f431 [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
2022-06-15 09:51:45 +02:00
Elisabeth Dickinson 343decf192 [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#2167

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
Co-authored-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-06-14 11:42:13 +02:00
Elisabeth Dickinson c0040fa532 [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#2179

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
Co-authored-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-06-13 14:53:08 +02:00
Odoo Translation Bot fb700d98e8 [I18N] Update translation terms from Transifex 2022-06-12 02:40:20 +02:00
Antoine Vandevenne (anv) 5471d9a2ff [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#2169

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-06-09 13:58:41 +02:00
Denis Vermylen 1afee9e2c7 [FIX] odoo.sh: remove hidden folder from documentation
it will also be renamed to .repositories in the near future

closes odoo/documentation#2159

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-06-07 10:08:43 +02:00
Odoo Translation Bot f9327efd33 [I18N] Update translation terms from Transifex 2022-06-05 02:40:16 +02:00
Jason Aerts (jaae) 6dc4288e49 [IMP] maintain: process for odoo.sh to odoo online
task-id 2870122

closes odoo/documentation#2133

Signed-off-by: Victor Feyens (vfe) <vfe@odoo.com>
2022-06-03 12:29:48 +02:00
Tom Aarab (toaa) e4fc5f07ee [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#2122

Signed-off-by: Castillo Jonathan (jcs) <jcs@odoo.com>
2022-06-02 09:54:03 +02:00
Jonathan Castillo (jcs) 4cd0500408 [IMP] maintain: add note in hosting changes (on-premise to online)
task-id 2869953

closes odoo/documentation#2123

Signed-off-by: Castillo Jonathan (jcs) <jcs@odoo.com>
2022-06-01 17:37:04 +02:00
william 6d4f4f7d9b [FIX] conf: dynamic LaTeX releasename
closes odoo/documentation#2110

Signed-off-by: Victor Feyens (vfe) <vfe@odoo.com>
2022-05-30 16:06:48 +02:00
Demesmaeker 80408caf6d [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#1654

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-05-30 09:44:12 +02:00
Odoo Translation Bot 0efff824d2 [I18N] Update translation terms from Transifex 2022-05-29 02:40:16 +02:00
Donatienne Pirlot ffc23483ca [IMP] accounting: update the follow-up information
Task ID: 2735445

closes odoo/documentation#1834

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-05-24 13:40:02 +02:00
Odoo Translation Bot 8e7937a308 [I18N] Update translation terms from Transifex 2022-05-22 02:40:17 +02:00
Martin Trigaux 241fd5e76f [FIX] odoo_theme: correctly consider baseurl
urlBase was only containing the domain name, not the /documentation/

closes odoo/documentation#2054

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-05-20 11:47:20 +02:00
Donatienne Pirlot 8acc4060c7 [IMP] accounting : update the list of fiscal localization packages
task id: 2858536

closes odoo/documentation#2040

Signed-off-by: Castillo Jonathan (jcs) <jcs@odoo.com>
2022-05-19 16:54:56 +02:00
Martin Trigaux 25e863a64c [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#1588

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
Co-authored-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-05-19 16:54:50 +02:00
Altela Eleviansyah Pramardhika 1b2fbd0264 [FIX] developer/howtos: Fixed typo from field to fields
closes odoo/documentation#2023

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-05-19 12:40:49 +02:00
Antoine Vandevenne (anv) 6f125de01b [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

closes odoo/documentation#2006

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-05-19 11:33:49 +02:00
Odoo Translation Bot 419dd37189 [I18N] Update translation terms from Transifex 2022-05-15 02:40:17 +02:00
Jason Aerts (jaae) f92889baa3 [FIX] maintain: typo in domain names doc
closes odoo/documentation#1995

Signed-off-by: Castillo Jonathan (jcs) <jcs@odoo.com>
2022-05-13 11:24:13 +02:00
Antoine Vandevenne (anv) 8f4be8e3ea [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#1991

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-05-12 17:52:44 +02:00
Fabrice Henrion df10f17c3e [IMP] payment acquirers: a note in Authorize.net
closes odoo/documentation#1103

Signed-off-by: Castillo Jonathan (jcs) <jcs@odoo.com>
2022-05-12 12:08:36 +02:00
Demesmaeker 3231d20d92 [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#1750

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-05-09 10:44:39 +02:00
Jeremy Kersten 4c526eb02f [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#1946

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-05-09 09:49:41 +02:00
Odoo Translation Bot cc9d1e84e5 [I18N] Update translation terms from Transifex 2022-05-08 02:40:15 +02:00
Jonathan Castillo (jcs) d7da800674 [IMP] install/maintain: add seealso links in domain names doc
closes odoo/documentation#1932

Signed-off-by: Castillo Jonathan (jcs) <jcs@odoo.com>
2022-05-06 13:49:49 +02:00
Altela Eleviansyah Pramardhika 77ebdcdfca [FIX] developer/howtos: missing parentheses in print statement
Added parentheses in a print function

closes odoo/documentation#1923

Signed-off-by: Victor Feyens (vfe) <vfe@odoo.com>
2022-05-06 09:44:45 +02:00
Jonathan Castillo (jcs) abc6d99af7 [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#1910

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-05-04 17:20:57 +02:00
Odoo Translation Bot e4806cf4c9 [I18N] Update translation terms from Transifex 2022-05-01 02:40:22 +02:00
Antoine Vandevenne (anv) 34d604ca89 [ADD] .gitattributes: include RST files in language statistic on GitHub
closes odoo/documentation#1881

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-04-28 15:24:20 +02:00
root 324936c43e [ADD] multi_website: add info to configure multiple domains
closes odoo/documentation#1843

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-04-28 15:24:17 +02:00
Odoo Translation Bot 71d2760b8f [I18N] Update translation terms from Transifex 2022-04-24 02:40:51 +02:00
Dossogne Bertrand ce1961ebaf [FIX] developer: fix duplicate action availability
The duplicate action is not available for list views

closes odoo/documentation#1851

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-04-22 16:45:53 +02:00
Dossogne Bertrand 9cf425d886 [FIX] developer: fix duplicate availability
The duplicate action is not available for list views

closes odoo/documentation#1846

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-04-22 14:05:11 +02:00
Odoo Translation Bot 3903b64acb [I18N] Update translation terms from Transifex 2022-04-17 02:40:50 +02:00
Odoo Translation Bot 9e9fbbda69 [I18N] Update translation terms from Transifex 2022-04-10 02:40:51 +02:00
Martin Trigaux cd16051111 [I18N] *: export 13.0 source terms 2022-04-08 15:18:27 +02:00
Antoine Vandevenne (anv) ff79ca3a6b [IMP] odoo_theme: hide the "Edit on GitHub" button for pages in legal/
closes odoo/documentation#1810

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-04-08 10:38:58 +02:00
Christophe Simonis 30f55dfd72 [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#1804

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-04-06 16:00:42 +02:00
Antoine Vandevenne (anv) 683840be18 [ADD] last_build: add an orphan page informing on the last build date
closes odoo/documentation#1797

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

closes odoo/documentation#1783

Signed-off-by: Castillo Jonathan (jcs) <jcs@odoo.com>
2022-03-31 09:19:47 +02:00
Ray Carnes bdf526af2c [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#1772

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-03-30 13:06:24 +02:00
Antoine Vandevenne (anv) 4e0a9b615f [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#1771

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-03-30 12:12:34 +02:00
Donatienne Pirlot 6a316ca86e [FIX] upgrade: small fixes
task-2684744

closes odoo/documentation#1752

Signed-off-by: Castillo Jonathan (jcs) <jcs@odoo.com>
2022-03-29 10:11:55 +02:00
Jonathan Castillo (jcs) 73a7ec6d6e [FIX] redirects: add missing redirection for maintain/online.rst
closes odoo/documentation#1754

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-03-28 15:43:09 +02:00
Eric Macharia 5c5ef6e603 [FIX] install/maintain: typo in deploy.rst
closes odoo/documentation#1753

Signed-off-by: Castillo Jonathan (jcs) <jcs@odoo.com>
2022-03-28 14:47:40 +02:00
Antoine Vandevenne (anv) ba0e93e836 [IMP] supported_versions: flag saas-15.2 as supported
closes odoo/documentation#1739

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-03-25 15:50:45 +01:00
Donatienne Pirlot bdc749e879 [IMP] upgrade: update and improve the upgrade processes and information
task ID: 2684744

closes odoo/documentation#1509

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

closes odoo/documentation#1704

Signed-off-by: Castillo Jonathan (jcs) <jcs@odoo.com>
2022-03-18 14:04:39 +01:00
Antoine Vandevenne (anv) cb7a41b75b [FIX] odoo_theme: fix CSS issues and warnings
closes odoo/documentation#1711

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-03-18 13:24:20 +01:00
bve-odoo 7ce175ff55 [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#1703

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-03-17 11:16:47 +01:00
Antoine Vandevenne (anv) b81c121ea0 [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#1693

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-03-14 10:48:01 +00:00
Antoine Vandevenne (anv) 8fe8ad14a7 [IMP] developer/api/odoo: rework page to use examples and content tabs
task-2787415

closes odoo/documentation#1667

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-03-10 17:09:18 +00:00
Antoine Vandevenne (anv) fa17384396 [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

Part-of: odoo/documentation#1667
2022-03-10 17:09:18 +00:00
Antoine Vandevenne (anv) 81b07b94c0 [IMP] contributing/documentation: document usage of code tabs
task-2787415

Part-of: odoo/documentation#1667
2022-03-10 17:09:18 +00:00
nle-odoo b24560e224 [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#1675

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-03-10 14:29:39 +00:00
Jonathan Castillo (jcs) 787b82bab9 [IMP] install/maintain: add use of :guilabel: in domain_names
+ fix two small typos.

closes odoo/documentation#1674

Signed-off-by: Castillo Jonathan (jcs) <jcs@odoo.com>
2022-03-10 10:35:36 +00:00
Elisabeth Dickinson ac28acee4a [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#1668

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-03-08 16:03:44 +00:00
Elisabeth Dickinson b76a566522 [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.

Part-of: odoo/documentation#1668
2022-03-08 16:03:44 +00:00
Carlos Valverde 7250f88b8d [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#1641

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-03-08 09:46:49 +00:00
Ray Carnes b83df4f6d2 [IMP] accounting: improve phrasing OCR
Add link to try the OCR service, cleanup copy.

closes odoo/documentation#1655

Signed-off-by: Victor Feyens (vfe) <vfe@odoo.com>
2022-03-07 14:04:47 +00:00
Jonathan Castillo (jcs) d22f95362a [IMP] install/maintain: new improved doc about domain names
task-id 2680490

closes odoo/documentation#1644

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-03-03 16:44:43 +00:00
Odoo Translation Bot 3366eadb66 [I18N] Update translation terms from Transifex 2022-03-01 03:01:02 +01:00
Jonathan Castillo (jcs) 3c0b7783b8 [IMP] accounting: fix a typo in eu_distance_selling.rst
closes odoo/documentation#1633

Signed-off-by: Victor Feyens (vfe) <vfe@odoo.com>
2022-02-24 16:23:35 +00:00
Antoine Vandevenne (anv) 286b01a241 [IMP] extensions: add content tabs (backport of cf6ca0fb)
closes odoo/documentation#1624

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-02-23 10:58:12 +00:00
Stanislas Sobieski 3a51738995 [REV] odoo_sh: revert commit 6c48f90
closes odoo/documentation#1618

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-02-22 14:11:54 +00:00
Obay Abdelgadir 6d5e7bfcb5 [IMP] install: remove deprecated ssl instruction in deploy.rst
Backport of commit d227ab66b0 on #1448

closes odoo/documentation#1612

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-02-22 13:04:55 +00:00
Stanislas Sobieski 6c48f90739 [IMP] odoo_sh doc update
closes odoo/documentation#1597

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-02-21 17:33:02 +00:00
Antoine Vandevenne (anv) a7f0651773 [FIX] conf: upper-case 'master' in the version switcher
closes odoo/documentation#1599

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-02-16 09:41:52 +00:00
Elisabeth Dickinson c30f2735b8 [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#1589

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-02-15 08:29:51 +00:00
Antoine Vandevenne (anv) a64e95d1c6 [FIX] conf: list saas-15.2 in existing versions
closes odoo/documentation#1584

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-02-11 14:51:44 +00:00
Antoine Vandevenne (anv) fb469b8211 [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#1565

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-02-11 13:16:40 +00:00
Jonathan Castillo (jcs) 5893edda93 [IMP] install/maintain: add info about upgrading Odoo Online databases
closes odoo/documentation#1558

Signed-off-by: Castillo Jonathan (jcs) <jcs@odoo.com>
2022-02-11 10:03:54 +00:00
Antoine Vandevenne (anv) ec8804a1e5 [IMP] supported_versions: emphasis short-term support of SaaS versions
Part-of: odoo/documentation#1558
2022-02-11 10:03:54 +00:00
Antoine Vandevenne (anv) 04992995a6 [IMP] supported_versions: flag saas-15.1 as supported
Part-of: odoo/documentation#1558
2022-02-11 10:03:54 +00:00
Jonathan Castillo (jcs) 461f4b58bc [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#1547

Signed-off-by: Castillo Jonathan (jcs) <jcs@odoo.com>
2022-02-07 14:31:36 +00:00
Jonathan Castillo (jcs) dd8901846a [FIX] accounting: fix module name to install in intrastat
closes odoo/documentation#1539

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-02-04 17:51:14 +00:00
Antoine Vandevenne (anv) ddff8f6914 [IMP] contributing/doc: add an entry for the example admonition
closes odoo/documentation#1527

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-02-03 14:55:10 +00:00
BVE cf6af904f9 [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#1092

Signed-off-by: Vergote Baptiste (bve) <bve@odoo.com>
2022-02-02 15:04:56 +00:00
Demesmaeker f6c1723fe0 [IMP] integration_testing: add information about JS touring
Adding basic information about `How to make a test tour`.

task-2742841

closes odoo/documentation#1500

Signed-off-by: Morgane Demesmaeker <edm@odoo.com>
2022-02-02 11:08:35 +00:00
Xavier (xpl) 7ca24b13ef [ADD] Sign: section on Field Types
Task #: 2585411

closes odoo/documentation#1050

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-02-01 17:18:57 +00:00
Odoo Translation Bot 82f4d103cc [I18N] Update translation terms from Transifex 2022-02-01 03:00:57 +01:00
Antoine Vandevenne (anv) 89b91feae3 [FIX] subscription: replace an admonition with example
closes odoo/documentation#1502

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-01-28 10:39:45 +00:00
wan acda12669d [ADD] extensions: add a custom example admonition
closes odoo/documentation#1498

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-01-28 09:21:43 +00:00
Jonathan Castillo (jcs) 2c7310a41f [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

closes odoo/documentation#1479

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-01-27 15:17:47 +00:00
“Chiara b34e098551 [REM] Accounting: deprecated report removal
Task-id 2744389

closes odoo/documentation#1488

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-01-26 17:15:30 +00:00
“Chiara aa7a78331d [ADD] Accounting: new page about intrastat
Task-id 2721400

closes odoo/documentation#1472

Signed-off-by: Victor Feyens (vfe) <vfe@odoo.com>
2022-01-21 15:43:47 +00:00
Noura e486b5e3e8 [IMP] manufacturing: add warning regarding scrap location
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#1459

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-01-06 12:21:38 +00:00
Odoo Translation Bot fe3c7401ea [I18N] Update translation terms from Transifex 2022-01-01 03:01:00 +01:00
Fabien Meghazi 6d95821ed5 [IMP] supported_versions: end of support for v10 on Odoo.sh
python2 tooling will be removed gradually
2021-12-30 10:44:19 +01:00
Mark Fischer, Jr 7090a54670 [FIX] expenses: grammar and typos in expenses.rst
Backport to 13.0 of PR #1175

closes odoo/documentation#1436

Signed-off-by: Castillo Jonathan (jcs) <jcs@odoo.com>
2021-12-17 16:13:39 +00:00
jedgalbraith 7b5de904aa [IMP] manufacturing: add missing word in flexible_components_consumption
closes odoo/documentation#1083

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2021-12-17 14:22:42 +00:00
Jairo Llopis 03a54e5b37 [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#1427

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
Co-authored-by: Antoine Vandevenne (anv) <anv@odoo.com>
2021-12-16 10:25:10 +00:00
Chris Parker beb92c9f18 [FIX] api/odoo: reflect the correct location of menu actions
closes odoo/documentation#1409

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

closes odoo/documentation#1394

Signed-off-by: Victor Feyens (vfe) <vfe@odoo.com>
2021-12-13 17:51:42 +00:00
Xavier a1db25d3ba [IMP] studio: fix a typo
Original commit: e1e644fc9a
in PR: #1330

closes odoo/documentation#1395

Signed-off-by: Victor Feyens (vfe) <vfe@odoo.com>
2021-12-13 09:46:23 +00:00
Odoo Translation Bot c420344a48 [I18N] Update translation terms from Transifex 2021-12-12 02:30:57 +01:00
jedgalbraith 4903a9fecc [IMP] sales: grammar fix
closes odoo/documentation#1381

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2021-12-09 15:09:44 +00:00
jedgalbraith 5d72b5028f [IMP] inventory: word mistake
closes odoo/documentation#1380

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2021-12-09 14:45:16 +00:00
mdb-odoo c89dc13240 Clarify documentation of routes
Starting at line 259 - updated the text. This text was a mix of incorrect and confusing statements. I changed some words and sentences to correct the text and make it make more sense. Also updated the rule name to Pull & Push as that is what it is called in Odoo.

closes odoo/documentation#997

Signed-off-by: Castillo Jonathan (jcs) <jcs@odoo.com>
2021-12-09 14:15:57 +00:00
Antoine Vandevenne (anv) 493ebbfa9a [IMP] README: remove request for review instruction
closes odoo/documentation#1375

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2021-12-09 13:21:47 +00:00
Antoine Vandevenne (anv) edddeb4826 [REM] CODEOWNERS: rely on runbot's codeowners system
closes odoo/documentation#1370

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2021-12-09 11:49:48 +00:00
Moens Alexandre c3c054681c [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#1361

Signed-off-by: Victor Feyens (vfe) <vfe@odoo.com>
2021-12-08 13:30:40 +00:00
Odoo Translation Bot d3e3e1cfeb [I18N] Update translation terms from Transifex 2021-11-28 02:31:23 +01:00
Rémy Baranx (bar) f72e557f2c [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#1333

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
Co-authored-by: Antoine Vandevenne <anv@odoo.com>
2021-11-26 11:25:32 +00:00
Odoo Translation Bot 405e834a44 [I18N] Update translation terms from Transifex 2021-11-21 02:31:34 +01:00
Antoine Dupuis (andu) 35d773a82a [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#1271

Signed-off-by: Victor Feyens (vfe) <vfe@odoo.com>
2021-11-17 09:37:53 +00:00
Odoo Translation Bot 746bb8d163 [I18N] Update translation terms from Transifex 2021-11-14 02:31:24 +01:00
Odoo Translation Bot 7d7d7e6d54 [I18N] Update translation terms from Transifex 2021-11-07 02:31:19 +01:00
Jonathan Castillo (jcs) edb747bca1 [IMP] website: update a wrong link (godaddy)
task-id 2682327

closes odoo/documentation#1283

Signed-off-by: Castillo Jonathan (jcs) <jcs@odoo.com>
2021-11-03 16:02:22 +00:00
Raf Geens 23d0a7a062 [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#1258

Signed-off-by: Victor Feyens (vfe) <vfe@odoo.com>
2021-11-03 13:40:19 +00:00
Antoine Vandevenne (anv) 116d9b5181 [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#1273

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2021-11-03 10:19:45 +00:00
Odoo Translation Bot d0a32ea126 [I18N] Update translation terms from Transifex 2021-10-31 02:30:15 +02:00
Jonathan Castillo (jcs) d7f4475901 [ADD] maintain: revert and update "db_online"
task-2601835

closes odoo/documentation#1191

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2021-10-25 13:26:18 +00:00
Julien Van Roy 7fbf1c3ef2 [FIX] developer/reference: fix missing slash in javascript/qweb, debugging section
closes odoo/documentation#1207

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2021-10-22 12:52:37 +00:00
Jonathan Castillo (jcs) fd006b4a3c [IMP] upgrade: create new "upgrade" section in "install and maintain"
closes odoo/documentation#1169

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2021-10-15 11:20:44 +00:00
Jonathan Castillo (jcs) 8ca7d66faa [IMP] maintain: on premise filename change and media movement
Part-of: odoo/documentation#1169
2021-10-15 11:20:43 +00:00
Jonathan Castillo (jcs) 84ceee3fda [IMP] maintain: update versions upgrade
task-2600310

Part-of: odoo/documentation#1169
2021-10-15 11:20:43 +00:00
Antoine Vandevenne (anv) a9e218140f [REL] supported_versions: update list of versions and add end of support
closes odoo/documentation#1157

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2021-10-05 14:22:03 +00:00
Antoine Vandevenne (anv) 8043d92b24 [IMP] contributing: adapt the GitHub workflow to the new doc theme
closes odoo/documentation#1156

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2021-10-05 13:29:42 +00:00
Odoo Translation Bot 1d2677db83 [I18N] Update translation terms from Transifex 2021-09-26 02:30:32 +02:00
Denis Ledoux 7276929071 [FIX] maintain: upgrade command line link
closes odoo/documentation#1148

Signed-off-by: Victor Feyens (vfe) <vfe@odoo.com>
2021-09-20 08:37:29 +00:00
Odoo Translation Bot b1e309d69f [I18N] Update translation terms from Transifex 2021-09-19 02:30:29 +02:00
Raf Geens fd69696721 [FIX] app/accounting: Fix outdated Colombian test server url (Spanish)
Update the test server link that was updated in the English documentation
(colombia.rst) in the Spanish version as well (colombia_ES.rst).

Remove the incorrect link to the production server (which was a duplicate
of the test link instead) to be consistent with other versions of the
document.

closes odoo/documentation#1144

X-original-commit: ad36915bf7
Signed-off-by: Victor Feyens (vfe) <vfe@odoo.com>
Signed-off-by: Raf Geens <raf-odoo@users.noreply.github.com>
2021-09-15 10:27:54 +00:00
Jonathan Castillo (jcs) 0842b682fc [IMP] maintain: update test doc link in versions upgrade
closes odoo/documentation#1137

Signed-off-by: Victor Feyens (vfe) <vfe@odoo.com>
2021-09-14 14:52:17 +00:00
Antoine Vandevenne (anv) 7f3c27b49c [IMP] conf: hide saas branches from the version switcher
closes odoo/documentation#1131

X-original-commit: 7f5b948f0b
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2021-09-14 12:13:20 +00:00
Jonathan Castillo (jcs) ebf216cc8e [FIX] subscriptions: wrong Odoo Tutorials link
task-2636416

closes odoo/documentation#1128

Signed-off-by: Victor Feyens (vfe) <vfe@odoo.com>
2021-09-13 14:50:40 +00:00
Odoo Translation Bot a9c962a29c [I18N] Update translation terms from Transifex 2021-09-12 01:30:27 +02:00
Raf Geens b8fa076db5 [FIX] app/accounting: Fix outdated Colombian test server url
closes odoo/documentation#1124

X-original-commit: 38f0d9ebf2
Signed-off-by: Victor Feyens (vfe) <vfe@odoo.com>
Signed-off-by: Raf Geens <raf-odoo@users.noreply.github.com>
2021-09-09 08:50:46 +00:00
“odoo-dama” bef9941434 [ADD] ebay: new doc for account deletion notifications
task-2504306

closes odoo/documentation#1119

X-original-commit: abd3c56678
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
Co-authored-by: Antoine Vandevenne <anv@odoo.com>
2021-09-06 15:26:17 +00:00
Odoo Translation Bot 7521229148 [I18N] Update translation terms from Transifex 2021-09-05 01:30:20 +02:00
Odoo Translation Bot c605eb715a [I18N] Update translation terms from Transifex 2021-08-22 01:30:15 +02:00
Raf Geens 9e4a57deae [IMP] app/website: Clarify supported platforms for Gengo
Gengo won't work by default on Odoo Online and Odoo.sh. To
prevent confusing customers, be explicit about this and explain
the platforms on which it can work.

closes odoo/documentation#1105

X-original-commit: 989a447dc8
Signed-off-by: Victor Feyens (vfe) <vfe@odoo.com>
2021-08-18 09:16:08 +00:00
Odoo Translation Bot 9dcf918f65 [I18N] Update translation terms from Transifex 2021-08-15 01:30:21 +02:00
Odoo Translation Bot 5efd730a26 [I18N] Update translation terms from Transifex 2021-08-08 01:30:21 +02:00
Victor Feyens bcf283115b [FIX] Makefile: avoid confusing // in build dir path
When locally building the doc (aka make), CURRENT_LANG is not defined,
which results in HTML_BUILD_DIR = _build/html//, resulting in commands
& logs like the following

mkdir -p _build/html//_static
pysassc extensions/odoo_theme/static/style.scss _build/html//_static/style.css

This has no impact on linux builds, but could be unclear/confusing for some non tech
users (can it have any impact on other OS's/distros ?)

closes odoo/documentation#1094

X-original-commit: d8684e8963
Signed-off-by: Antoine Vandevenne (anv) <AntoineVDV@users.noreply.github.com>
Signed-off-by: Victor Feyens (vfe) <vfe@odoo.com>
2021-08-06 15:09:50 +00:00
Xavier-Do 4331a56658 [FIX] makefile: fix overridden css
The previous makefile was compiling css beside the style.scss and
the style.css was copied at the end.

The new makefile compile css directly in the build dir.

Since this file was still present in the source because of the .gitignore,
sphinx was using this old version of style.css, overriding the new compiled
css file at the end.

Removing it from gitignore should helpFix this problem.

This commit also fix some path in makefile.
(not critical but this should fix a potential error in static command)

closes odoo/documentation#1085

X-original-commit: fd56d8c170
Signed-off-by: Antoine Vandevenne (anv) <AntoineVDV@users.noreply.github.com>
Signed-off-by: Xavier Dollé (xdo) <xdo@odoo.com>
2021-08-05 08:43:36 +00:00
Victor Feyens 1211d3ae40 [FIX] core: wrong redirections
Cf #1054

closes odoo/documentation#1074

Signed-off-by: Victor Feyens (vfe) <vfe@odoo.com>
2021-08-04 15:39:26 +00:00
Donatienne Pirlot (dopi) eee063a8b1 [REM] developer/upgrade: remove outdated page
task-2613841

closes odoo/documentation#1080

X-original-commit: 7af926e5aa
Signed-off-by: Antoine Vandevenne (anv) <AntoineVDV@users.noreply.github.com>
2021-08-03 14:06:16 +00:00
Antoine Vandevenne (anv) 9316485da4 [FIX] Makefile: fix CSS compilation for multi-version/lang builds
Commit 547d90a allowed `BUILD_DIR` to be defined from the CLI but didn't
update usages of `HTML_BUILD_DIR`. When building the documentation for
multiple versions and/or languages, we should rely on `HTML_BUILD_DIR`
to point to the appropriate directory.

closes odoo/documentation#1076

X-original-commit: 9bad0540b0
Signed-off-by: Antoine Vandevenne (anv) <AntoineVDV@users.noreply.github.com>
2021-08-03 12:14:28 +00:00
2791 changed files with 104422 additions and 93730 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 -2
View File
@@ -1,10 +1,10 @@
*.pyc
.*
*.mo
.*
!.gitattributes
# Sphinx build files
_build/
extensions/odoo_theme/static/style.css
# Dependencies
odoo
+13 -8
View File
@@ -9,16 +9,21 @@ ifndef BUILD_DIR
BUILD_DIR = _build
endif
ifndef CURRENT_LANG
CURRENT_LANG = en
endif
SPHINX_BUILD = sphinx-build
CONFIG_DIR = .
SPHINXOPTS = -D project_root=$(ROOT) -D canonical_version=$(CANONICAL_VERSION) \
-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)/13.0
@@ -43,7 +48,7 @@ clean:
rm -rf $(BUILD_DIR)/*
@echo "Cleaning finished."
html: $(BUILD_DIR)/html/_static/style.css
html: $(HTML_BUILD_DIR)/_static/style.css
@echo "Starting build..."
$(SPHINX_BUILD) -c $(CONFIG_DIR) -b html $(SPHINXOPTS) $(SOURCE_DIR) $(HTML_BUILD_DIR)
@echo "Build finished."
@@ -63,10 +68,10 @@ gettext:
$(SPHINX_BUILD) -c $(CONFIG_DIR) -b gettext $(SOURCE_DIR) locale/sources
@echo "Generation finished."
$(BUILD_DIR)/html/_static/style.css: extensions/odoo_theme/static/style.scss extensions/odoo_theme/static/scss/*.scss
$(HTML_BUILD_DIR)/_static/style.css: extensions/odoo_theme/static/style.scss extensions/odoo_theme/static/scss/*.scss
@echo "Compiling stylesheets..."
mkdir -p $(BUILD_DIR)/html/_static
pysassc extensions/odoo_theme/static/style.scss $(BUILD_DIR)/html/_static/style.css
mkdir -p $(HTML_BUILD_DIR)/_static
pysassc extensions/odoo_theme/static/style.scss $(HTML_BUILD_DIR)/_static/style.css
@echo "Compilation finished."
#=== Development and debugging rules ===#
@@ -74,6 +79,6 @@ $(BUILD_DIR)/html/_static/style.css: extensions/odoo_theme/static/style.scss ext
fast: SPHINXOPTS += -A collapse_menu=True
fast: html
static: $(BUILD_DIR)/static/style.css
cp -r extensions/odoo_theme/static/* $(BUILD_DIR)/html/_static/
cp -r static/* $(BUILD_DIR)/html/_static/
static: $(HTML_BUILD_DIR)/_static/style.css
cp -r extensions/odoo_theme/static/* $(HTML_BUILD_DIR)/_static/
cp -r static/* $(HTML_BUILD_DIR)/_static/
-4
View File
@@ -39,10 +39,6 @@ For contributions to the content of the documentation, please refer to the
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.
## Learn More
To learn more about Odoo, in addition to the documentation, have a look at
+88 -56
View File
@@ -48,6 +48,10 @@ 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
@@ -58,34 +62,40 @@ 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()))
odoo_dir = odoo_sources_dirs[0].resolve()
sys.path.insert(0, str(odoo_dir))
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'
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
# The Sphinx extensions to use, as module names.
@@ -106,17 +116,18 @@ 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',
# Strange html domain logic used in memento pages
'html_domain',
]
if odoo_dir_in_path:
# GitHub links generation
extensions += [
@@ -128,7 +139,6 @@ todo_include_todos = False
intersphinx_mapping = {
'python': ('https://docs.python.org/3/', None),
'werkzeug': ('https://werkzeug.palletsprojects.com/en/1.0.x/', None),
}
github_user = 'odoo'
@@ -142,19 +152,35 @@ 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',
'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 +201,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 +224,7 @@ latex_elements = {
'tableofcontents': '', # no TOC
# Output manually in latex docs
'releasename': '14.0',
'releasename': release,
}
latex_additional_files = ['static/latex/odoo.sty']
@@ -283,15 +309,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.
@@ -302,19 +331,22 @@ def _generate_alternate_urls(app, pagename, templatename, context, doctree):
"""
_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)
context['language'] = languages_names.get(_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
+2 -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:
@@ -303,7 +303,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;
@@ -316,7 +316,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;
@@ -44,4 +44,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>`.
+12 -7
View File
@@ -409,8 +409,10 @@ 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 default database to serve on `localhost:8069`.
.. seealso::
- :doc:`The exhaustive list of arguments for odoo-bin </developer/cli>`.
Linux
-----
@@ -578,8 +580,10 @@ 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 default database to serve on `localhost:8069`.
.. seealso::
- :doc:`The exhaustive list of arguments for odoo-bin </developer/cli>`.
Mac OS
------
@@ -740,9 +744,10 @@ 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 default database to serve on `localhost:8069`.
.. seealso::
- :doc:`The exhaustive list of arguments for odoo-bin </developer/cli>`.
.. _setup/install/docker:
@@ -750,7 +755,7 @@ 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/
.. _demo: https://demo.odoo.com
+4 -2
View File
@@ -6,9 +6,11 @@ Maintain
.. toctree::
maintain/domain_names
maintain/google_oauth
maintain/update
maintain/db_upgrade
maintain/enterprise
maintain/hosting_changes
maintain/db_premise
maintain/online
maintain/on_premise
maintain/supported_versions
@@ -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,325 @@
============
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>`.
#. Optionally: :ref:`Change the web base address of your database <domain-name/web-base-url>`.
.. _domain-name/cname:
Add a CNAME record
------------------
A **CNAME record** is a type of DNS record that points to the IP address of another website rather
than to 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
~~~~~~~~~~~~~~~~~~~~~~~~~~
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.
- 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.
.. 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

@@ -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,13 +48,37 @@ 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
===========================
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

@@ -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,7 +18,7 @@ Registration Error Message
If you are unable to register your database, you will likely encounter this
message:
.. image:: media/error_message_sub_code.png
.. 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
@@ -44,14 +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
.. 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
.. image:: on_premise/unlink_confirm_enterprise_edition.png
:align: center
@@ -65,7 +62,7 @@ Solutions
<https://accounts.odoo.com/my/subscription>`__, a short message will appear
specifying which database is problematic:
.. image:: media/unlink_db_name_collision.png
.. image:: on_premise/unlink_db_name_collision.png
:align: center
@@ -96,7 +93,7 @@ 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
.. 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
@@ -125,7 +122,7 @@ 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
.. image:: on_premise/database_expired.png
:align: center
:alt: This database has expired.
@@ -157,7 +154,7 @@ 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
.. image:: on_premise/db_manager.gif
:align: center
@@ -175,5 +172,5 @@ System Parameters`, we advise you to use a `uuid generator <https://www.uuidtool
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
.. 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

+155
View File
@@ -0,0 +1,155 @@
=================================
Online (SaaS) 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:: 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:: 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:`online/upgrade`
- :ref:`online/duplicate`
- :ref:`online/rename`
- :ref:`online/download`
- :ref:`online/domains`
- :ref:`online/tags`
- :ref:`online/delete`
- :ref:`online/contact-support`
- :ref:`online/users`
.. _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`
.. _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.
.. _online/rename:
Rename
======
Rename the database and its URL.
.. _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>`_.
.. _online/domains:
Domains
=======
Configure custom domains to access the database via another URL.
.. seealso::
- :doc:`domain_names`
.. _online/tags:
Tags
====
Add tags to sort your databases out. You can search the tags in the search bar.
.. _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:: 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>`_.
.. _online/contact-support:
Contact Support
===============
Access the Odoo `support page <https://www.odoo.com/help>`_ with your database's details already
pre-filled.
.. _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:: 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

@@ -5,13 +5,15 @@
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 <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,36 +22,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.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 | |
+-----------------+-------------+----------+-------------+----------------+------------------------+
| Odoo saas~15.1 | |red| | N/A | N/A | February 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::
@@ -59,19 +68,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
==============================================
@@ -9,5 +9,4 @@ Advanced
advanced/containers
advanced/submodules
advanced/upgrade_your_database
advanced/frequent_technical_questions
@@ -167,7 +167,7 @@ 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*":
@@ -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

@@ -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,12 +53,12 @@ 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:
@@ -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.
@@ -8,7 +8,7 @@ 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:
@@ -20,7 +20,7 @@ Odoo.sh offers three different stages for your branches: production, staging and
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:
@@ -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,
@@ -109,7 +109,7 @@ 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,
@@ -156,7 +156,7 @@ 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.
@@ -172,7 +172,7 @@ This tab contains the mail catcher. It displays an overview of the emails sent b
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%
@@ -181,7 +181,7 @@ 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,
@@ -197,7 +197,7 @@ 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,
@@ -207,17 +207,19 @@ 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:
@@ -241,7 +243,7 @@ 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.
@@ -277,13 +279,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 +313,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,7 +395,9 @@ 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
@@ -393,7 +408,7 @@ 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,
@@ -462,12 +477,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 +496,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,

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

@@ -13,7 +13,7 @@ In Odoo.sh, a build is considered as a database loaded by an Odoo server
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.
@@ -95,7 +95,7 @@ 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.
.. 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
@@ -103,7 +103,7 @@ the *Github* link. For other branches than the production, you can create a new
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.
@@ -113,7 +113,7 @@ 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:

Before

Width:  |  Height:  |  Size: 16 KiB

After

Width:  |  Height:  |  Size: 16 KiB

@@ -10,7 +10,7 @@ Deploy your platform
Go to `Odoo.sh <https://www.odoo.sh/>`_ and hit the *Deploy your platform* button.
.. image:: ./media/deploy.png
.. image:: create/deploy.png
:align: center
Sign in with Github
@@ -18,7 +18,7 @@ Sign in with Github
Sign in with your Github account. If you do not have an account yet, hit the *Create an account* link.
.. image:: ./media/github-signin.png
.. image:: create/github-signin.png
:align: center
Authorize Odoo.sh
@@ -26,7 +26,7 @@ Authorize Odoo.sh
Grant Odoo.sh the required accesses to your account by clicking the *Authorize* button.
.. image:: ./media/github-authorize.png
.. image:: create/github-authorize.png
:align: center
Odoo.sh basically needs:
@@ -62,7 +62,7 @@ When submitting the form, if you are notified your subscription is not valid, it
In case of doubt with your subscription, please contact the `Odoo support <https://www.odoo.com/help>`_.
.. image:: ./media/deploy-form.png
.. image:: create/deploy-form.png
:align: center
You're done !
@@ -70,7 +70,7 @@ You're done !
You can start using Odoo.sh. Your first build is about to be created. You will soon be able to connect to your first database.
.. image:: ./media/deploy-done.png
.. image:: create/deploy-done.png
:align: center
.. _odoo_sh_import_your_database:
@@ -113,12 +113,12 @@ Access the URL :file:`/web/database/manager` of your on-premise database and dow
You will need the master password of your database server. If you do not have it, contact your system administrator.
.. image:: ./media/create-import-onpremise-backup.png
.. image:: create/create-import-onpremise-backup.png
:align: center
Choose a zip including the filestore as the backup format.
.. image:: ./media/create-import-onpremise-backup-dialog.png
.. image:: create/create-import-onpremise-backup-dialog.png
:align: center
Odoo Online databases
@@ -126,7 +126,7 @@ Odoo Online databases
`Access your databases manager <https://accounts.odoo.com/my/databases/manage>`_ and download a backup of your database.
.. image:: ./media/create-import-online-backup.png
.. image:: create/create-import-online-backup.png
:align: center
.. Warning::
@@ -138,12 +138,12 @@ Upload the backup
Then, in your Odoo.sh project, in the backups tab of your production branch, import the backup you just downloaded.
.. image:: ./media/create-import-production.png
.. image:: create/create-import-production.png
:align: center
Once the backup imported, you can access the database using the *Connect* button in the history of the branch.
.. image:: ./media/create-import-production-done.png
.. image:: create/create-import-production-done.png
:align: center
Check your outgoing email servers
@@ -184,4 +184,4 @@ as you can only have one database linked per subscription.
If you plan to make it your production,
unlink your former database from the subscription, and register the newly imported database.
Read the :ref:`database registration documentation <db_premise>` for instructions.
Read the :doc:`database registration documentation <../../maintain/on_premise>` for instructions.

Before

Width:  |  Height:  |  Size: 24 KiB

After

Width:  |  Height:  |  Size: 24 KiB

Before

Width:  |  Height:  |  Size: 29 KiB

After

Width:  |  Height:  |  Size: 29 KiB

Before

Width:  |  Height:  |  Size: 34 KiB

After

Width:  |  Height:  |  Size: 34 KiB

Before

Width:  |  Height:  |  Size: 13 KiB

After

Width:  |  Height:  |  Size: 13 KiB

Before

Width:  |  Height:  |  Size: 6.9 KiB

After

Width:  |  Height:  |  Size: 6.9 KiB

@@ -37,20 +37,20 @@ In the branches view:
|pic1| |pic2|
.. |pic1| image:: ./media/firstmodule-development-+.png
.. |pic1| image:: first_module/firstmodule-development-+.png
:width: 45%
.. |pic2| image:: ./media/firstmodule-development-fork.png
.. |pic2| image:: first_module/firstmodule-development-fork.png
:width: 45%
Once the build created, you can access the editor and browse to the folder *~/src/user* to access
to the code of your development branch.
.. image:: ./media/firstmodule-development-editor.png
.. image:: first_module/firstmodule-development-editor.png
:align: center
.. image:: ./media/firstmodule-development-editor-interface.png
.. image:: first_module/firstmodule-development-editor-interface.png
:align: center
From your computer
@@ -95,7 +95,7 @@ Or, from your computer, if you have an :ref:`installation of Odoo <setup/install
$ ./odoo-bin scaffold my_module ~/src/odoo-addons/
If you do not want to bother installing Odoo on your computer,
you can also :download:`download this module structure template <media/my_module.zip>` in which you replace every occurrences of
you can also :download:`download this module structure template <first_module/my_module.zip>` in which you replace every occurrences of
*my_module* to the name of your choice.
The below structure will be generated:
@@ -201,19 +201,19 @@ Test your module
Your branch should appear in your development branches in your project.
.. image:: ./media/firstmodule-test-branch.png
.. image:: first_module/firstmodule-test-branch.png
:align: center
In the branches view of your project,
you can click on your branch name in the left navigation panel to access its history.
.. image:: ./media/firstmodule-test-branch-history.png
.. image:: first_module/firstmodule-test-branch-history.png
:align: center
You can see here the changes you just pushed, including the comment you set.
Once the database ready, you can access it by clicking the *Connect* button.
.. image:: ./media/firstmodule-test-database.png
.. image:: first_module/firstmodule-test-database.png
:align: center
If your Odoo.sh project is configured to install your module automatically,
@@ -234,12 +234,12 @@ You can either:
* Make your development branch a staging branch, by drag and dropping it onto the *staging* section title.
.. image:: ./media/firstmodule-test-devtostaging.png
.. image:: first_module/firstmodule-test-devtostaging.png
:align: center
* Merge it in an existing staging branch, by drag and dropping it onto the given staging branch.
.. image:: ./media/firstmodule-test-devinstaging.png
.. image:: first_module/firstmodule-test-devinstaging.png
:align: center
You can also use the :code:`git merge` command to merge your branches.
@@ -247,7 +247,7 @@ You can also use the :code:`git merge` command to merge your branches.
This will create a new staging build, which will duplicate the production database and make it run using a server
updated with your latest changes of your branch.
.. image:: ./media/firstmodule-test-mergedinstaging.png
.. image:: first_module/firstmodule-test-mergedinstaging.png
:align: center
Once the database ready, you can access it using the *Connect* button.
@@ -267,12 +267,12 @@ Your module may not appear directly in your apps to install either, you need to
* in the apps menu, click the *Update Apps List* button,
* in the dialog that appears, click the *Update* button.
.. image:: ./media/firstmodule-test-updateappslist.png
.. image:: first_module/firstmodule-test-updateappslist.png
:align: center
Your module will then appear in the list of available apps.
.. image:: ./media/firstmodule-test-mymoduleinapps.png
.. image:: first_module/firstmodule-test-mymoduleinapps.png
:align: center
Deploy in production
@@ -283,7 +283,7 @@ and believe it is ready for production, you can merge your branch in the product
Drag and drop your staging branch on the production branch.
.. image:: ./media/firstmodule-test-mergeinproduction.png
.. image:: first_module/firstmodule-test-mergeinproduction.png
:align: center
You can also use the :code:`git merge` command to merge your branches.
@@ -291,7 +291,7 @@ You can also use the :code:`git merge` command to merge your branches.
This will merge the latest changes of your staging branch in the production branch,
and update your production server with these latest changes.
.. image:: ./media/firstmodule-test-mergedinproduction.png
.. image:: first_module/firstmodule-test-mergedinproduction.png
:align: center
Once the database ready, you can access it using the *Connect* button.
@@ -411,7 +411,7 @@ Or, from your computer terminal:
The platform will then create a new build for the branch *feature-1*.
.. image:: ./media/firstmodule-test-addachange-build.png
.. image:: first_module/firstmodule-test-addachange-build.png
:align: center
Once you tested your changes, you can merge your changes in the production branch, for instance by drag-and-dropping the

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