Compare commits

...

162 Commits

Author SHA1 Message Date
Antoine Vandevenne (anv)
8bf9513b96 [ADD] payment_acquirers: add configuration steps for Flutterwave
task-2759117
2022-05-30 12:13:33 +02:00
Michelle Vu (mivu)
e7aac2eed3 [IMP] payment: update SIX screenshots
closes odoo/documentation#2101

X-original-commit: 6dc30adf15
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-05-27 13:46:17 +02:00
Michelle Vu (mivu)
8ffc93b3c1 [IMP] helpdesk: update flow and images for reinvoicing time
closes odoo/documentation#2097

X-original-commit: 00ec789d96
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-05-27 11:46:02 +02:00
Raphael Collet
3da237343f [IMP] developer: new API for flush() and invalidate()
closes odoo/documentation#1909

Signed-off-by: Raphael Collet <rco@odoo.com>
2022-05-25 21:34:53 +02:00
Michelle Vu (mivu)
a0a4a2da98 [FW][IMP] calendar: update Google Calendar sync screenshots
Task ID: 2685658

closes odoo/documentation#2090

Forward-port-of: odoo/documentation#1982
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-05-25 12:46:11 +02:00
Valentin Chevalier
f93aeec22f [IMP] payment_acquirers/stripe: support refund
Add a check to indicate that Stripe supports refunds.

closes odoo/documentation#2086

Related: odoo/odoo#92235
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-05-25 12:46:05 +02:00
Donatienne Pirlot
3d145e7759 [IMP] accounting: update the follow-up information
Task ID: 2735445

closes odoo/documentation#2081

X-original-commit: ffc23483ca
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
Signed-off-by: Pirlot Donatienne (dopi) <dopi@odoo.com>
2022-05-24 17:08:56 +02:00
Michelle Vu (mivu)
7aae398cf7 [ADD] discuss: configure Twilio ICE servers
closes odoo/documentation#2074

X-original-commit: 47d1146c10
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-05-23 10:58:44 +02:00
Donatienne Pirlot
404b954a0e [IMP] accounting : update the list of fiscal localization packages
task id: 2858536

closes odoo/documentation#2053

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

closes odoo/documentation#2068

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

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

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

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

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

task-2497965

Part-of: odoo/documentation#2068
2022-05-20 14:18:54 +02:00
Martin Trigaux
3901e3b241 [FIX] odoo_theme: correctly consider baseurl
urlBase was only containing the domain name, not the /documentation/

