This adds a simple documentation for the editor's Powerbox and creates
the base for the editor's own documentation in general.
closesodoo/documentation#2586
Signed-off-by: Antoine Guenet (age) <age@odoo.com>
Correction to a typo that made the line completly nonsensical and made
people think that they could migrate just part of the database.
opw-2947684
closesodoo/documentation#2605
X-original-commit: a92671bd85
Signed-off-by: Castillo Jonathan (jcs) <jcs@odoo.com>
Even though the documentation was correct, it was confusing the reader
to state that local payment methods are considered enabled if their
related payment icon record does not exist in the database. The intended
meaning was that this statement only holds if the local payment method
is also supported, otherwise it cannot be enabled.
closesodoo/documentation#2592
X-original-commit: 8bcaa08531
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
In Odoo v15, the field names for "Timesheet on Ticket" and "Time
Reinvoicing" changed to "Timesheets" and "Time Billing", respectively.
The "Tickets" button on the project card is also no longer available in
Odoo v15. Updated the RST file to reflect these changes, and also
updated screenshots to match.
Fixes PR #2094
Closes Odoo Task 2870115
closesodoo/documentation#2580
X-original-commit: 30a38d23d0
Signed-off-by: Victor Feyens (vfe) <vfe@odoo.com>
In the toctree, "MRP" wasn't capitalized in "Inventory & MRP."
Affects all branches, can be forward ported.
closesodoo/documentation#2566
X-original-commit: 8c665643ce
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
Signed-off-by: Castillo Jonathan (jcs) <jcs@odoo.com>
Current documentation is quite incomplete and not really sufficient to
write up a tour without looking at existing examples.
Try to better document the various options, and the relation between
`trigger`, `extra_trigger` (underscore, not dash), and `run`.
Also add the missing `content` and `timeout` step attributes.
closesodoo/documentation#2550
Related: odoo/odoo#96517
Related: odoo/enterprise#29824
Signed-off-by: Xavier Morel (xmo) <xmo@odoo.com>
This is a new documentation for the Ingenico payment provider, as support received a lot of tickets from customers having issues setting-up ingenico properly.
task - 2834329
closesodoo/documentation#2527
X-original-commit: b064a7ed6b
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
Signed-off-by: Aarab Tom (toaa) <toaa@odoo.com>
The goal is to make the Studio users doc a sort of encyclopedia to accompany tutorials.
The doc isn't to explain the basics - or just briefly, as introductions - but instead to
give a full overview of all the available options.
closesodoo/documentation#2531
Task: 2817981
X-original-commit: c8ea9703f7
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
The referenced `bypass.py` file isn't specified anywhere in
the training documentation or code content.
The paragraph is removed to avoid meaningless searches and
confusing trainees.
This commit also adds a missing parenthese in the preceding
code content.
Fixes#2488closesodoo/documentation#2523
X-original-commit: 1c4abe4e07
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
Google deprecated both its "Universal Analytics" and "Google Sign-In"
API. See community counterpart commit for a detailed explanation and
links.
closesodoo/documentation#2499
X-original-commit: 0d01565ac3
Related: odoo/odoo#96280
Related: odoo/enterprise#29666
Related: odoo/upgrade#3698
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
Signed-off-by: Romain Derie (rde) <rde@odoo.com>
Documentation for the task of adding a maximum amount filter on
acquirers.
Doc task - 4720
RD taks - 2162165
closesodoo/documentation#1835
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
The warning about float utils does not state where to find them, and
they are preceded by an example in the code that infringes the warning's
recommendation.
This commit indicates where to find the float utils and replaces the
example by one that uses them.
task-2925402
closesodoo/documentation#2513
X-original-commit: b8ee134a28
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
When installing requirements, the psycopg requirement can fail
because the $PATH does not contain the postgresql tools installed with
the .app.
This commit provides instructions to avoid this issue.
task-2922249
closesodoo/documentation#2506
X-original-commit: c40cf83073
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
Before this commit, it was impossible to migrate from one payment
acquirer to another as the only way to do so was to change a payment
acquirer’s state to ‘disabled’, subsequently disabling all tokens of that
acquirer (detrimental for eg. running subscriptions).
After this commit, payment acquirers have an additional boolean
‘Published’. With this functionality, users can safely migrate by
keeping an acquirer ‘enabled’, but invisible for customers.
There are five combined states an acquirer can take:
1. ‘enabled’ & ‘published’: Visible to all users
2. ‘enabled’ & ‘unpublished’: Visible only to internal users
3. ‘disabled’ & ‘unpublished’: Same as previously ‘disabled’
4. ‘test’ & ‘published’: Same as previously ‘test’
5. ‘test’ & ‘unpublished’: visible only to internal users
task-2871459
closesodoo/documentation#2308
Related: odoo/odoo#94242
Related: odoo/upgrade#3688
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
The `file` option for the `csv-table` directive expects relative file
paths rather than absolute file paths since Sphinx 4. Since this was the
only usage of the `ODOO_ABSPATH` placeholder, it is removed with this
commit.
Task - 2898477
closesodoo/documentation#2455
Signed-off-by: Victor Feyens (vfe) <vfe@odoo.com>
In an attempt to help new developers install Odoo with a
straightforward procedure, Chapter 2 of the "Getting started" tutorial
included copy-pastes of parts of the "Installing Odoo" page. This proved
to be inefficient because it required maintaining documentation on the
installation procedure in several places and misled the readers by
suggesting installing the Python requirements *after* installing
PostgreSQL.
With this commit, the page on Chapter 2 is refreshed to be clearer to
the readers and redirect them to the "Installing Odoo" page when
necessary.
task-2908434
closesodoo/documentation#2480
X-original-commit: 524794c59c
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
If committed, this will delete mentions of project tasks in the "Invoice
Time Spent on Tickets (Postpaid Support Services)" v14.0 user doc. It
also deletes unnecessary steps and screenshots about creating and
configuring a new Project and updates the steps and screenshots for the
"Create a sales order" and "Link the Helpdesk ticket to the SO" sections.
Fixes PR #1901
Closes Odoo Task 2870104
closesodoo/documentation#2479
X-original-commit: 521cee8aa0
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
Added document and media files on the setup of Google Gmail using OAuth with Odoo.
closesodoo/documentation#2476
X-original-commit: 9b75dfd2ac
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
Prior to this commit, the /legal.html page relied on RST substitutions
to insert the images directives of legal agreements within the table.
This caused Sphinx to omit the `image-reference` class on all `<a>`
elements surrounding an `<img>` element, which it normally adds when the
`target` option is specified on an `image` directive. As the theme
relies on that class to hide the "external link" icon added with commit
343decf1, the layout of the page was broken.
While replacing the substitutions with the plain `image` directive, the
grid table is converted to a list table to avoid the hassle of expanding
table cells to fit the directives. This will also help in maintaining
the content of the table when we will add new translations for the legal
agreements.
task-2909167
closesodoo/documentation#2467
X-original-commit: 81bf067ba1
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
The images that have the class `o-no-modal` cannot be clicked to open in
a modal, so the cursor should not be changed to a pointer when hovering
on them.
This commit also simplifies the theme's SCSS by replacing the hard-coded
SVG images used in the "Supported versions" page by unicode circles with
a custom styling.
X-original-commit: f648960c78
Part-of: odoo/documentation#2467
Co-authored-by: Elisabeth Dickinson (edi) <edi@odoo.com>
Since clicking on the image redirects the user to the target URL, it's
useless to open the image in a modal. Also, it partially broke the
layout of the /legal.html page due to the modal div being inserted into
table cells.
This commit also introduces the possibility to add the `o-no-modal`
class on images that should not open in a modal.
task-2909167
X-original-commit: 7cbbb77746
Part-of: odoo/documentation#2467
With the renaming of the "Backend" and "Frontend" directories to "Python
framework" and "JavaScript framework", and since we may want to document
modules that mainly rely on JavaScript, it makes sense to move the
"Standard modules" one level up from under "Python framework" directly
under "Reference".
closesodoo/documentation#2459
X-original-commit: 62e80093bd
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
It was confusing to label the directory for pages related to the Python
framework "Backend" as, in Odoo, the backend is the web client, and the
frontend is the portal/website. It also led to the "Standard modules"
directory to be placed within the "Backend" directory as of `saas-15.1`
to indicate that they were part of the backend too, but that was a
mistake. Indeed, most standard modules comprise JavaScript methods, and
we could want to document these in the reference at some point.
X-original-commit: 8046f742bc
Part-of: odoo/documentation#2459
Task ID:2893426
Since Six payment terminal won't be usable starting in July 2022, I
added this warning.
closesodoo/documentation#2425
X-original-commit: ceec1b0436
Signed-off-by: Castillo Jonathan (jcs) <jcs@odoo.com>
Signed-off-by: Perazzo Loredana (lrpz) <lrpz@odoo.com>
task - 2904108 I removed the "website/publish" section from the toctree to add a link to the full website documentation inside off the see also.
closesodoo/documentation#2420
X-original-commit: 7307dac6a6
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
Both carrier name and tracking reference are now displayed to the
customer, even when using the carrie `Self Delivery`
task-2900803
closesodoo/documentation#2412
X-original-commit: 471d0c2094
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
Before this commit, the "Developer/Misc" directory of the doc, and
more particularly the "Developer/Misc/Other" sub-directory, was used as
a garbage dump where we moved all the pages that didn't fit elsewhere.
Due to that, interesting and important pages, such as the Coding
Guidelines, were buried in that directory never to be read again by Odoo
developers.
This commit moves most pages under "Misc" one or two levels up to be
located directly under "Developer" hence making them more accessible. A
new "Contributing/Development" directory is added to host the Coding
Guidelines page and soon many other pages.
task-2897143
closesodoo/documentation#2381
X-original-commit: 12ff9f118b
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
Now that a new styling for API references was added with commit 934f45c,
we can remove the extra CSS that was crafted specifically for JavaScript
API references with commit 05a0a49a. While we're at it, this commit also
applies the new styling to definition lists that were missing it, like
it was done for the page on views with commit 120ae785.
closesodoo/documentation#2378
X-original-commit: 31a9d4a340
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
Adyen's backend had slightly changed and the previous doc version was outdated (URL and HMAC key fields)
task - 2810213
closesodoo/documentation#2356
X-original-commit: da87312821
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
Signed-off-by: Castillo Jonathan (jcs) <jcs@odoo.com>
This will edit the "Define a list of custom ICE servers" section in the
"Configure ICE servers with Twilio" v15.0 user doc. I added a line to
mention that defining a list of custom ICE servers is an optional step,
as Odoo only uses this list as a fallback if Twilio is not configured or
is not working at any given moment.
Fixes PR #1994
Closes Odoo Task 2882679
closesodoo/documentation#2348
X-original-commit: 7f2110e8a3
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
The documentation of view attributes was lacking visual structure to
help the reader figure out which attribute relates to which parent
element. Since this documentation was relying on RST block quotes to
represent the hierarchy of view attributes, we can apply the same new
styling that was added with commit 934f45cf and designed for autodoc,
and which relies on the exact same HTML structure as block quotes.
task-2755298
closesodoo/documentation#2342
X-original-commit: e2a3ca0631
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
In chapter 3 of the developer core training, one is asked to click on a
button that is only shown in debug mode but there is no indication about
this mode in this chapter.
closesodoo/documentation#2304
X-original-commit: 96d822bf87
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
The `redirects.txt` file used to specify redirect rules for renamed or
moved documentation pages is starting to grow too big to be easily
maintainable. The main reason is that the number of redirect rules that
were thought to be required has been largely underestimated when
implementing the 'redirects' extension. At first, we believed that no
guidelines or structure were necessary because only a small amount of
redirect rules would be specified. This proved wrong and the file is now
becoming a mess, making it increasingly difficult to figure out where,
why, when, and if a redirect rule is specified in the file.
As the file is versioned, another issue emerges: conflicts occur every
time a commit is forward-ported to a later version if that commit adds a
redirect rule at the end of the file or at a line that was changed in
the later version. As redirect rules are frequently added, and since
blocks of redirect rules for new versions are added at the end of the
file, this tends to happen a lot.
This commit attempts to hit two birds with one stone by splitting the
`redirects.txt` file into multiple files, one per version. While doing
so, the existing redirect rules are ordered alphabetically and moved
into contextual blocks. Instructions and guidelines on how to create
redirect rules are also listed in the `redirects/MANUAL.md` file. By
sorting the redirect rules and adding them in different files, the
number of conflicts should decrease by a lot.
task-2891912
closesodoo/documentation#2292
X-original-commit: 0417b95514
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
SHA1 is going to be deprecated by ogone.
This change try to keep current behaviour while adding the
possibility to use SHA256 and SHA512 via a Selection field
available in the developper mode.
Related to :
- odoo/upgrade#3490
- odoo/odoo#88628
opw-2766648
closesodoo/documentation#1902
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
Deleting the Odoo Tutorials Invoices link since the course has been merged, and the link isn't necessary anymore.
closesodoo/documentation#2250
Forward-port-of: odoo/documentation#2243
Signed-off-by: Victor Feyens (vfe) <vfe@odoo.com>
Because of a recent Chrome security update, a lot of customers using peripheral devices (printers, ...) will have to follow this doc.
Therefore, I followed the doc and did the flow on my side.
I modified 'Copy to file' to 'Export' and 'Trusted Root Certification Authorities' to 'Authorities' in order to have the exact same terms as in Chrome (I guess they updated their terms at some point).
closesodoo/documentation#2237
X-original-commit: 4c4b81b12c
Signed-off-by: Victor Feyens (vfe) <vfe@odoo.com>
It is never shown to the trainee that he can install/update a module
right from the CLI. Multiple developpers still use the app manager to
install/update their modules multiple months into the job.
closesodoo/documentation#2189
X-original-commit: 3d2f067e6c
Signed-off-by: Victor Feyens (vfe) <vfe@odoo.com>
Signed-off-by: Julien Castiaux <juc@odoo.com>
it will also be renamed to .repositories in the near future
closesodoo/documentation#2166
X-original-commit: 1afee9e2c7
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
Added a note to specify that bank synchronization is not available on trial databases
closesodoo/documentation#2138
X-original-commit: e4fc5f07ee
Signed-off-by: Castillo Jonathan (jcs) <jcs@odoo.com>
Signed-off-by: Aarab Tom (toaa) <toaa@odoo.com>
Add 'x' to make evident that Authorize.net supports refunds directly
from odoo.
Task - 2712287
Task (on payment) - 2678757
closesodoo/documentation#2091
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
Odoo is compatible with X-Sendfile (apache) and X-Accel (nginx). They
are web server extension that can be used by the web application (Odoo)
to delegate serving local files to the web server (apache/nginx). We use
those extension to stream attachments. The documentation now explains
what is X-Sendfile/X-Accel and how to configure each web server.
Along those changes, the few sentences about serving static files have
been reworded and now include various configuration examples.
closesodoo/documentation#2083
Task: 2801675
Related: odoo/odoo#88134
Related: odoo/enterprise#26191
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
Starting July 2022, Amazon WMS API is deprecated and we need to use the Selling Partners API.
This brings changes in the authentication flow that are explained.
task-2466636
closesodoo/documentation#2107
X-original-commit: 2dd3a4ae74
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
Add a check to indicate that Stripe supports refunds.
closesodoo/documentation#2086
Related: odoo/odoo#92235
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
The previous file name was not very relevant in regard to the content of
the page, and it conflicted with the `sys.path`.
closesodoo/documentation#2068
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
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
Only `no_create` is required to hide both the 'Create "xxx"' and the
'Create and Edit...' dropdown menu options.
closesodoo/documentation#2016
X-original-commit: 599a137ffc
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
closesodoo/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>
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
closesodoo/documentation#1967
X-original-commit: 3231d20d92
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
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.
closesodoo/documentation#1908
Related: odoo/odoo#90634
Signed-off-by: Victor Feyens (vfe) <vfe@odoo.com>
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
closesodoo/documentation#1922
X-original-commit: 1997788e81
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
Signed-off-by: Castillo Jonathan (jcs) <jcs@odoo.com>
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.
closesodoo/documentation#1917
Forward-port-of: odoo/documentation#1728
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