closes odoo/documentation#2062

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-05-20 12:11:29 +02:00
Martin Trigaux
a81e0623b0 [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#2052

X-original-commit: 25e863a64c
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
Signed-off-by: Martin Trigaux (mat) <mat@odoo.com>
Co-authored-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-05-19 23:16:49 +02:00
Beshoy Nabeih
d5d232bb50 [FIX] developer/frontend: typo in the user menu registry example
closes odoo/documentation#2039

X-original-commit: 6d30d81a76
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-05-19 18:06:18 +02:00
Altela Eleviansyah Pramardhika
5ddc402467 [FW][FIX] developer/howtos: Fixed typo from field to fields
closes odoo/documentation#2037

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

closes odoo/documentation#2031

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

Task: 2540813
X-original-commit: 44129be225
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-05-19 12:28:30 +02:00
Jeremy Kersten
eb28322572 [ADD] websites: add plausible.io Dashboard documentation
closes odoo/documentation#2007

Related: odoo/odoo#91058
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-05-18 20:33:37 +02:00
John Kirkwood (kij)
ded1e69553 [IMP] developer: clarify options for many2one widget
Only `no_create` is required to hide both the 'Create "xxx"' and the
'Create and Edit...' dropdown menu options.

closes odoo/documentation#2016

X-original-commit: 599a137ffc
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-05-18 16:05:03 +02:00
Donatienne Pirlot
951e47708d [ADD] accounting: new doc about outstanding account
Task-id 2744131

closes odoo/documentation#2012

X-original-commit: 5de81c9e2d
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-05-18 13:08:28 +02:00
Antoine Vandevenne (anv)
6191b57da3 [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#2001

X-original-commit: 4c7e89d872
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-05-13 17:11:46 +02:00
Fabrice Henrion
9e902c7a7e [IMP] payment acquirers: a note in Authorize.net
closes odoo/documentation#1990

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

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

opw-2824263

closes odoo/documentation#1980

X-original-commit: f6bf1183db
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
Signed-off-by: Desausoi Laurent (lade) <lade@odoo.com>
2022-05-10 16:23:55 +02:00
Antoine Vandevenne (anv)
835d77f3cf [FIX] conf: allow building the documentation with Python 3.6.
Commit 3d358fdb introduced a new import of Odoo source files which
complain about the minimal Python version if the hack added by 57e1e314
is not executed early enough.

closes odoo/documentation#1973

X-original-commit: 557b261e01
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-05-09 16:04:54 +02:00
wan
889c9cf0f9 [REF] i18n/localization.rst: rework the entire localization tutorial
closes odoo/documentation#1969

X-original-commit: 9db567159d
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
Signed-off-by: William André (wan) <wan@odoo.com>
Co-authored-by: William Andre <wan@odoo.com>
Co-authored-by: Ivan Yelizariev <iel@odoo.com>
2022-05-09 14:03:24 +02:00
wan
28fe18157e [ADD] extension: allow to build graphs using graphviz
X-original-commit: e00b5e35c7
Part-of: odoo/documentation#1969
2022-05-09 14:03:24 +02:00
wan
026d6a76be [ADD] extensions: new autofield directive
This new directive is generating documentation from Odoo fields. This
can be used to build documentation about business classes.
This will help developpers import/export data and build localization
modules for instance.

X-original-commit: 16afaf6fa7
Part-of: odoo/documentation#1969
2022-05-09 14:03:24 +02:00
wan
f559ec5939 [ADD] conf: give relative and absolute path to odoo repo
Also add a condition on some directives to ignore them when we have no
relative/absolute path.

X-original-commit: a514c905c0
Part-of: odoo/documentation#1969
2022-05-09 14:03:23 +02:00
Demesmaeker
d12773b496 [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#1967

X-original-commit: 3231d20d92
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-05-09 14:03:13 +02:00
Tori (vpk)
a7a0db9ca3 [IMP] CRM: update multiple sales teams doc
closes odoo/documentation#1964

Task: 2588786
X-original-commit: 98f306eca5
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-05-09 12:57:44 +02:00
Jeremy Kersten
8b5db69cae [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#1955

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

X-original-commit: 093aea15ec
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-05-09 08:25:01 +02:00
Jonathan Castillo (jcs)
35da831350 [IMP] install/maintain: add seealso links in domain names doc
closes odoo/documentation#1938

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

closes odoo/documentation#1931

Forward-port-of: odoo/documentation#1923
Signed-off-by: Victor Feyens (vfe) <vfe@odoo.com>
2022-05-06 13:30:21 +02:00
Victor Feyens
9a5c4e5a40 [FIX] developer/orm: fields_view_get is now deprecated
Since odoo/odoo#87522, the method fields_view_get is deprecated and
get_view should be used instead.
A deprecation notice will be included in fields_view_get docstring
to make sure users are aware that they shouldn't use it anymore.

closes odoo/documentation#1908

Related: odoo/odoo#90634
Signed-off-by: Victor Feyens (vfe) <vfe@odoo.com>
2022-05-05 18:47:58 +02:00
Jonathan Castillo (jcs)
74840c9223 [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#1922

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

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

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

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

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

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

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

closes odoo/documentation#1917

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

closes odoo/documentation#1906

X-original-commit: b2f4a9e818
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-05-03 03:57:17 +02:00
Antoine Vandevenne (anv)
7f2829f6c6 [ADD] .gitattributes: include RST files in language statistic on GitHub
closes odoo/documentation#1899

X-original-commit: 34d604ca89
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-04-29 11:01:52 +02:00
root
f3a541ad73 [ADD] multi_website: add info to configure multiple domains
closes odoo/documentation#1898

X-original-commit: 324936c43e
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-04-29 11:01:50 +02:00
Loan (lse)
ed4a7be19b [IMP] outlook mail_plugin: add solution for cookie issue
closes odoo/documentation#1885

X-original-commit: 3e25d94b0d
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-04-28 14:59:55 +02:00
Adrien Milis
f6b60c1010 [FIX] developer/rd-training: fix commands
Changed commands that were still referring to Odoo 14.0 to 15.0

closes odoo/documentation#1880

X-original-commit: b578f575d0
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-04-27 11:06:17 +02:00
MichaSi
7277af11d1 [FW][FIX] crm: fix typos and menuselection items
closes odoo/documentation#1874

Forward-port-of: odoo/documentation#1183
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-04-27 09:00:28 +02:00
Antoine Vandevenne (anv)
e588d900c9 [FIX] developer/rdtraining: fix typos
closes odoo/documentation#1867

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

closes odoo/documentation#1860

X-original-commit: ce1961ebaf
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-04-25 10:27:57 +02:00
Dossogne Bertrand
78f66a5298 [FIX] developer: fix duplicate availability
The duplicate action is not available for list views

closes odoo/documentation#1853

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

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

opw-2766940

closes odoo/documentation#1841

X-original-commit: 9c242400b6
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
Signed-off-by: Djamel Touati (otd) <otd@odoo.com>
2022-04-21 18:45:24 +02:00
Benoit Socias
27e9c1b2f2 [IMP] rdtraining: clarify transition sentence to view inheritance
The "View Inheritance" section is introduced by a sentence that can be
understood as "do this task then we'll be ready to go the next section"
instead of "in the next section we will see how to do this task".
This can confuse the reader into thinking that some knowledge was not
acquired in the previous parts.

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

task-2822582

closes odoo/documentation#1831

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

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

task-2822582

X-original-commit: 2ebb7fe802
Part-of: odoo/documentation#1831
2022-04-13 15:50:48 +02:00
Altela Eleviansyah Pramardhika
dec529af18 [FW][FIX] developer/rdtraining: fix typo
Fixed `name = field.Char(required=True)` to
`name = fields.Char(required=True)`.

closes odoo/documentation#1822

Forward-port-of: odoo/documentation#1816
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-04-11 12:42:39 +02:00
Antoine Vandevenne (anv)
493d45d687 [IMP] odoo_theme: hide the "Edit on GitHub" button for pages in legal/
closes odoo/documentation#1815

X-original-commit: ff79ca3a6b
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-04-08 15:52:36 +02:00
Christophe Simonis
f997758e12 [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#1809

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

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

closes odoo/documentation#1794

X-original-commit: 7c5d18b84c
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-04-05 10:53:55 +02:00
LoredanaLrpz
fc268ae277 [IMP] pos: add tip usable decimal separator
task-id 2608735

closes odoo/documentation#1788

X-original-commit: ae76baa20e
Signed-off-by: Castillo Jonathan (jcs) <jcs@odoo.com>
2022-03-31 10:37:06 +02:00
Ray Carnes
214fba8896 [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#1782

X-original-commit: bdf526af2c
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-03-30 16:34:13 +02:00
Antoine Vandevenne (anv)
58be362009 [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#1777

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

closes odoo/documentation#1769

X-original-commit: 6a316ca86e
Signed-off-by: Castillo Jonathan (jcs) <jcs@odoo.com>
2022-03-29 12:00:14 +02:00
poma-odoo
4eb09d95f2 [IMP] developer/views: add and remove tags for position=attributes
The tags`add`, `remove` and `separator` are not included in the
documentation.

closes odoo/documentation#1741

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
Co-authored-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-03-29 11:59:50 +02:00
Jonathan Castillo (jcs)
fa70e54d1a [FIX] redirects: add missing redirection for maintain/online.rst
closes odoo/documentation#1764

X-original-commit: 73a7ec6d6e
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
Signed-off-by: Castillo Jonathan (jcs) <jcs@odoo.com>
2022-03-29 10:56:33 +02:00
Eric Macharia
1aa28868e4 [FIX] install/maintain: typo in deploy.rst
closes odoo/documentation#1759

X-original-commit: 5c5ef6e603
Signed-off-by: Castillo Jonathan (jcs) <jcs@odoo.com>
2022-03-29 03:31:24 +02:00
Donatienne Pirlot
cb825e247d [IMP] upgrade: update and improve the upgrade processes and information
task ID: 2684744

closes odoo/documentation#1749

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

X-original-commit: ba0e93e836
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-03-25 19:42:44 +01:00
Valentin Chevalier
c57decd8b0 [IMP] payment_acquirers/stripe: split authorization and capture
Add documentation about the manual capture for Stripe

task-2781377

closes odoo/documentation#1642

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-03-23 13:39:50 +01:00
Thibault Francois
e6d9a9dac2 [IMP] CLI: adapt cloc doc to new behavior
since https://github.com/odoo/odoo/pull/85854 cloc
also count stylesheet file and frontend file in
imported module

closes odoo/documentation#1734

X-original-commit: d2de65a15a
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-03-22 12:00:48 +01:00
Jonathan Castillo (jcs)
8c1a7ae400 [ADD] accounting/l10n: new localization for luxembourg
task-id 2780977

closes odoo/documentation#1722

X-original-commit: 5a70ee1088
Signed-off-by: Castillo Jonathan (jcs) <jcs@odoo.com>
2022-03-21 17:56:55 +01:00
Zachary Straub (ZST)
22e6fcc760 [ADD] general/digest_emails: add new digest emails docs
closes odoo/documentation#1731

X-original-commit: 5d8246c206
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-03-21 14:01:09 +01:00
Bruno Boi
0c0a7086ac [IMP] hooks: usePosition new API
closes odoo/documentation#1598

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-03-21 10:15:16 +01:00
0b11001111
cadf860b42 [IMP] developer: extend internationalization guide
In order for javascript translations to become active, the corresponding
addon needs to follow a certain naming scheme or register explicitly.
This commit updates the internationalization guide with a respective
hint.

Fixes odoo/documentation#1676

closes odoo/documentation#1727

X-original-commit: 112b6c1267
Signed-off-by: Martin Trigaux (mat) <mat@odoo.com>
2022-03-18 17:05:10 +01:00
Antoine Vandevenne (anv)
17b5636645 [FIX] odoo_theme: fix CSS issues and warnings
closes odoo/documentation#1717

X-original-commit: cb7a41b75b
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-03-18 16:07:38 +01:00
Demesmaeker
df991cb75d [IMP] stripe: add information for webhook creation
The events we are listening in the webhooks changed.

task-2766383

closes odoo/documentation#1605

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-03-18 12:26:33 +01:00
bve-odoo
279dc5a623 [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#1709

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

closes odoo/documentation#1702

X-original-commit: 88752379bb
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
Signed-off-by: Morgane Demesmaeker <edm@odoo.com>
2022-03-16 15:09:51 +01:00
Antoine Vandevenne (anv)
7316152764 [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#1699

X-original-commit: c018a53686
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-03-14 11:28:56 +00:00
Antoine Vandevenne (anv)
7b9bb78801 [IMP] developer/api/extract_api: rework page to get rid of switchers
task-2787415

closes odoo/documentation#1692

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

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

task-2787415

X-original-commit: 269173caac
Part-of: odoo/documentation#1692
2022-03-11 14:44:46 +00:00
Antoine Vandevenne (anv)
31df0a841a [IMP] contributing/documentation: document usage of code tabs
task-2787415

X-original-commit: 1e24b482b6
Part-of: odoo/documentation#1692
2022-03-11 14:44:46 +00:00
Demesmaeker
2a96d2c969 [IMP] payment_adyen: warn against partial capture
task-2784888

closes odoo/documentation#1652

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-03-11 12:47:35 +00:00
nle-odoo
8036fd51b5 [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#1686

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

closes odoo/documentation#1681

X-original-commit: 7e51c98636
Signed-off-by: Castillo Jonathan (jcs) <jcs@odoo.com>
2022-03-10 14:38:15 +00:00
Elisabeth Dickinson
66d3bf35d0 [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#1673

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

X-original-commit: b76a566522
Part-of: odoo/documentation#1673
2022-03-08 16:31:09 +00:00
Carlos Valverde
9c56734a3a [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#1666

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

closes odoo/documentation#1660

X-original-commit: b83df4f6d2
Signed-off-by: Victor Feyens (vfe) <vfe@odoo.com>
2022-03-07 14:33:38 +00:00
Jonathan Castillo (jcs)
3c552336da [IMP] install/maintain: new improved doc about domain names
task-id 2680490

closes odoo/documentation#1651

X-original-commit: cda64e2678
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
Signed-off-by: Castillo Jonathan (jcs) <jcs@odoo.com>
2022-03-03 17:54:35 +00:00
Laurent Stukkens
ee52601986 [ADD] developper: add gantt dependency fields
task-2691454

closes odoo/documentation#1529

Signed-off-by: Victor Feyens (vfe) <vfe@odoo.com>
2022-03-03 11:35:42 +00:00
Victor Feyens
d4367c4d9a [FIX] developer/http: adapt to recent httppocalypse changes
See https://github.com/odoo/odoo/pull/78857

closes odoo/documentation#1640

Signed-off-by: Victor Feyens (vfe) <vfe@odoo.com>
2022-02-28 15:25:48 +00:00
Jonathan Castillo (jcs)
a75c78e9d4 [IMP] accounting: fix a typo in eu_distance_selling.rst
closes odoo/documentation#1638

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

task-2685160

closes odoo/documentation#1631

X-original-commit: ff55b18aa2
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
Co-authored-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-02-23 17:28:41 +00:00
Stanislas Sobieski
71c45a1525 [FW][REV] odoo_sh: revert commit 6c48f90
closes odoo/documentation#1623

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

closes odoo/documentation#1617

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

X-original-commit: 6c48f90739
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-02-21 17:55:07 +00:00
Vincent Schippefilt
b49da1df09 [ADD] orm/changelog: Add a changelog page for the ORM changes
Introduce changelog of the ORM by version, link to first change documented

closes odoo/documentation#1508

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-02-21 16:27:59 +00:00
Antoine Vandevenne (anv)
0e89b54be2 [FIX] conf: upper-case 'master' in the version switcher
closes odoo/documentation#1604

X-original-commit: a7f0651773
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-02-16 12:01:41 +00:00
Demesmaeker
be8e8f0579 [ADD] general/payment_acquirers: add doc on Adyen manual capture
Add documentation about the manual capture for Adyen

closes odoo/documentation#1153

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-02-15 16:38:20 +00:00
Elisabeth Dickinson
1c2ea73923 [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#1595

X-original-commit: c30f2735b8
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-02-15 08:50:29 +00:00
Mathieu Duckerts-Antoine
9f179bd49d [IMP] hooks: useAutofocus new API
Recently, the API of useAutofocus has been simplified (see 4308de6aab).
Here we adapt its documentation.

closes odoo/documentation#1572

Signed-off-by: Mathieu Duckerts-Antoine <dam@odoo.com>
2022-02-11 16:06:42 +00:00
Antoine Vandevenne (anv)
dce73864eb [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#1583

X-original-commit: 3febaffd75
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-02-11 15:19:39 +00:00
Jonathan Castillo (jcs)
d8e4894f5b [IMP] install/maintain: add info about upgrading Odoo Online databases
closes odoo/documentation#1582

X-original-commit: 337b36320c
Signed-off-by: Castillo Jonathan (jcs) <jcs@odoo.com>
2022-02-11 13:44:03 +00:00
Antoine Vandevenne (anv)
e133c53f52 [IMP] supported_versions: emphasis short-term support of SaaS versions
X-original-commit: 31709ad082
Part-of: odoo/documentation#1582
2022-02-11 13:44:03 +00:00
Antoine Vandevenne (anv)
8d032bae61 [IMP] supported_versions: flag saas-15.1 as supported
X-original-commit: 696ab7de05
Part-of: odoo/documentation#1582
2022-02-11 13:44:03 +00:00
lejeune quentin
d827ce586c [ADD] point_of_sale: Connect an Worldline Payment Terminal to your PoS
Documentation to explain how to configure a Worldline Payment terminal.

closes odoo/documentation#1573

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

closes odoo/documentation#1569

X-original-commit: 45726dded7
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-02-10 13:32:01 +00:00
Mathieu Duckerts-Antoine
2269ee51e8 [REF] notifications: removal of param messageIsHtml
closes odoo/documentation#1557

Signed-off-by: Victor Feyens (vfe) <vfe@odoo.com>
2022-02-10 13:22:39 +00:00
Mathieu Duckerts-Antoine
484d245556 [IMP] hooks: document useAutofocus
Part-of: odoo/documentation#1557
2022-02-10 13:22:38 +00:00
StanvanHoorn
0754e169dc [FIX] install/maintain: update versions in "Installing Odoo"
closes odoo/documentation#1564

Signed-off-by: Castillo Jonathan (jcs) <jcs@odoo.com>
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-02-09 17:03:37 +00:00
Antoine Vandevenne (anv)
6172c98159 [ADD] developer/reference/frontend: add an icons library page
task-2704984

closes odoo/documentation#1462

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-02-08 14:26:42 +00:00
Antoine Vandevenne (anv)
cf6ca0fbb2 [IMP] contributing/doc, install: add an extension for content tabs
In many places in the docs, we need to document several flows that
differ only by a few details. For example, the steps to install Odoo
from the sources are almost identical for Windows, Linux, and Mac OS.
In other places, we'd want to suggest a command in different
environments or programming languages, etc.

This commit thus adds an extension for content tabs (tabs within the
content) to help reduce content repetition in the documentation. As a
proof of concept, the "Packaged installers" and "Source install"
sections of the "Installing Odoo" page are reworked to present their
content within tabs whenever it helps clarify the instructions.

A new python dependency is added as of this commit: `sphinx-tabs`

task-2713983

closes odoo/documentation#1528

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
Co-authored-by: Lucie Van Nieuwenhuyse (luvn) <luvn@odoo.com>
2022-02-07 16:44:01 +00:00
Jonathan Castillo (jcs)
b71cf50f9e [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#1556

X-original-commit: 79a33520a1
Signed-off-by: Castillo Jonathan (jcs) <jcs@odoo.com>
2022-02-07 16:11:59 +00:00
BVE
f2179ad8a0 [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#1550

X-original-commit: ce8a02d46a
Signed-off-by: Vergote Baptiste (bve) <bve@odoo.com>
2022-02-07 12:11:43 +00:00
Jonathan Castillo (jcs)
c40fbdbe0d [FW][FIX] accounting: fix module name to install in intrastat
closes odoo/documentation#1544

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

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

closes odoo/documentation#1535

X-original-commit: 6fb40b61c8
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
Signed-off-by: Arnold Moyaux <arm@odoo.com>
2022-02-04 14:36:52 +00:00
Demesmaeker
8966e001c2 [IMP] integration_testing: add information about JS touring
Adding basic information about `How to make a test tour`.

task-2742841

closes odoo/documentation#1524

X-original-commit: dbd5a1e1bb
Signed-off-by: Morgane Demesmaeker <edm@odoo.com>
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-02-02 15:55:41 +00:00
Niranjan Abhyankar
ce9cc2f48b [FIX] developer/javascript_cheatsheet: fix a typo
closes odoo/documentation#1521

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

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

closes odoo/documentation#1515

X-original-commit: a9bc16bec8
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
Co-authored-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-02-02 13:38:02 +00:00
Antoine Vandevenne (anv)
e4c963d7b6 [FIX] orm: remove autoattribute directive for BaseModel._sequence
The attribute was dropped with PR odoo/odoo#82727

closes odoo/documentation#1522

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-02-02 13:27:38 +00:00
Xavier (xpl)
c0ac2a7e13 [ADD] Sign: section on Field Types
Task #: 2585411

closes odoo/documentation#1513

X-original-commit: 7ca24b13ef
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-02-02 07:30:36 +00:00
Antoine Vandevenne (anv)
df35d8a093 [IMP] buckaroo: provide steps to set up a webhook
task-2692127

closes odoo/documentation#1481

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
Co-authored-by: <luvn@odoo.com>
2022-01-31 15:53:44 +00:00
Jonathan Castillo (jcs)
172d2e6e1b [FIX] redirects.txt: wrong path for outlook doc's redirection
These paths in redirects.txt miss the first folder level, starting from
/content/ .

closes odoo/documentation#1499

closes odoo/documentation#1507

X-original-commit: 4ac7ce7678
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-01-28 13:33:14 +00:00
Jonathan Castillo (jcs)
4e0c62ae03 [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

X-original-commit: cbe6aad9e9
Part-of: odoo/documentation#1507
2022-01-28 13:33:13 +00:00
wan
0222285869 [ADD] extensions: add a custom example admonition
closes odoo/documentation#1506

X-original-commit: 434bb66492
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-01-28 11:20:03 +00:00
Jennafer
3d74c4584b [FW][FIX] rdtraining: use "deprecate" rather than "depreciate"
Fixed one typo - "depreciated" to "deprecated"

closes odoo/documentation#1496

Forward-port-of: odoo/documentation#1490
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-01-26 17:53:23 +00:00
“Chiara
41b6e71d1d [REM] Accounting: deprecated report removal
Task-id 2744389

closes odoo/documentation#1494

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

task-2744043

closes odoo/documentation#1489

X-original-commit: b97ca3f44d
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-01-26 15:56:50 +00:00
Olivier Dony
aa5e03bf89 [FIX] legal/terms: fixups for ES translation of enterprise
closes odoo/documentation#1486

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

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

task-2685143

closes odoo/documentation#1483

X-original-commit: 587b2862df
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
Signed-off-by: Valentin Chevalier <vcr@odoo.com>
2022-01-25 15:05:08 +00:00
“Chiara
5db4c36e43 [ADD] Accounting: new page about intrastat
Task-id 2721400

closes odoo/documentation#1478

X-original-commit: aa7a78331d
Signed-off-by: Victor Feyens (vfe) <vfe@odoo.com>
2022-01-21 16:04:50 +00:00
Yajo
2c72491158 [FIX] discuss, cmdline: update for static outgoing mail addresses
This changed for Odoo 15.0 in odoo/odoo#61853 and the docs didn't
reflect that change.

MT-52 @moduon

closes odoo/documentation#1469

X-original-commit: 084fb777f9
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-01-13 12:09:21 +00:00
Stan
194f215662 [IMP] qweb: mention the two possible syntaxes for t-attf
closes odoo/documentation#1467

X-original-commit: cdb8d51131
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-01-12 09:56:04 +00:00
Demesmaeker
2e869a32e5 [ADD] general/payment_acquirers: add doc on Ogone Webhook Setup
task-2703230

closes odoo/documentation#1458

X-original-commit: dfdbf18afa
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-01-03 10:05:50 +00:00
Paolo (pgi)
b8f59ad24f [IMP] accounting: add FEC import section to l10n/france
task-id 2573140

closes odoo/documentation#979

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2021-12-21 11:08:36 +00:00
luvi
331b7b6285 [ADD] developer: actionswiper doc added
This commit adds the developer documentation for a
component recently added to the web_enterprise module.
It also includes examples and a screenshot used in the
documentation.

closes odoo/documentation#1432

X-original-commit: 7763c22db4
Signed-off-by: Géry Debongnie <ged@odoo.com>
Signed-off-by: Luca Vitali <luvi@odoo.com>
2021-12-21 07:42:52 +00:00
Mark Fischer, Jr
9a5518bd2c [FIX] expenses: grammar and typos in expenses.rst
Backport to 13.0 of PR #1175

closes odoo/documentation#1443

X-original-commit: 7090a54670
Signed-off-by: Castillo Jonathan (jcs) <jcs@odoo.com>
2021-12-17 16:31:36 +00:00
Christophe Monniez
aa1c6b3f07 [IMP] install/setup: install dependencies from debian packages
This commit changes the way that Odoo python dependencies should be
installed.

Before this commit, the described way to install Odoo dependencies was
by using the `pip` utility.

Now, we explicitly recommend to use a Debian based system and install
Odoo dependencies from their packaging tool.

The main reasons are:
* Odoo productions instances are, most of the time, run on Debian based
  systems with those package already installed
* That way, a developer cannot mistakenly use a feature from a
  dependency that does not exists on those production environments
* Avoid mixes of python packages on the developer/user 's system

closes odoo/documentation#1364

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

See related task: 2352566

closes odoo/documentation#1434

X-original-commit: dc832e1cc8
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2021-12-17 11:37:39 +00:00
Jairo Llopis
4dc1223caf [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 6cb3140ea8/odoo/modules/module.py (L348-L352)

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

closes odoo/documentation#1431

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

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

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

closes odoo/documentation#1426

Forward-port-of: odoo/documentation#1350
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2021-12-16 09:43:11 +00:00
Ivan Yelizariev
2c4bfb12c2 [IMP] cmdline: add note about --dev=xml
closes odoo/documentation#1066

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

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

closes odoo/documentation#1424

X-original-commit: a692dbdc9c
Signed-off-by: Victor Feyens (vfe) <vfe@odoo.com>
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2021-12-16 09:27:29 +00:00
TwioTech
e5516517b4 [IMP] PoS: six payment method configuration
closes odoo/documentation#1420

X-original-commit: 87faaaf02c
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
Co-authored-by: LoredanaLrpz <lrpz@odoo.com>
2021-12-15 11:48:57 +00:00
Adrien Minne
83a3eb5648 [FIX] rdtraining: fix wrong suggested folder for views
The training suggests to put the views in the data/ folder instead of the views/ folder

closes odoo/documentation#1418

X-original-commit: 9d45b861c0
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2021-12-15 08:53:05 +00:00
FrancoisGe
4335271352 [IMP] web: add tooltip on Dropdown
This commit adds the possibility to add a tooltip on a Dropdown.

closes odoo/documentation#1396

Signed-off-by: FrancoisGe <fge@odoo.com>
2021-12-15 08:12:01 +00:00
Samuel Degueldre
888fbb5c50 [IMP] web: adapt documentation to the removal of dropdown-item-selected
closes odoo/documentation#1404

Signed-off-by: Samuel Degueldre <sad@odoo.com>
2021-12-14 14:25:24 +00:00
Tymoteusz Motylewski
dccdca0f41 [IMP] backend/testing: add link to unittest python library
closes odoo/documentation#1416

X-original-commit: a8fe35665b
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2021-12-14 13:07:05 +00:00
Chris Parker
3ed9b8d435 [FIX] api/odoo: reflect the correct location of menu actions
closes odoo/documentation#1413

X-original-commit: beb92c9f18
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2021-12-14 12:08:40 +00:00
luxiaochuang
07f5559efe [FIX] howtos: remove useless <group/> tag from training example
closes odoo/documentation#1399

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

closes odoo/documentation#1408

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

closes odoo/documentation#1403

X-original-commit: a1db25d3ba
Signed-off-by: Victor Feyens (vfe) <vfe@odoo.com>
2021-12-13 10:14:42 +00:00
Xavier Morel
90546aa2cd [FIX] orm: documentation of the reserved fields
- reset the `currentmodule` so the fields are not attributed to
  `odoo.fields`, also prefix the field names (for a similar reason)
- expand `active` with the documentation of the related methods

closes odoo/documentation#1352

Signed-off-by: Xavier Morel (xmo) <xmo@odoo.com>
2021-12-10 08:12:53 +00:00
Xavier Morel
55c0c63835 [IMP] orm: TransientModel autodocumentation
* remove the documentation for `_auto`, `abstract`, and `_transient`
  as that's redundant with `Model`
* add documentation for transients' dedicated attributes (and main
  method whose docstring explains what actually occurs)

Part-of: odoo/documentation#1352
2021-12-10 08:12:53 +00:00
Xavier Morel
28534dce88 [ADD] conf: intersphinx entry for pillow
Allows us to properly link to pillow's docs from docstrings using the
python domain.

Part-of: odoo/documentation#1352
2021-12-10 08:12:53 +00:00
mdb-odoo
e6002983e6 [IMP] inventory: push/pull explanations
forward-port of e946f5fcfd
original commit (never merged) 427b14dcae

closes odoo/documentation#1393

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

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

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

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

X-original-commit: edddeb4826
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2021-12-09 12:23:54 +00:00
Moens Alexandre
881aecbe59 [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#1368

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

X-original-commit: 8bfa68e930
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2021-12-08 10:30:08 +00:00
Antoine Vandevenne (anv)
32b506457a [FIX] conf.py: allow matching odoo sources with ~ in the version string 2021-12-03 13:47:07 +01:00
2391 changed files with 10290 additions and 7124 deletions

2
.gitattributes vendored Normal file
View File

@@ -0,0 +1,2 @@
# Include RST files in language statistics on GitHub.
*.rst linguist-detectable

11
.github/CODEOWNERS vendored
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

3
.gitignore vendored
View File

@@ -1,6 +1,7 @@
*.pyc
.*
*.mo
.*
!.gitattributes
# Sphinx build files
_build/

View File

@@ -19,6 +19,8 @@ SPHINXOPTS = -D project_root=$(ROOT) -D canonical_version=$(CANONICAL_VERSIO
-D versions=$(VERSIONS) -D languages=$(LANGUAGES) -D language=$(CURRENT_LANG) \
-D is_remote_build=$(IS_REMOTE_BUILD) \
-A google_analytics_key=$(GOOGLE_ANALYTICS_KEY) \
-A plausible_script=$(PLAUSIBLE_SCRIPT) \
-A plausible_domain=$(PLAUSIBLE_DOMAIN) \
-j $(WORKERS)
SOURCE_DIR = content
@@ -77,6 +79,6 @@ $(HTML_BUILD_DIR)/_static/style.css: extensions/odoo_theme/static/style.scss ext
fast: SPHINXOPTS += -A collapse_menu=True
fast: html
static: $(HTML_BUILD_DIR)/static/style.css
static: $(HTML_BUILD_DIR)/_static/style.css
cp -r extensions/odoo_theme/static/* $(HTML_BUILD_DIR)/_static/
cp -r static/* $(HTML_BUILD_DIR)/_static/

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

151
conf.py
View File

@@ -1,9 +1,12 @@
import re
import os
import shutil
import sys
from pathlib import Path
import docutils
from pygments.lexers import JsonLexer, XmlLexer
from sphinx.ext import graphviz
from sphinx.util import logging
import sphinx
@@ -53,6 +56,11 @@ add_function_parentheses = True
#=== Extensions configuration ===#
source_read_replace_vals = {
'GITHUB_PATH': f'https://github.com/odoo/odoo/blob/{version}',
'GITHUB_ENT_PATH': f'https://github.com/odoo/enterprise/blob/{version}',
}
# Add extensions directory to PYTHONPATH
extension_dir = Path('extensions')
sys.path.insert(0, str(extension_dir.absolute()))
@@ -74,13 +82,18 @@ if not odoo_sources_dirs:
{'dir_list': '\n'.join([f'\t- {d.resolve()}' for d in odoo_sources_candidate_dirs])},
)
else:
odoo_dir = odoo_sources_dirs[0].resolve()
sys.path.insert(0, str(odoo_dir))
if (3, 6) < sys.version_info < (3, 7):
# Running odoo needs python 3.7 min but monkey patch version_info to be compatible with 3.6
# Running odoo needs python 3.7 min but monkey patch version_info to be compatible with 3.6.
sys.version_info = (3, 7, 0)
odoo_dir = odoo_sources_dirs[0].resolve()
source_read_replace_vals['ODOO_RELPATH'] = '/../' + str(odoo_sources_dirs[0])
source_read_replace_vals['ODOO_ABSPATH'] = str(odoo_dir)
sys.path.insert(0, str(odoo_dir))
import odoo.addons
odoo.addons.__path__.append(str(odoo_dir) + '/addons')
from odoo import release as odoo_release # Don't collide with Sphinx's 'release' config option
odoo_version = odoo_release.version if 'alpha' not in odoo_release.version else 'master'
odoo_version = odoo_release.version.replace('~', '-') # Change saas~XX.Y to saas-XX.Y
odoo_version = 'master' if 'alpha' in odoo_release.version else odoo_version
if release != odoo_version:
_logger.warning(
"Found Odoo sources in %(directory)s but with version '%(odoo_version)s' incompatible "
@@ -97,12 +110,18 @@ else:
)
odoo_dir_in_path = True
# Mapping between odoo models related to master data and the declaration of the
# data. This is used to point users to available xml_ids when giving values for
# a field with the autodoc_field extension.
model_references = {
'account.account.type': 'addons/account/data/data_account_type.xml',
'res.country': 'odoo/addons/base/data/res_country_data.xml',
'res.currency': 'odoo/addons/base/data/res_currency_data.xml',
}
# The Sphinx extensions to use, as module names.
# They can be extensions coming with Sphinx (named 'sphinx.ext.*') or custom ones.
extensions = [
# Parse Python docstrings (autodoc, automodule, autoattribute directives)
'sphinx.ext.autodoc' if odoo_dir_in_path else 'autodoc_placeholder',
# Link sources in other projects (used to build the reference doc)
'sphinx.ext.intersphinx',
@@ -115,27 +134,37 @@ 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 += [
'sphinx.ext.linkcode',
'github_link',
# Parse Python docstrings (autodoc, automodule, autoattribute directives)
'sphinx.ext.autodoc',
'autodoc_field',
]
else:
extensions += [
'autodoc_placeholder',
]
extensions.append('sphinx.ext.graphviz' if shutil.which('dot') else 'graphviz_placeholder')
todo_include_todos = False
intersphinx_mapping = {
'pillow': ('https://pillow.readthedocs.io/en/stable/', None),
'python': ('https://docs.python.org/3/', None),
'werkzeug': ('https://werkzeug.palletsprojects.com/en/1.0.x/', None),
}
@@ -151,7 +180,20 @@ 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 = {
# 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",
'saas-15.2': "Odoo Online",
'saas-15.1': "Odoo Online",
'15.0': "Odoo 15",
'14.0': "Odoo 14",
'13.0': "Odoo 13",
}
# 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': 'Deutsch',
'en': 'English',
'es': 'Español',
@@ -165,6 +207,9 @@ supported_languages = {
# The specifications of redirect rules used by the redirects extension.
redirects_file = 'redirects.txt'
sphinx_tabs_disable_tab_closing = True
sphinx_tabs_disable_css_loading = True
#=== Options for HTML output ===#
html_theme = 'odoo_theme'
@@ -247,6 +292,22 @@ latex_logo = 'static/img/odoo_logo.png'
# If true, show URL addresses after external links.
latex_show_urls = 'True'
# https://github.com/sphinx-doc/sphinx/issues/4054#issuecomment-329097229
def source_read_replace(app, docname, source):
"""Substitute parts of strings with computed values.
Since the RST substitution is not working everywhere, i.e. in directives'
options, we need to be able to input those values when reading the sources.
This is using the config `source_read_replace_vals`, mapping a name to its
replacement. This will look for the name surrounded by curly braces in the source.
Meant to be connected to the `source-read` event.
"""
result = source[0]
for key in app.config.source_read_replace_vals:
result = result.replace(f"{{{key}}}", app.config.source_read_replace_vals[key])
source[0] = result
def setup(app):
# Generate all alternate URLs for each document
@@ -255,12 +316,34 @@ def setup(app):
app.add_config_value('versions', None, 'env')
app.add_config_value('languages', None, 'env')
app.add_config_value('is_remote_build', None, 'env') # Whether the build is remotely deployed
app.add_config_value('source_read_replace_vals', {}, 'env')
app.connect('source-read', source_read_replace)
app.add_lexer('json', JsonLexer)
app.add_lexer('xml', XmlLexer)
app.connect('html-page-context', _generate_alternate_urls)
# Add a `condition` option on directives to ignore them based on config values
app.add_config_value('odoo_dir_in_path', None, 'env')
def context_eval(expr):
return eval(expr, {confval.name: confval.value for confval in app.config})
def patch(to_patch):
to_patch.option_spec['condition'] = context_eval
original_run = to_patch.run
def new_run(self):
if not self.options.get('condition', True):
return []
return original_run(self)
to_patch.run = new_run
for to_patch in (
sphinx.directives.code.LiteralInclude,
docutils.parsers.rst.directives.tables.CSVTable,
):
patch(to_patch)
def _generate_alternate_urls(app, pagename, templatename, context, doctree):
""" Add keys of required alternate URLs for the current document in the rendering context.
@@ -292,15 +375,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')
) and not _alternate_version.startswith('saas')
]
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.
@@ -311,19 +397,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:

View File

@@ -4,6 +4,8 @@
Install
=======
.. If you add content on this page, remove the redirect rule 'install -> install/install'
.. toctree::
install/install

View File

@@ -7,7 +7,7 @@ internet-facing server. It follows :ref:`installation <setup/install>`, and is
not generally necessary for a development systems that is not exposed on the
internet.
.. warning:: If you are setting up a public server, be sure to check our :ref:`security` recommandations!
.. warning:: If you are setting up a public server, be sure to check our :ref:`security` recommendations!
.. _db_filter:
@@ -299,7 +299,7 @@ in ``/etc/nginx/sites-enabled/odoo.conf`` set:
}
server {
listen 443;
listen 443 ssl;
server_name odoo.mycompany.com;
proxy_read_timeout 720s;
proxy_connect_timeout 720s;
@@ -312,7 +312,6 @@ in ``/etc/nginx/sites-enabled/odoo.conf`` set:
proxy_set_header X-Real-IP $remote_addr;
# SSL parameters
ssl on;
ssl_certificate /etc/ssl/nginx/server.crt;
ssl_certificate_key /etc/ssl/nginx/server.key;
ssl_session_timeout 30m;

View File

@@ -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>`.

File diff suppressed because it is too large Load Diff

View File

@@ -6,6 +6,7 @@ Maintain
.. toctree::
maintain/domain_names
maintain/update
maintain/enterprise
maintain/hosting_changes

View File

@@ -0,0 +1,334 @@
============
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.
To do so, go to :menuselection:`Website --> Go to website --> Promote --> Domain Name`.
Alternatively, open your `database manager <https://www.odoo.com/my/databases>`_, click on the
:guilabel:`settings` button next to your database, then on :guilabel:`Domain names`.
.. image:: domain_names/register-promote.png
:align: center
:alt: Clicking on Domain Names from an Odoo website
Search for the domain name of your choice to check its availability, then select the one you want to
register for your website.
.. image:: domain_names/register-search.png
:align: center
:alt: The search of the domain name example.com shows which associated domains are available.
Next, fill in the form with your information to become the domain name owner.
Your domain name is directly linked to your database, but you still have to :ref:`map your domain
name with your website <domain-name/website-map>`.
.. note::
- Free domain names are also available for free Odoo Online databases (if you installed one app
only, for example). In this case, Odoo reviews your request and your website to avoid abuse.
This process may take up to three days.
- This is not available for Odoo.sh databases yet.
.. _domain-name/odoo-manage:
Manage your domain name registered with Odoo
--------------------------------------------
To manage the DNS records of your domain name registered with Odoo or to visualize the contacts
associated with it, open your `database manager <https://www.odoo.com/my/databases>`_, click on the
:guilabel:`settings` button next to your database, on :guilabel:`Domain names`, and then on
:guilabel:`Contacts` or :guilabel:`DNS`.
.. image:: domain_names/manage.png
:align: center
:alt: Management of the domain names linked to an Odoo database
.. note::
Please `submit a support ticket <https://www.odoo.com/help>`_ if you need further assistance to
manage your domain name.
.. _domain-name/existing:
Configure your existing domain name
===================================
If you already own a domain name, you can use it to point to your website.
To avoid any issue with the :ref:`SSL certificate validation <domain-name/ssl>`, we highly recommend
that you proceed with the following actions in this order:
#. :ref:`Add a CNAME record <domain-name/cname>` on your domain name's DNS zone.
#. :ref:`Map your domain name with your Odoo database <domain-name/db-map>`.
#. :ref:`Map your domain name with your Odoo website <domain-name/website-map>`.
.. _domain-name/cname:
Add a CNAME record
------------------
A **CNAME record** is a type of DNS record that points to the 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
~~~~~~~~~~~~~~~~~~~~~~~~~~
.. note::
If you have Odoo Website, you can disregard this part and directly :ref:`map your domain name
with your website <domain-name/website-map>`.
The **web base URL** of a database, or **root URL** affects your main website address and all the
links sent to your customers (e.g., quotations, portal links, etc.).
To configure it, access your Odoo database with your custom address, then log in as an administrator
of your database (any user in the *Settings* group) from the login screen.
.. warning::
Connecting to your database with the original Odoo subdomain address (e.g., ``example.odoo.com``
also updates the web base URL of your database. See below to prevent these automatic updates.
Alternatively, you can do it manually. To do so, activate the :ref:`developer mode
<developer-mode>`, then go to :menuselection:`Settings --> Technical --> System Parameters`.
Find the key called ``web.base.url`` (or create it if it does not exist) and enter the full address
of your website as value, such as ``https://www.example.com``.
.. note::
The URL must include the protocol ``https://`` (or ``http://``) and must not end with a slash
(``/``).
To prevent the automatic update of the web base URL when an administrator logs in the database, you
can create the following System Parameter:
- key: ``web.base.url.freeze``
- value: ``True``
.. _domain-name/website-map:
Map your domain name with your website
======================================
Mapping your domain name to your website isn't the same as mapping it with your database:
- It defines your domain name as the main one for your website, helping search engines to index your
website properly.
- It defines your domain name as the base URL for your database, including the portal links sent by
email to your customers.
- If you have multiple websites, it maps your domain name with the appropriate website.
Go to :menuselection:`Website --> Configuration --> Settings --> Website Info`. If you have multiple
websites, select the one you want to configure.
In the :guilabel:`Domain` field, fill in the web address of your website (e.g.,
``https://www.example.com``) and click on :guilabel:`Save`.
.. image:: domain_names/website-settings.png
:align: center
:alt: Configuring https://www.example.com as the Domain of the website
.. warning::
Mapping your domain name with your Odoo website prevents Google from indexing both your custom
domain name ``www.example.com`` and your original odoo database address ``example.odoo.com``.
If both addresses are already indexed, it may take some time before Google removes the indexation
of the second address. You may also try using the `Google Search Console
<https://search.google.com/search-console/welcome>`_ to fix this.
.. note::
If you have multiple websites and companies on your database, make sure that you select the
right :guilabel:`Company` in the website settings, next to the :guilabel:`Domain` settings. Doing
so indicates Odoo which URL to use as the :ref:`base URL <domain-name/web-base-url>` according to
the company in use.
.. seealso::
- :doc:`/applications/general/email_communication/email_servers`

Binary file not shown.

After

Width:  |  Height:  |  Size: 12 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 8.9 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 22 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 38 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 32 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 7.2 KiB

View File

@@ -49,7 +49,7 @@ From Odoo.sh to Odoo Online
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).
3. `Create a support ticket <https://www.odoo.com/help>`_ and 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!

View File

@@ -9,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

View File

@@ -35,14 +35,26 @@ Several actions are available:
Upgrade
=======
Upgrade the database to the latest Odoo version.
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).
.. warning::
Upgrading a database to a newer version of Odoo is a complex operation that requires time and
caution. It is essential to test the upgrade before upgrading the production database.
.. 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/process`
- :doc:`../upgrade`
- :doc:`supported_versions`
.. _online/duplicate:
@@ -83,7 +95,7 @@ Domains
Configure custom domains to access the database via another URL.
.. seealso::
- :doc:`/applications/websites/website/publish/domain_name`
- :doc:`domain_names`
.. _online/tags:

View File

@@ -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?
=====================================
@@ -23,36 +25,39 @@ This matrix shows the support status of every version.
+-----------------+-------------+----------+-------------+----------------+------------------------+
| | Odoo Online | Odoo.sh | On-Premise | Release date | End of support |
+=================+=============+==========+=============+================+========================+
| 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** | |green| | |green| | |green| | October 2019 | October 2022 (planned) |
+-----------------+-------------+----------+-------------+----------------+------------------------+
| Odoo 12.saas~3 | |orange| | N/A | N/A | August 2019 | |
| Odoo saas~12.3 | |red| | N/A | N/A | August 2019 | |
+-----------------+-------------+----------+-------------+----------------+------------------------+
| **Odoo 12.0** | |orange| | |orange| | |red| | October 2018 | October 2021 |
| **Odoo 12.0** | |red| | |red| | |red| | October 2018 | October 2021 |
+-----------------+-------------+----------+-------------+----------------+------------------------+
| Odoo 11.saas~3 | |orange| | N/A | N/A | April 2018 | |
| Odoo saas~11.3 | |red| | N/A | N/A | April 2018 | |
+-----------------+-------------+----------+-------------+----------------+------------------------+
| **Odoo 11.0** | |orange| | |orange| | |red| | October 2017 | October 2020 |
| **Odoo 11.0** | |red| | |red| | |red| | October 2017 | October 2020 |
+-----------------+-------------+----------+-------------+----------------+------------------------+
| Odoo 10.saas~15 | |orange| | N/A | N/A | March 2017 | |
| Odoo 10.saas~15 | |red| | N/A | N/A | March 2017 | |
+-----------------+-------------+----------+-------------+----------------+------------------------+
| Odoo 10.saas~14 | |orange| | N/A | N/A | January 2017 | |
| Odoo 10.saas~14 | |red| | N/A | N/A | January 2017 | |
+-----------------+-------------+----------+-------------+----------------+------------------------+
| **Odoo 10.0** | |orange| | |orange| | |red| | October 2016 | October 2019 |
| **Odoo 10.0** | |red| | |red| | |red| | October 2016 | October 2019 |
+-----------------+-------------+----------+-------------+----------------+------------------------+
| Odoo 9.saas~11 | |orange| | N/A | N/A | May 2016 | |
| Odoo 9.saas~11 | |red| | N/A | N/A | May 2016 | |
+-----------------+-------------+----------+-------------+----------------+------------------------+
| **Odoo 9.0** | |orange| | N/A | |red| | October 2015 | October 2018 |
| **Odoo 9.0** | |red| | N/A | |red| | October 2015 | October 2018 |
+-----------------+-------------+----------+-------------+----------------+------------------------+
| Odoo 8.saas~6 | |orange| | N/A | N/A | February 2015 | |
| Odoo 8.saas~6 | |red| | N/A | N/A | February 2015 | |
+-----------------+-------------+----------+-------------+----------------+------------------------+
| **Odoo 8.0** | |orange| | N/A | |red| | September 2014 | October 2017 |
| **Odoo 8.0** | |red| | N/A | |red| | September 2014 | October 2017 |
+-----------------+-------------+----------+-------------+----------------+------------------------+
.. note::
|green| Supported version
@@ -61,11 +66,8 @@ 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
.. This is an awful way to display colored circles but "Large Green Circle Emoji" was only released
in 2019 (see https://unicode-table.com/en/1F7E2/). Let's wait a few more years...
@@ -75,9 +77,6 @@ This matrix shows the support status of every version.
.. |red| image:: data:image/svg+xml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHZpZXdCb3g9IjAgMCAyMzIuMTkgMjMyLjE5Ij48Y2lyY2xlIGN4PSIxMTYuMDkiIGN5PSIxMTYuMDkiIHI9IjExNi4wOSIgc3R5bGU9ImZpbGw6I2QwMDAwMCIvPjwvc3ZnPg==
:width: 15
.. |orange| image:: data:image/svg+xml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHZpZXdCb3g9IjAgMCAyMzIuMTkgMjMyLjE5Ij48Y2lyY2xlIGN4PSIxMTYuMDkiIGN5PSIxMTYuMDkiIHI9IjExNi4wOSIgc3R5bGU9ImZpbGw6I2ZmYTcwMCIvPjwvc3ZnPg==
:width: 15
I run an older version of Odoo/OpenERP/TinyERP
==============================================

View File

@@ -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.

View File

Before

Width:  |  Height:  |  Size: 72 KiB

After

Width:  |  Height:  |  Size: 72 KiB

View File

@@ -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:

View File

@@ -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:
@@ -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.
@@ -283,7 +285,7 @@ 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 +302,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 +384,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 +397,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 +466,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 +485,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,

View File

Before

Width:  |  Height:  |  Size: 4.7 KiB

After

Width:  |  Height:  |  Size: 4.7 KiB

View File

@@ -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:

View File

@@ -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

View File

Before

Width:  |  Height:  |  Size: 24 KiB

After

Width:  |  Height:  |  Size: 24 KiB

View File

Before

Width:  |  Height:  |  Size: 29 KiB

After

Width:  |  Height:  |  Size: 29 KiB

View File

Before

Width:  |  Height:  |  Size: 34 KiB

After

Width:  |  Height:  |  Size: 34 KiB

View File

@@ -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

Binary file not shown.

Before

Width:  |  Height:  |  Size: 1.6 KiB

View File

@@ -12,7 +12,7 @@ The online editor allows you to edit the source code of your builds from a web b
It also gives you the possibility to open terminals, Python consoles, Odoo Shell consoles and
`Notebooks <https://jupyterlab.readthedocs.io/en/stable/user/notebook.html>`_.
.. image:: ./media/interface-editor.png
.. image:: online-editor/interface-editor.png
:align: center
You can access the editor of a build through
@@ -66,20 +66,20 @@ server is not a good practice.
To open a file in the editor, just double-click on it in the file browser panel on the left.
.. image:: ./media/interface-editor-open-file.png
.. image:: online-editor/interface-editor-open-file.png
:align: center
You can then begin to make your changes. You can save your changes with the menu
:menuselection:`File --> Save .. File` or by hitting the :kbd:`Ctrl+S` shortcut.
.. image:: ./media/interface-editor-save-file.png
.. image:: online-editor/interface-editor-save-file.png
:align: center
If you save a Python file which is under your Odoo server addons path,
Odoo will detect it and reload automatically so your changes are reflected immediately,
without having to restart the server manually.
.. image:: ./media/interface-editor-automaticreload.gif
.. image:: online-editor/interface-editor-automaticreload.gif
:align: center
However, if the change is a data stored in database, such as the label of a field, or a view,
@@ -88,7 +88,7 @@ You can update the module of the currently opened file by using the menu
:menuselection:`Odoo --> Update current module`. Note that the file considered as currently opened
is the file focused in the text editor, not the file highlighted in the file browser.
.. image:: ./media/interface-editor-update-current-module.png
.. image:: online-editor/interface-editor-update-current-module.png
:align: center
You can also open a terminal and execute the command:
@@ -118,7 +118,7 @@ In this last command,
* <branch> must be replaced by the name of the branch to which you want to push the changes,
most-likely the current branch if you work in a development build.
.. image:: ./media/interface-editor-commit-push.png
.. image:: online-editor/interface-editor-commit-push.png
:align: center
.. Note::
@@ -160,7 +160,7 @@ Thanks to this, you will be able to display objects in HTML.
You can for instance display cells of a CSV file using
`pandas <https://pandas.pydata.org/pandas-docs/stable/tutorials.html>`_.
.. image:: ./media/interface-editor-console-python-read-csv.png
.. image:: online-editor/interface-editor-console-python-read-csv.png
:align: center
You can also open an Odoo Shell console to play around
@@ -189,12 +189,12 @@ to easily display lists and dicts in a pretty way, using the
`rich display <https://ipython.readthedocs.io/en/stable/config/integrating.html#rich-display>`_
mentioned above.
.. image:: ./media/interface-editor-console-odoo-pretty.png
.. image:: online-editor/interface-editor-console-odoo-pretty.png
:align: center
You can also use
`pandas <https://pandas.pydata.org/pandas-docs/stable/tutorials.html>`_
to display graphs.
.. image:: ./media/interface-editor-console-odoo-graph.png
.. image:: online-editor/interface-editor-console-odoo-graph.png
:align: center

View File

@@ -8,7 +8,7 @@ Overview
The settings allow you to manage the configuration of your project.
.. image:: ./media/interface-settings.png
.. image:: settings/interface-settings.png
:align: center
Project name
@@ -16,7 +16,7 @@ Project name
The name of your project.
.. image:: ./media/interface-settings-projectname.png
.. image:: settings/interface-settings-projectname.png
:align: center
This defines the address that will be used to access your production database.
@@ -31,7 +31,7 @@ Collaborators
Manage the Github users who can access your project.
.. image:: ./media/interface-settings-collaborators.png
.. image:: settings/interface-settings-collaborators.png
:align: center
There are two levels of users:
@@ -87,7 +87,7 @@ Public Access
Allow public access to your development builds.
.. image:: ./media/interface-settings-public.png
.. image:: settings/interface-settings-public.png
:align: center
If activated, this option exposes the Builds page publicly, allowing visitors to connect to your development builds.
@@ -117,7 +117,7 @@ as submodules in your branches to allow Odoo.sh to download them.
If you are looking on how to set up your submodules,
instructions are available in the chapter :ref:`Submodules <odoosh-advanced-submodules>` of this documentation.
.. image:: ./media/interface-settings-submodules.png
.. image:: settings/interface-settings-submodules.png
:align: center
When a repository is private, it is not possible to publicly download its branches and revisions.
@@ -148,7 +148,7 @@ Storage Size
This section shows the storage size used by your project.
.. image:: ./media/interface-settings-storage.png
.. image:: settings/interface-settings-storage.png
:align: center
Storage size is computed as follows:
@@ -170,7 +170,7 @@ Additional database workers can be configured here. More workers help increase t
production database is able to handle. If you add more, it will automatically be synchronized
with your subscription.
.. image:: ./media/interface-settings-workers.png
.. image:: settings/interface-settings-workers.png
:align: center
.. Warning::
@@ -185,7 +185,7 @@ Staging Branches
Additional staging branches allow you to develop and test more features at the same time. If you
add more, it will automatically be synchronized with your subscription.
.. image:: ./media/interface-settings-staging-branches.png
.. image:: settings/interface-settings-staging-branches.png
:align: center
Activation
@@ -193,5 +193,5 @@ Activation
Shows the status of the project's activation. You can change the project's activation code if needed.
.. image:: ./media/interface-settings-activation.png
.. image:: settings/interface-settings-activation.png
:align: center

View File

@@ -8,5 +8,5 @@ Overview
The status page shows statistics regarding the servers your project uses. It includes the servers availability.
.. image:: ./media/interface-status.png
.. image:: status/interface-status.png
:align: center

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