Compare commits
128 Commits
master-doc
...
saas-15.3-
| Author | SHA1 | Message | Date | |
|---|---|---|---|---|
|
|
639aa19627 |
[IMP] payment providers: ingenico documentation updated
This is a new documentation for the Ingenico payment provider, as support received a lot of tickets from customers having issues setting-up ingenico properly.
task - 2834329
X-original-commit:
|
||
|
|
0fc36c18e4 |
[CLN] rdtraining: remove reference to unexisting file
The referenced `bypass.py` file isn't specified anywhere in
the training documentation or code content.
The paragraph is removed to avoid meaningless searches and
confusing trainees.
This commit also adds a missing parenthese in the preceding
code content.
Fixes #2488
closes odoo/documentation#2521
X-original-commit:
|
||
|
|
78945bf22e |
[IMP] rdtraining: update float utils information
The warning about float utils does not state where to find them, and
they are preceded by an example in the code that infringes the warning's
recommendation.
This commit indicates where to find the float utils and replaces the
example by one that uses them.
task-2925402
closes odoo/documentation#2511
X-original-commit:
|
||
|
|
404c731d8b |
[FIX] website: warn about google api deprecation
Google deprecated both its "Universal Analytics" and "Google Sign-In"
API. See community counterpart commit for a detailed explanation and
links.
closes odoo/documentation#2497
X-original-commit:
|
||
|
|
c40cf83073 |
[IMP] install: troubleshoot typical problems for Mac users
As mentioned in [1], because of [2], some python implementation for Mac
fail on startup with default parameters.
Also, when installing requirements, the psycopg requirement can fail
because the $PATH does not contain the postgresql tools installed with
the .app.
This commit provides instructions to avoid those issues.
[1]: https://github.com/odoo/odoo/issues/79112
[2]: https://bugs.python.org/issue40518
task-2922249
closes odoo/documentation#2503
X-original-commit:
|
||
|
|
7c3c8335ee |
[IMP] install/maintain: update info about upgrade process on Odoo.sh
closes odoo/documentation#2492
Id: 2744270
X-original-commit:
|
||
|
|
2ed6704b88 |
[FIX] accounting_localization: use relative paths in csv-table's option
The `file` option for the `csv-table` directive expects relative file
paths rather than absolute file paths since Sphinx 4. Since this was the
only usage of the `ODOO_ABSPATH` placeholder, it is removed with this
commit.
Task - 2898477
closes odoo/documentation#2483
X-original-commit:
|
||
|
|
bd34ada679 |
[IMP] conf.py, requirements.txt, *: allow building with Python 3.10
- Bump Sphinx version to 4.3.2 (default for Debian Jammy).
- Remove the retrocompatibility for Sphinx < 3.5 (warnings are raised in
4.5).
- Fix translator issue crashing builds.
- Unpin jinja2 from the requirements as the base issue is solved in sphinx 4
Task - 2898477
X-original-commit:
|
||
|
|
84779e5852 |
[IMP] helpdesk: clarify postpaid support and delete mentions of tasks
If committed, this will delete mentions of project tasks in the "Invoice
Time Spent on Tickets (Postpaid Support Services)" v14.0 user doc. It
also deletes unnecessary steps and screenshots about creating and
configuring a new Project and updates the steps and screenshots for the
"Create a sales order" and "Link the Helpdesk ticket to the SO" sections.
Fixes PR #1901
Closes Odoo Task 2870104
closes odoo/documentation#2477
X-original-commit:
|
||
|
|
9ba4aff8d8 |
[ADD] maintain: google oauth doc
Added document and media files on the setup of Google Gmail using OAuth with Odoo.
closes odoo/documentation#2472
X-original-commit:
|
||
|
|
ab55a5eda4 |
[REF] legal: convert the table from a grid to a list table
Prior to this commit, the /legal.html page relied on RST substitutions to insert the images directives of legal agreements within the table. This caused Sphinx to omit the `image-reference` class on all `<a>` elements surrounding an `<img>` element, which it normally adds when the `target` option is specified on an `image` directive. As the theme relies on that class to hide the "external link" icon added with commit |
||
|
|
03257cb8d0 |
[FIX] odoo_theme: show a cursor when hovering on an image without modal
The images that have the class `o-no-modal` cannot be clicked to open in
a modal, so the cursor should not be changed to a pointer when hovering
on them.
This commit also simplifies the theme's SCSS by replacing the hard-coded
SVG images used in the "Supported versions" page by unicode circles with
a custom styling.
X-original-commit:
|
||
|
|
860234a415 |
[FIX] odoo_theme: only open images that have no target in modal
Since clicking on the image redirects the user to the target URL, it's
useless to open the image in a modal. Also, it partially broke the
layout of the /legal.html page due to the modal div being inserted into
table cells.
This commit also introduces the possibility to add the `o-no-modal`
class on images that should not open in a modal.
task-2909167
X-original-commit:
|
||
|
|
291a3db45c |
[IMP] developer/rdtraining: simplify the development environment setup
In an attempt to help new developers install Odoo with a
straightforward procedure, Chapter 2 of the "Getting started" tutorial
included copy-pastes of parts of the "Installing Odoo" page. This proved
to be inefficient because it required maintaining documentation on the
installation procedure in several places and misled the readers by
suggesting installing the Python requirements *after* installing
PostgreSQL.
With this commit, the page on Chapter 2 is refreshed to be clearer to
the readers and redirect them to the "Installing Odoo" page when
necessary.
task-2908434
closes odoo/documentation#2460
X-original-commit:
|
||
|
|
88fa15e327 |
[MOV] developer/reference: move up the standard_modules directory
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".
closes odoo/documentation#2457
X-original-commit:
|
||
|
|
db835469a1 |
[IMP] developer: rename reference directories to "Py/Js framework"
It was confusing to label the directory for pages related to the Python
framework "Backend" as, in Odoo, the backend is the web client, and the
frontend is the portal/website. It also led to the "Standard modules"
directory to be placed within the "Backend" directory as of `saas-15.1`
to indicate that they were part of the backend too, but that was a
mistake. Indeed, most standard modules comprise JavaScript methods, and
we could want to document these in the reference at some point.
X-original-commit:
|
||
|
|
625fac0a88 |
[FIX] odoo_theme: fix the display of modal images in mobile
task-2908330
closes odoo/documentation#2448
X-original-commit:
|
||
|
|
12541f41ca |
[ADD] pos: add a doc about tracking numbers in pos
Task ID: 2622088
closes odoo/documentation#2447
X-original-commit:
|
||
|
|
2598fc1012 |
[CLN] conf.py: stop labelling saas-15.1 in version switcher
The branch was recently dropped from the supported versions. We no
longer need to add a label for it in the version switcher.
closes odoo/documentation#2435
X-original-commit:
|
||
|
|
24b116a23d |
[IMP] pos: add a warning about Six unusability in July
Task ID:2893426
Since Six payment terminal won't be usable starting in July 2022, I
added this warning.
closes odoo/documentation#2423
X-original-commit:
|
||
|
|
6ec2c5dfeb |
[IMP] ecommerce: remove one sub-menu to add it as a see also
task - 2904108 I removed the "website/publish" section from the toctree to add a link to the full website documentation inside off the see also.
closes odoo/documentation#2418
X-original-commit:
|
||
|
|
5102b8ea1e |
[FIX] sale_amazon: fix information displayed
Both carrier name and tracking reference are now displayed to the
customer, even when using the carrie `Self Delivery`
task-2900803
closes odoo/documentation#2410
X-original-commit:
|
||
|
|
5db7fd6cd7 |
[ADD] pos: add a new doc page about sales orders in pos
Task ID: 2622084
closes odoo/documentation#2398
X-original-commit:
|
||
|
|
81c92f4056 |
[IMP] pos: change the page heading
closes odoo/documentation#2401
X-original-commit:
|
||
|
|
1924117ab5 |
[IMP] eCommerce: update of cross-selling doc for Odoo 15.0 and after.
closes odoo/documentation#2391
X-original-commit:
|
||
|
|
f30e84c92a |
[IMP] developer/javascript: unify the styling of API references
Now that a new styling for API references was added with commit |
||
|
|
12ff9f118b |
[MOV] developer/misc: move all pages to a more logical location
Before this commit, the "Developer/Misc" directory of the doc, and
more particularly the "Developer/Misc/Other" sub-directory, was used as
a garbage dump where we moved all the pages that didn't fit elsewhere.
Due to that, interesting and important pages, such as the Coding
Guidelines, were buried in that directory never to be read again by Odoo
developers.
This commit moves most pages under "Misc" one or two levels up to be
located directly under "Developer" hence making them more accessible. A
new "Contributing/Development" directory is added to host the Coding
Guidelines page and soon many other pages.
task-2897143
closes odoo/documentation#2371
X-original-commit:
|
||
|
|
20b12c9958 |
[IMP] website: broken link removal
task - 2841794
closes odoo/documentation#2363
X-original-commit:
|
||
|
|
4ace49cee6 |
[IMP] accounting: Adyen's backend changes for the webhook creation
Adyen's backend had slightly changed and the previous doc version was outdated (URL and HMAC key fields)
task - 2810213
closes odoo/documentation#2354
X-original-commit:
|
||
|
|
ae744df665 |
[IMP] discuss: custom ICE server list optional
This will edit the "Define a list of custom ICE servers" section in the
"Configure ICE servers with Twilio" v15.0 user doc. I added a line to
mention that defining a list of custom ICE servers is an optional step,
as Odoo only uses this list as a fallback if Twilio is not configured or
is not working at any given moment.
Fixes PR #1994
Closes Odoo Task 2882679
closes odoo/documentation#2346
X-original-commit:
|
||
|
|
8aeee6c1c6 |
[IMP] developer/views: apply the new API references style
The documentation of view attributes was lacking visual structure to help the reader figure out which attribute relates to which parent element. Since this documentation was relying on RST block quotes to represent the hierarchy of view attributes, we can apply the same new styling that was added with commit |
||
|
|
b65cfc12dd |
[ADD] pos: adyen payment terminal
Task ID: 2808584
Do not Forward port r+
closes odoo/documentation#2333
X-original-commit:
|
||
|
|
95c3d0d97c |
[IMP] pos: change titles
X-original-commit:
|
||
|
|
6be0446259 |
[FW][MERGE] odoo_theme: styling fixes, tweaks, and general cleanup
**Special terms restyling:**
A general restyling of special terms has been made for better legibility
in text, and to differentiate roles (ie: `:command:`,`:file:`,`:dfn:`)
so writers can use these instead of italic and bold styling.
`:guilabel:` has not been changed because its use is too vast.
task-2790284
**Reference pages have a new look:**
`code` elements have been restyled to remove unnecessary spaces (ex:
`odoo.models .BaseModel`. See
https://www.odoo.com/documentation/15.0/developer/reference/backend/orm.html#odoo.models.BaseModel)
and to include visual aid of parent/children relations (left border).
Basic for task-2755298
**URL styling:**
When an image has an external link, the `external-link` icon appears
under the image. This has been removed. URLs with icons such as external
links or "Edit on Github" links have been modified to remove the
underline under the icons. On mobile, long URLs would push the content
outside the viewport. `overflow-wrap: anywhere` has been added to all
URLs on mobile devices.
**No more horizontal scroll on Windows thanks to css grid:**
Windows and Mac don't work the same (no kidding). Windows would add
±`1rem` of horizontal scroll when Mac doesn't. Adding that `1rem` to the
content's `max-width` calculations would make Mac unhappy (it left a
`1rem` gap). The solution for everyone to be happy was to change the
display type to `grid`. By doing this, the max-width calculations and
the left positioning according to the side-nav were not necessary
anymore. Great Success. Very Nice.
**Scrolling To:**
With the new subnav added with commit
|
||
|
|
3bd9640881 |
[FIX] pos: change the tab name in the configuration steps
closes odoo/documentation#2311
X-original-commit:
|
||
|
|
04f5b0a716 |
[REF] odoo_theme: replace values with variables in SCSS files
X-original-commit:
|
||
|
|
5fa54af26d |
[REF] odoo_theme: move stray mixins into the _mixins.scss file
X-original-commit:
|
||
|
|
8ce98f52ec |
[CLN] odoo_theme: remove unnecessary css
X-original-commit:
|
||
|
|
cb0e0f2985 |
[CLN] odoo_theme: remove old doc's unused variables
X-original-commit:
|
||
|
|
3bcdd860f0 |
[REF] odoo_theme: move scrollbar styling to .o_side_nav-inner
X-original-commit:
|
||
|
|
42d0b475cc |
[CLN] odoo_theme: remove old doc's utility mixins
These mixins were used in the old doc and were kept "just in case". The
`valid-radius` mixin already exists in the bootstrap library.
X-original-commit:
|
||
|
|
a24594857a |
[IMP] odoo_theme: replace "hide search matches" by a close button
X-original-commit:
|
||
|
|
fef1dc3ba5 |
[IMP] odoo_theme: improve spacing around code blocks on reference pages
X-original-commit:
|
||
|
|
f18355c555 |
[FIX] odoo_theme: fix scrollTo margin/padding with new headers height
The scroll padding needed increasing with the new sub-header.
Unnecessary calc() and parenthesis on the headers-height variable are
removed.
X-original-commit:
|
||
|
|
235464d0d9 |
[FIX] odoo_theme: remove the horizontal scroll bar
X-original-commit:
|
||
|
|
51271e432b |
[IMP] odoo_theme: improve URL stylings
- Remove external-link icon on images.
- Remove underline from external-link icon on link hover.
- Add overflow-wrap on URLs on mobile.
X-original-commit:
|
||
|
|
6176718eb0 |
[IMP] odoo_theme: improve general spacings and paddings
X-original-commit:
|
||
|
|
fccd6bb800 |
[IMP] odoo_theme: improve special terms styling
Including the `:command:`, `:file:` and `:dfn:` roles, and code-styled
text in alerts.
task-2790284
X-original-commit:
|
||
|
|
a9e77b310b |
[IMP] contributing: update the rst cheat sheet
task - 2810468
closes odoo/documentation#2318
X-original-commit:
|
||
|
|
2c676ed846 |
[IMP] developer/howtos: Add missing information about debug mode
In chapter 3 of the developer core training, one is asked to click on a
button that is only shown in debug mode but there is no indication about
this mode in this chapter.
closes odoo/documentation#2302
X-original-commit:
|
||
|
|
6039ab126c |
[IMP] accounting: note about outstanding accounts
task-2868642
closes odoo/documentation#2295
X-original-commit:
|
||
|
|
873dc25718 |
[IMP] redirects: split redirects.txt into multiple, per-version, files
The `redirects.txt` file used to specify redirect rules for renamed or
moved documentation pages is starting to grow too big to be easily
maintainable. The main reason is that the number of redirect rules that
were thought to be required has been largely underestimated when
implementing the 'redirects' extension. At first, we believed that no
guidelines or structure were necessary because only a small amount of
redirect rules would be specified. This proved wrong and the file is now
becoming a mess, making it increasingly difficult to figure out where,
why, when, and if a redirect rule is specified in the file.
As the file is versioned, another issue emerges: conflicts occur every
time a commit is forward-ported to a later version if that commit adds a
redirect rule at the end of the file or at a line that was changed in
the later version. As redirect rules are frequently added, and since
blocks of redirect rules for new versions are added at the end of the
file, this tends to happen a lot.
This commit attempts to hit two birds with one stone by splitting the
`redirects.txt` file into multiple files, one per version. While doing
so, the existing redirect rules are ordered alphabetically and moved
into contextual blocks. Instructions and guidelines on how to create
redirect rules are also listed in the `redirects/MANUAL.md` file. By
sorting the redirect rules and adding them in different files, the
number of conflicts should decrease by a lot.
task-2891912
closes odoo/documentation#2289
X-original-commit:
|
||
|
|
14531d43d0 |
[IMP] odoo_theme: open images in a modal
task-2358082
closes odoo/documentation#2282
X-original-commit:
|
||
|
|
54bbc778bc |
[FIX] odoo_theme: correctly test for fallback URLs when using switchers
closes odoo/documentation#2272
X-original-commit:
|
||
|
|
ebbb7d2f62 |
[IMP] accounting: new content for invoice digitization (ocr)
closes odoo/documentation#2260
Id: 2320188
X-original-commit:
|
||
|
|
57a21f7f71 |
[FIX] redirects: add missing redirect rule for external_api.rst
The redirect rule was omitted in commit |
||
|
|
3e5393a558 |
[FW][IMP] accounting: remove the odoo tutorials invoices link
Deleting the Odoo Tutorials Invoices link since the course has been merged, and the link isn't necessary anymore. closes odoo/documentation#2248 Forward-port-of: odoo/documentation#2243 Signed-off-by: Victor Feyens (vfe) <vfe@odoo.com> |
||
|
|
2452b58ae9 |
Update epos_ssc.rst
Because of a recent Chrome security update, a lot of customers using peripheral devices (printers, ...) will have to follow this doc.
Therefore, I followed the doc and did the flow on my side.
I modified 'Copy to file' to 'Export' and 'Trusted Root Certification Authorities' to 'Authorities' in order to have the exact same terms as in Chrome (I guess they updated their terms at some point).
closes odoo/documentation#2235
X-original-commit:
|
||
|
|
4f2c38846d |
[FIX] odoo_theme: fix highlight blocks in field-list items
On pages such as /developer/reference/backend/orm.html#fields, the
highlight blocks inside `dl.field-list` items were pushing the width of
the page to go outside the screen on mobile. This is fixed by changing
the `.field-list`'s `display: grid` into `block` on mobile.
closes odoo/documentation#2228
X-original-commit:
|
||
|
|
9ae0808010 |
[FW][MERGE] odoo_theme: revamp header and menu for better mobile support
Previously the switchers were hidden on mobile. These have been moved to a sub-nav which also contains the button for the sidenav, leaving more space for the searchbox so it can remain in the header. Like MDN web docs, the navigation now slides in from the left instead of the top. See PR's commits for more details. task-2800937 closes odoo/documentation#2220 Forward-port-of: odoo/documentation#2206 Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com> |
||
|
|
d9d2ab2434 |
[FIX] odoo_theme: stop testing for valid URLs if in localhost
The mechanism that makes the version and language switchers test for
valid URLs crashed when testing in localhost. The mechanism is now
skipped if the URL starts with a '/'.
X-original-commit:
|
||
|
|
c9f24e2794 |
[FIX] odoo_theme: fix searchbox's highlight-link
task-2800937
X-original-commit:
|
||
|
|
e7cb811971 |
[IMP] odoo_theme: revamp side menu to add overlay
task-2800937
X-original-commit:
|
||
|
|
0138a0822a |
[FIX] odoo_theme: fix menu scrolling
task-2800937
X-original-commit:
|
||
|
|
35623039a1 |
[IMP] odoo_theme: add side menu collapse icon
task-2800937
X-original-commit:
|
||
|
|
adb3cfb148 |
[IMP] odoo_theme: change collapsing menu orientation
task-2800937
X-original-commit:
|
||
|
|
a1e08d7634 |
[IMP] odoo_theme: add subheader and adapt switchers and searchbar
task-2800937
X-original-commit:
|
||
|
|
abb40e8e31 |
[IMP] odoo_theme: stop translating language names in the switcher
Before this commit, the language names were translated to display
"Français" instead of "French". This helped the user find their language
in the switcher but it was taking too much horizontal space, and that
space was not constant from one language to another.
This commit removes the translations of the language names and simply
goes with "FR", "NL", etc. which any user can identify as their
language.
task-2800937
X-original-commit:
|
||
|
|
f21170d178 |
[IMP] design: add an icon behind external links
The external links' target attribute is now also updated to open the
link in a new tab. In addition, the "[source]" link of autodoc's models
is moved right next to the name of the model to correctly position the
icon.
task-2790244
closes odoo/documentation#2211
X-original-commit:
|
||
|
|
d88a96dada |
[IMP] odoo_theme: show the "On this page" section in mobile
When the page gets too small for the "On this page" section (local tree
of content) to fit on the page, the section is now moved above the menu
(global tree of content) rather than being hidden.
task-2800970
closes odoo/documentation#2199
X-original-commit:
|
||
|
|
f3f14deb8c |
[REM] pos: remove cash control doc page in 15 bc deprecated
Task ID: 2680699
closes odoo/documentation#2190
X-original-commit:
|
||
|
|
97b7bdfd5e |
[IMP] rdtraining: tip about -i/-u for odoo-bin
It is never shown to the trainee that he can install/update a module
right from the CLI. Multiple developpers still use the app manager to
install/update their modules multiple months into the job.
closes odoo/documentation#2185
X-original-commit:
|
||
|
|
9d36e4e2a4 |
[FIX] requirements: pin docutils to 0.16.0
Since sphinx-tabs 3.2.0 has the requirement docutils==0.16.0 and sphinx
3.5.4 has the requirement docutils>=0.12,<0.17, this commit pins
docutils to version 0.16.0.
While we're at it, the dependency to sphinx-tabs is also explicitly
listed, although it was already imported in the extensions. It causes
no trouble to install it from pip alongside the imported extension.
closes odoo/documentation#2176
X-original-commit:
|
||
|
|
48c8d22a54 |
[FIX] odoo.sh: remove hidden folder from documentation
it will also be renamed to .repositories in the near future
closes odoo/documentation#2164
X-original-commit:
|
||
|
|
226d49c239 |
[IMP] maintain: process for odoo.sh to odoo online
task-id 2870122
closes odoo/documentation#2157
X-original-commit:
|
||
|
|
de04e27d1a |
[ADD] accounting/l10n: new egyptian localization and einvoicing section
task-id 2858349
closes odoo/documentation#2147
X-original-commit:
|
||
|
|
87a919e864 |
[FIX] homepage: fix the link to the external API page
The page was moved from odoo.rst to external_api.rst with commit |
||
|
|
4197755373 |
[IMP] accounting: add note about bank sync not available for trial db
Added a note to specify that bank synchronization is not available on trial databases
closes odoo/documentation#2137
X-original-commit:
|
||
|
|
745a1da595 |
[IMP] maintain: add note in hosting changes (on-premise to online)
task-id 2869953
closes odoo/documentation#2128
X-original-commit:
|
||
|
|
1601ce58d0 |
[IMP] payment_acquirers: explain the different additional features
task-2862636
closes odoo/documentation#2120
X-original-commit:
|
||
|
|
44d82e1f07 |
[FIX] conf: dynamic LaTeX releasename
closes odoo/documentation#2115
X-original-commit:
|
||
|
|
920bb3d816 |
[IMP] amazon: migrate to SPAPI
Starting July 2022, Amazon WMS API is deprecated and we need to use the Selling Partners API.
This brings changes in the authentication flow that are explained.
task-2466636
closes odoo/documentation#2106
X-original-commit:
|
||
|
|
d103229364 |
[IMP] payment: update SIX screenshots
closes odoo/documentation#2100
X-original-commit:
|
||
|
|
42b1af5d5c |
[IMP] helpdesk: update flow and images for reinvoicing time
closes odoo/documentation#2096
X-original-commit:
|
||
|
|
e31183f4ed |
[FW][IMP] calendar: update Google Calendar sync screenshots
Task ID: 2685658 closes odoo/documentation#2089 Forward-port-of: odoo/documentation#1982 Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com> |
||
|
|
5b85b5a8e9 |
[IMP] accounting: update the follow-up information
Task ID: 2735445
closes odoo/documentation#2080
X-original-commit:
|
||
|
|
3ba2967847 |
[ADD] discuss: configure Twilio ICE servers
closes odoo/documentation#2073
X-original-commit:
|
||
|
|
75e7f29fe1 |
[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#2067 Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com> |
||
|
|
4649c3f8d1 |
[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#2067 |
||
|
|
51d3b5f0a2 |
[IMP] accounting : update the list of fiscal localization packages
task id: 2858536
closes odoo/documentation#2050
X-original-commit:
|
||
|
|
2b29e4a29b |
[FIX] odoo_theme: correctly consider baseurl
urlBase was only containing the domain name, not the /documentation/ closes odoo/documentation#2061 Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com> |
||
|
|
c9d95858b4 |
[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#2051
X-original-commit:
|
||
|
|
a572e055a8 |
[FIX] developer/frontend: typo in the user menu registry example
closes odoo/documentation#2038
X-original-commit:
|
||
|
|
d67a2492ce |
[FW][FIX] developer/howtos: Fixed typo from field to fields
closes odoo/documentation#2035 Forward-port-of: odoo/documentation#2023 Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com> |
||
|
|
cfeb1e4838 |
[IMP] CRM: updated lead scoring with note about deprecation
Task ID: 2496900
closes odoo/documentation#2029
X-original-commit:
|
||
|
|
ad21e95e8b |
[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#2015
X-original-commit:
|
||
|
|
b1e6b4c3e3 |
[IMP] CRM: updating flow and screenshots of generating leads
closes odoo/documentation#2021
Task: 2540813
X-original-commit:
|
||
|
|
7cbc4b5673 |
[ADD] accounting: new doc about outstanding account
Task-id 2744131
closes odoo/documentation#2011
X-original-commit:
|
||
|
|
1f550b7ab0 |
[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#2000
X-original-commit:
|
||
|
|
3b5979708a |
[IMP] payment acquirers: a note in Authorize.net
closes odoo/documentation#1989
X-original-commit:
|
||
|
|
5dca17ad7d |
[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#1979
X-original-commit:
|
||
|
|
a0181810fd |
[FIX] conf: allow building the documentation with Python 3.6.
Commit |
||
|
|
3fb30d87d7 |
[REF] i18n/localization.rst: rework the entire localization tutorial
closes odoo/documentation#1968
X-original-commit:
|
||
|
|
1e20a49f47 |
[ADD] extension: allow to build graphs using graphviz
X-original-commit:
|
||
|
|
5aa9ba31fe |
[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:
|
||
|
|
2e6634ea7a |
[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:
|
||
|
|
6fc5fd5249 |
[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#1966
X-original-commit:
|
||
|
|
6a2ecf5675 |
[IMP] CRM: update multiple sales teams doc
closes odoo/documentation#1963
Task: 2588786
X-original-commit:
|
||
|
|
d956bfd5c9 |
[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#1954
X-original-commit:
|
||
|
|
2d72944305 |
[IMP] install/maintain: add seealso links in domain names doc
closes odoo/documentation#1937
X-original-commit:
|
||
|
|
4b97817afa |
[ADD] accounting: avatax integration
closes odoo/documentation#1945
X-original-commit:
|
||
|
|
376ee43cf7 |
[FW][FIX] developer/howtos: missing parentheses in print statement
Added parentheses in a print function closes odoo/documentation#1930 Forward-port-of: odoo/documentation#1923 Signed-off-by: Victor Feyens (vfe) <vfe@odoo.com> |
||
|
|
8bada22d42 |
[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#1921
X-original-commit:
|
||
|
|
f0ea12f515 |
[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#1916 Forward-port-of: odoo/documentation#1728 Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com> |
||
|
|
a271ebfef5 |
[FIX] sales: fix typo
critarias -> criteria
closes odoo/documentation#1905
X-original-commit:
|
||
|
|
41a19f587e |
[ADD] .gitattributes: include RST files in language statistic on GitHub
closes odoo/documentation#1897
X-original-commit:
|
||
|
|
a7478dd186 |
[ADD] multi_website: add info to configure multiple domains
closes odoo/documentation#1896
X-original-commit:
|
||
|
|
daf07926a6 |
[IMP] outlook mail_plugin: add solution for cookie issue
closes odoo/documentation#1884
X-original-commit:
|
||
|
|
1bee07e966 |
[FIX] developer/rd-training: fix commands
Changed commands that were still referring to Odoo 14.0 to 15.0
closes odoo/documentation#1879
X-original-commit:
|
||
|
|
bc2e37d73d |
[FW][FIX] crm: fix typos and menuselection items
closes odoo/documentation#1873 Forward-port-of: odoo/documentation#1183 Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com> |
||
|
|
44a62e385f |
[FIX] developer/rdtraining: fix typos
closes odoo/documentation#1866
X-original-commit:
|
||
|
|
4d8c21fc11 |
[FIX] developer: fix duplicate action availability
The duplicate action is not available for list views
closes odoo/documentation#1859
X-original-commit:
|
||
|
|
5ba9583788 |
[FIX] developer: fix duplicate availability
The duplicate action is not available for list views
closes odoo/documentation#1852
X-original-commit:
|
||
|
|
cb239b36a0 |
[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#1840
X-original-commit:
|
||
|
|
af27e20e02 |
[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#1830
X-original-commit:
|
||
|
|
7462b89f57 |
[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:
|
||
|
|
c4ffa7a8cd |
[FW][FIX] developer/rdtraining: fix typo
Fixed `name = field.Char(required=True)` to `name = fields.Char(required=True)`. closes odoo/documentation#1823 Forward-port-of: odoo/documentation#1816 Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com> |
||
|
|
9cb3eaa2ef |
[REL] freeze saas-15.3 branch
closes odoo/documentation#1791 Related: odoo/odoo#87949 Related: odoo/design-themes#558 Related: odoo/enterprise#25888 |
2
.gitattributes
vendored
Normal file
|
|
@@ -0,0 +1,2 @@
|
|||
# Include RST files in language statistics on GitHub.
|
||||
*.rst linguist-detectable
|
||||
3
.gitignore
vendored
|
|
@@ -1,6 +1,7 @@
|
|||
*.pyc
|
||||
.*
|
||||
*.mo
|
||||
.*
|
||||
!.gitattributes
|
||||
|
||||
# Sphinx build files
|
||||
_build/
|
||||
|
|
|
|||
4
Makefile
|
|
@@ -19,12 +19,14 @@ SPHINXOPTS = -D project_root=$(ROOT) -D canonical_version=$(CANONICAL_VERSIO
|
|||
-D versions=$(VERSIONS) -D languages=$(LANGUAGES) -D language=$(CURRENT_LANG) \
|
||||
-D is_remote_build=$(IS_REMOTE_BUILD) \
|
||||
-A google_analytics_key=$(GOOGLE_ANALYTICS_KEY) \
|
||||
-A plausible_script=$(PLAUSIBLE_SCRIPT) \
|
||||
-A plausible_domain=$(PLAUSIBLE_DOMAIN) \
|
||||
-j $(WORKERS)
|
||||
SOURCE_DIR = content
|
||||
|
||||
HTML_BUILD_DIR = $(BUILD_DIR)/html
|
||||
ifdef VERSIONS
|
||||
HTML_BUILD_DIR := $(HTML_BUILD_DIR)/master
|
||||
HTML_BUILD_DIR := $(HTML_BUILD_DIR)/saas-15.3
|
||||
endif
|
||||
ifneq ($(CURRENT_LANG),en)
|
||||
HTML_BUILD_DIR := $(HTML_BUILD_DIR)/$(CURRENT_LANG)
|
||||
|
|
|
|||
14
README.md
|
|
@@ -4,11 +4,11 @@
|
|||
|
||||
### Requirements
|
||||
|
||||
- [Git](https://www.odoo.com/documentation/master/contributing/documentation.html#install-git)
|
||||
- [Python 3.7 or 3.8](https://www.odoo.com/documentation/master/contributing/documentation.html#python)
|
||||
- Python dependencies listed in the file [`requirements.txt`](https://github.com/odoo/documentation/tree/master/requirements.txt).
|
||||
- [Make](https://www.odoo.com/documentation/master/contributing/documentation.html#make)
|
||||
- A local copy of the [odoo/odoo repository in master](https://github.com/odoo/odoo/tree/master) (Optional)
|
||||
- [Git](https://www.odoo.com/documentation/saas-15.3/contributing/documentation.html#install-git)
|
||||
- [Python 3.7 or 3.8](https://www.odoo.com/documentation/saas-15.3/contributing/documentation.html#python)
|
||||
- Python dependencies listed in the file [`requirements.txt`](https://github.com/odoo/documentation/tree/saas-15.3/requirements.txt).
|
||||
- [Make](https://www.odoo.com/documentation/saas-15.3/contributing/documentation.html#make)
|
||||
- A local copy of the [odoo/odoo repository in saas-15.3](https://github.com/odoo/odoo/tree/saas-15.3) (Optional)
|
||||
|
||||
### Instructions
|
||||
|
||||
|
|
@@ -23,7 +23,7 @@
|
|||
|
||||
2. Open the file `documentation/_build/html/index.html` in your web browser to display the render.
|
||||
|
||||
3. See [this guide](https://www.odoo.com/documentation/master/contributing/documentation.html#preview-your-changes)
|
||||
3. See [this guide](https://www.odoo.com/documentation/saas-15.3/contributing/documentation.html#preview-your-changes)
|
||||
for more detailed instructions.
|
||||
|
||||
Optional: to fully build the developer documentation with inline docstrings for documented Python
|
||||
|
|
@@ -34,7 +34,7 @@ be shown.
|
|||
## Contribute to the documentation
|
||||
|
||||
For contributions to the content of the documentation, please refer to the
|
||||
[Introduction Guide](https://www.odoo.com/documentation/master/contributing/documentation.html).
|
||||
[Introduction Guide](https://www.odoo.com/documentation/saas-15.3/contributing/documentation.html).
|
||||
|
||||
To **report a content issue**, **request new content** or **ask a question**, use the
|
||||
[repository's issue tracker](https://github.com/odoo/documentation-user/issues) as usual.
|
||||
|
|
|
|||
111
conf.py
|
|
@@ -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
|
||||
|
||||
|
|
@@ -19,7 +22,7 @@ copyright = 'Odoo S.A.'
|
|||
# `version` if the version info for the project being documented, acts as replacement for |version|,
|
||||
# also used in various other places throughout the built documents.
|
||||
# `release` is the full version, including alpha/beta/rc tags. Acts as replacement for |release|.
|
||||
version = release = 'master'
|
||||
version = release = 'saas-15.3'
|
||||
|
||||
# The minimal Sphinx version required to build the documentation.
|
||||
needs_sphinx = '3.0.0'
|
||||
|
|
@@ -48,11 +51,20 @@ exclude_patterns = [
|
|||
# See https://docutils.sourceforge.io/docs/ref/rst/roles.html#standard-roles for other roles.
|
||||
default_role = 'literal'
|
||||
|
||||
|
||||
# Whether scaled down images should be be wrapped in a `<a/>` tag linking to the image file or not.
|
||||
html_scaled_image_link = False
|
||||
|
||||
# If true, '()' will be appended to :func: etc. cross-reference text
|
||||
add_function_parentheses = True
|
||||
|
||||
#=== Extensions configuration ===#
|
||||
|
||||
source_read_replace_vals = {
|
||||
'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,11 +86,14 @@ 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])
|
||||
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.replace('~', '-') # Change saas~XX.Y to saas-XX.Y
|
||||
odoo_version = 'master' if 'alpha' in odoo_release.version else odoo_version
|
||||
|
|
@@ -98,12 +113,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',
|
||||
|
||||
|
|
@@ -133,7 +154,15 @@ if odoo_dir_in_path:
|
|||
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
|
||||
|
||||
|
|
@@ -158,8 +187,8 @@ sphinx.transforms.i18n.docname_to_domain = (
|
|||
# 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.3': "Odoo Online",
|
||||
'saas-15.2': "Odoo Online",
|
||||
'saas-15.1': "Odoo Online",
|
||||
'15.0': "Odoo 15",
|
||||
'14.0': "Odoo 14",
|
||||
'13.0': "Odoo 13",
|
||||
|
|
@@ -168,18 +197,18 @@ versions_names = {
|
|||
# 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',
|
||||
'fr': 'Français',
|
||||
'nl': 'Nederlands',
|
||||
'pt_BR': 'Português (BR)',
|
||||
'uk': 'українська',
|
||||
'zh_CN': '简体中文',
|
||||
'de': 'DE',
|
||||
'en': 'EN',
|
||||
'es': 'ES',
|
||||
'fr': 'FR',
|
||||
'nl': 'NL',
|
||||
'pt_BR': 'PT',
|
||||
'uk': 'UA',
|
||||
'zh_CN': 'ZH',
|
||||
}
|
||||
|
||||
# The specifications of redirect rules used by the redirects extension.
|
||||
redirects_file = 'redirects.txt'
|
||||
# The directory in which files holding redirect rules used by the 'redirects' extension are listed.
|
||||
redirects_dir = 'redirects/'
|
||||
|
||||
sphinx_tabs_disable_tab_closing = True
|
||||
sphinx_tabs_disable_css_loading = True
|
||||
|
|
@@ -203,12 +232,12 @@ html_favicon = os.path.join(html_theme_path[0], html_theme, 'static', 'img', 'fa
|
|||
# They are copied after the builtin static files, so a file named "default.css" will overwrite the
|
||||
# builtin "default.css".
|
||||
html_static_path = ['static']
|
||||
html_add_permalinks = '¶' # Sphinx < 3.5
|
||||
html_permalinks = True # Sphinx >= 3.5
|
||||
html_permalinks = True
|
||||
|
||||
# Additional JS & CSS files that can be imported with the 'custom-js' and 'custom-css' metadata.
|
||||
# Lists are empty because the files are specified in extensions/themes.
|
||||
html_js_files = []
|
||||
html_css_files = ["css/js.css"]
|
||||
html_css_files = []
|
||||
|
||||
# PHP lexer option to not require <?php
|
||||
highlight_options = {
|
||||
|
|
@@ -226,7 +255,7 @@ latex_elements = {
|
|||
'tableofcontents': '', # no TOC
|
||||
|
||||
# Output manually in latex docs
|
||||
'releasename': '14.0',
|
||||
'releasename': release,
|
||||
}
|
||||
|
||||
latex_additional_files = ['static/latex/odoo.sty']
|
||||
|
|
@@ -266,6 +295,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
|
||||
|
|
@@ -274,12 +319,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.
|
||||
|
|
|
|||
|
|
@@ -272,55 +272,80 @@ Enterprise Edition:
|
|||
* `Official download page <download_>`_
|
||||
* `GitHub repository <enterprise-repository_>`_
|
||||
|
||||
.. _setup/install/source/git:
|
||||
|
||||
Git
|
||||
~~~
|
||||
|
||||
The following requires `git <https://git-scm.com/>`_ to be installed on your machine and that you
|
||||
have basic knowledge of git commands.
|
||||
The following requires `Git <git_>`_ to be installed on your machine and that you have basic
|
||||
knowledge of Git commands. To clone a Git repository, you must choose between cloning with HTTPS or
|
||||
SSH. If you do not know the difference between the two, the best option is most likely HTTPS. If you
|
||||
are following the :doc:`Getting started </developer/howtos/rdtraining>` developer tutorial, or plan
|
||||
on contributing to Odoo source code, choose SSH.
|
||||
|
||||
Community Edition:
|
||||
.. note::
|
||||
**The Enterprise Git repository does not contain the full Odoo source code**. It is only a
|
||||
collection of extra add-ons. The main server code is in the Community version. Running the
|
||||
Enterprise version actually means running the server from the Community version with the
|
||||
addons-path option set to the folder with the Enterprise version. You need to clone both the
|
||||
Community and Enterprise repository to have a working Odoo Enterprise installation. See
|
||||
:ref:`setup/install/editions` to get access to the Enterprise repository.
|
||||
|
||||
.. tabs::
|
||||
|
||||
.. group-tab:: Windows
|
||||
|
||||
.. code-block:: doscon
|
||||
.. tabs::
|
||||
|
||||
C:\> git clone https://github.com/odoo/odoo.git
|
||||
.. tab:: Clone with HTTPS
|
||||
|
||||
.. code-block:: doscon
|
||||
|
||||
C:\> git clone https://github.com/odoo/odoo.git
|
||||
C:\> git clone https://github.com/odoo/enterprise.git
|
||||
|
||||
.. tab:: Clone with SSH
|
||||
|
||||
.. code-block:: doscon
|
||||
|
||||
C:\> git clone git@github.com:odoo/odoo.git
|
||||
C:\> git clone git@github.com:odoo/enterprise.git
|
||||
|
||||
.. group-tab:: Linux
|
||||
|
||||
.. code-block:: console
|
||||
.. tabs::
|
||||
|
||||
$ git clone https://github.com/odoo/odoo.git
|
||||
.. tab:: Clone with HTTPS
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
$ git clone https://github.com/odoo/odoo.git
|
||||
$ git clone https://github.com/odoo/enterprise.git
|
||||
|
||||
.. tab:: Clone with SSH
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
$ git clone git@github.com:odoo/odoo.git
|
||||
$ git clone git@github.com:odoo/enterprise.git
|
||||
|
||||
.. group-tab:: Mac OS
|
||||
|
||||
.. code-block:: console
|
||||
.. tabs::
|
||||
|
||||
$ git clone https://github.com/odoo/odoo.git
|
||||
.. tab:: Clone with HTTPS
|
||||
|
||||
Enterprise Edition: (see :ref:`setup/install/editions` to get access)
|
||||
.. code-block:: console
|
||||
|
||||
.. tabs::
|
||||
$ git clone https://github.com/odoo/odoo.git
|
||||
$ git clone https://github.com/odoo/enterprise.git
|
||||
|
||||
.. group-tab:: Windows
|
||||
.. tab:: Clone with SSH
|
||||
|
||||
.. code-block:: doscon
|
||||
.. code-block:: console
|
||||
|
||||
C:\> git clone https://github.com/odoo/enterprise.git
|
||||
|
||||
.. group-tab:: Linux
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
$ git clone https://github.com/odoo/enterprise.git
|
||||
|
||||
.. group-tab:: Mac OS
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
$ git clone https://github.com/odoo/enterprise.git
|
||||
$ git clone git@github.com:odoo/odoo.git
|
||||
$ git clone git@github.com:odoo/enterprise.git
|
||||
|
||||
.. note::
|
||||
**The Enterprise git repository does not contain the full Odoo source code**. It is only a
|
||||
|
|
@@ -329,6 +354,8 @@ Enterprise Edition: (see :ref:`setup/install/editions` to get access)
|
|||
addons-path option set to the folder with the Enterprise version. You need to clone both the
|
||||
Community and Enterprise repository to have a working Odoo Enterprise installation.
|
||||
|
||||
.. _setup/install/source/prepare:
|
||||
|
||||
Prepare
|
||||
-------
|
||||
|
||||
|
|
@@ -451,6 +478,11 @@ PostgreSQL
|
|||
<https://postgresapp.com>`_ to download and install PostgreSQL (supported version: 10.0 and
|
||||
later).
|
||||
|
||||
.. tip::
|
||||
To make the command line tools bundled with `postgres.app` available, make sure to setup your
|
||||
`$PATH` variable by following the `Postgres.app CLI Tools Instructions
|
||||
<https://postgresapp.com/documentation/cli-tools.html>`_.
|
||||
|
||||
By default, the only user is `postgres` but Odoo forbids connecting as `postgres`, so you need
|
||||
to create a new PostgreSQL user:
|
||||
|
||||
|
|
@@ -668,8 +700,13 @@ A typical way to run the server would be:
|
|||
Where `CommunityPath` is the path of the Odoo Community installation and `mydb` is the default
|
||||
database to serve on `localhost:8069`.
|
||||
|
||||
.. warning::
|
||||
Some versions of python on Mac might lead to the following error message: `current limit
|
||||
exceeds maximum limit`. In that case, add the following parameter `--limit-memory-hard 0`
|
||||
to avoid the problem.
|
||||
|
||||
.. seealso::
|
||||
- :doc:`The exhaustive list of arguments for odoo-bin </developer/misc/other/cmdline>`.
|
||||
- :doc:`The exhaustive list of arguments for odoo-bin </developer/cli>`.
|
||||
|
||||
.. _setup/install/docker:
|
||||
|
||||
|
|
|
|||
|
|
@@ -7,6 +7,7 @@ Maintain
|
|||
.. toctree::
|
||||
|
||||
maintain/domain_names
|
||||
maintain/google_oauth
|
||||
maintain/update
|
||||
maintain/enterprise
|
||||
maintain/hosting_changes
|
||||
|
|
|
|||
|
|
@@ -21,6 +21,11 @@ You can use a custom domain name to access your Odoo database and websites:
|
|||
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
|
||||
|
|
|
|||
192
content/administration/maintain/google_oauth.rst
Normal file
|
|
@@ -0,0 +1,192 @@
|
|||
========================================
|
||||
Connect Gmail to Odoo using Google OAuth
|
||||
========================================
|
||||
|
||||
Odoo is compatible with Google's OAuth for Gmail. In order to send secure emails from a custom
|
||||
domain, all that is required is to configure a few settings on Google's *Workspace* platform, as
|
||||
well as on the back end of the Odoo database. This configuration works by using either a personal
|
||||
email address or an address created by a custom domain.
|
||||
|
||||
.. tip::
|
||||
For more information, visit `Google's documentation
|
||||
<https://support.google.com/cloud/answer/6158849>`_ on setting up OAuth.
|
||||
|
||||
Setup in Google
|
||||
===============
|
||||
|
||||
Create a new project
|
||||
--------------------
|
||||
|
||||
To get started, go to the `Google API Platform
|
||||
<https://console.cloud.google.com/apis/credentials/consent>`_. Log in with your *Google Workspace*
|
||||
account if you have one, otherwise log in with your personal Gmail account (this should match the
|
||||
email address you want to configure in Odoo).
|
||||
|
||||
After that, click on :guilabel:`Create Project`, located on the far right of the OAuth consent
|
||||
screen. If a project has already been created in this account, then the :guilabel:`New Project`
|
||||
option will be located on the top left under the :guilabel:`Select a project` drop-down menu.
|
||||
|
||||
On the :guilabel:`New Project` screen, rename the :guilabel:`Project name` to `Odoo` and browse for
|
||||
the :guilabel:`Location`. Set the :guilabel:`Location` as the `Google Workspace` organization. If
|
||||
you are using a personal Gmail account, then leave the :guilabel:`Location` as `No Organization`.
|
||||
|
||||
.. image:: google_oauth/new-project.png
|
||||
:align: center
|
||||
:alt: Project Name and Location for Google Oauth.
|
||||
|
||||
Click on :guilabel:`Create` to finish this step. On the next screen, :guilabel:`User Type` options,
|
||||
select the :guilabel:`External` option, and then click on :guilabel:`Create` again, which will
|
||||
finally navigate to the :guilabel:`Edit app registration` page.
|
||||
|
||||
Edit app registration
|
||||
---------------------
|
||||
|
||||
- On the :guilabel:`Oauth consent screen` step, under the :guilabel:`App information` section,
|
||||
enter `Odoo` in the :guilabel:`App name` field. Select the organization's email address under the
|
||||
:guilabel:`User support` email field.
|
||||
- Next, under :menuselection:`App Domain --> Authorized domains`, click on :guilabel:`Add Domain`
|
||||
and enter `odoo.com`.
|
||||
- After that, under the :guilabel:`Developer contact information` section, enter the organization's
|
||||
email address. Google uses this email address to notify the organization about any changes to
|
||||
your project.
|
||||
- Next, click on the :guilabel:`Save and Continue` button.
|
||||
- Then, skip the :guilabel:`Scopes` page by scrolling to the bottom and clicking on
|
||||
:guilabel:`Save and Continue`.
|
||||
- Next, add the email being configured under the :guilabel:`Test users` step by clicking on
|
||||
:guilabel:`Add Users` and then the :guilabel:`Save and Continue` button. A summary of the
|
||||
:guilabel:`App registration` appears.
|
||||
- Finally, scroll to the bottom and click on :guilabel:`Back to Dashboard`.
|
||||
|
||||
Create Credentials
|
||||
------------------
|
||||
|
||||
Now that you have set up the project, you need to create credentials, which includes the
|
||||
:guilabel:`Client ID` and :guilabel:`Client Secret`. First, click on :guilabel:`Credentials` in the
|
||||
left sidebar menu.
|
||||
|
||||
Then, click on :guilabel:`Create Credentials` in the top menu and select
|
||||
:guilabel:`OAuth client ID` from the dropdown menu.
|
||||
|
||||
- Under :guilabel:`Application Type`, select :guilabel:`Web Application` from the dropdown menu.
|
||||
- In the :guilabel:`Client ID` field, enter `Odoo`.
|
||||
- Under the :guilabel:`Authorized redirect URIs` label, click the button :guilabel:`ADD URI`, and
|
||||
then input `https://yourdbname.odoo.com/google_gmail/confirm` in the :guilabel:`URIs 1` field. Be
|
||||
sure to replace the *yourdbname* part of the URL with your actual Odoo database name.
|
||||
- Next, click on :guilabel:`Create` to generate an OAuth :guilabel:`Client ID` and
|
||||
:guilabel:`Client Secret`. Finally, copy each generated value for later use when configuring in
|
||||
Odoo, and then navigate to the Odoo database.
|
||||
|
||||
.. image:: google_oauth/client-credentials.png
|
||||
:align: center
|
||||
:alt: Client ID and Client Secret for Google OAuth.
|
||||
|
||||
Setup in Odoo
|
||||
=============
|
||||
|
||||
Enter Google Credentials
|
||||
------------------------
|
||||
|
||||
First, open Odoo and navigate to the :guilabel:`Apps` module. Then, remove the :guilabel:`Apps`
|
||||
filter from the search bar and type in `Google`. Install the module called :guilabel:`Google Gmail`.
|
||||
|
||||
Next, navigate to :menuselection:`Settings --> General Settings`, and under the :guilabel:`Discuss`
|
||||
section, ensure that the checkbox for :guilabel:`Custom Email Servers` is checked. This populates a
|
||||
new option for :guilabel:`Gmail Credentials`. Then, copy and paste the :guilabel:`Client ID` and
|
||||
:guilabel:`Client Secret` into the respective fields and :guilabel:`Save` the settings.
|
||||
|
||||
Configure outgoing email server
|
||||
-------------------------------
|
||||
|
||||
After that, on the :guilabel:`General Settings` page, under :guilabel:`Custom Email Servers`, click
|
||||
:guilabel:`Outgoing Email Servers` to configure the external Gmail account.
|
||||
|
||||
.. image:: google_oauth/outgoing-servers.png
|
||||
:align: center
|
||||
:alt: Configure Outgoing Email Servers in Odoo.
|
||||
|
||||
Then, :guilabel:`Create` a new email server and select the option for :guilabel:`Gmail`. Next, fill
|
||||
in the :guilabel:`Description` (can be anything) and the email :guilabel:`Username` and click on
|
||||
:guilabel:`Connect your Gmail account`.
|
||||
|
||||
A new window from :guilabel:`Google` opens to complete the authorization process. Select the
|
||||
appropriate email address that is being configured in Odoo.
|
||||
|
||||
If the email address is a personal account, an extra step pops up, click :guilabel:`Continue` to
|
||||
allow the verification and connect the Gmail account to Odoo.
|
||||
|
||||
Then, allow Odoo to access the Google account by clicking on :guilabel:`Continue` or
|
||||
:guilabel:`Allow`. After that, the page navigates back to the newly configured outgoing email
|
||||
server in Odoo. The configuration automatically loads the token in Odoo, and a tag stating
|
||||
:guilabel:`Gmail Token Valid` appears in green.
|
||||
|
||||
.. image:: google_oauth/green-token.png
|
||||
:align: center
|
||||
:alt: Configure Outgoing Email Servers in Odoo.
|
||||
|
||||
Finally, save the settings and :guilabel:`Test the Connection`. A confirmation message should
|
||||
appear. The Odoo database can now send safe, secure emails through Google using OAuth
|
||||
authentication.
|
||||
|
||||
Google OAuth FAQ
|
||||
================
|
||||
|
||||
Production VS Testing Publishing Status
|
||||
---------------------------------------
|
||||
|
||||
Choosing :guilabel:`Production` as the :guilabel:`Publishing Status` (instead of Testing) will
|
||||
display the following warning message:
|
||||
|
||||
.. image:: google_oauth/published-status.png
|
||||
:align: center
|
||||
:alt: OAuth is Limited to 100 Sensitive Scope Logins.
|
||||
|
||||
To correct this warning, navigate to the `Google API Platform
|
||||
<https://console.cloud.google.com/apis/credentials/consent>`_. If the :guilabel:`Publishing status`
|
||||
is :guilabel:`In Production`, click :guilabel:`Back to Testing` to correct the issue.
|
||||
|
||||
No Test Users Added
|
||||
-------------------
|
||||
|
||||
If no test users are added to the OAuth consent screen, then a 403 access denied error will
|
||||
populate.
|
||||
|
||||
.. image:: google_oauth/403-error.png
|
||||
:align: center
|
||||
:alt: 403 Access Denied Error.
|
||||
|
||||
To correct this error, return to the :guilabel:`OAuth consent screen` under
|
||||
:guilabel:`APIs & Services` and add test user(s) to the app. Add the email that you are configuring
|
||||
in Odoo.
|
||||
|
||||
Gmail Module not updated
|
||||
------------------------
|
||||
|
||||
If the :guilabel:`Gmail Module` in Odoo has not been updated to the latest version, then a
|
||||
:guilabel:`Forbidden` error message populates.
|
||||
|
||||
.. image:: google_oauth/forbidden-error.png
|
||||
:align: center
|
||||
:alt: Forbidden you don't have the permission to access the requested resource.
|
||||
|
||||
To correct this error, go to the :guilabel:`Apps` module and clear out the search terms. Then,
|
||||
search for `Gmail` or `Google` and upgrade the :guilabel:`Google Gmail` module. Finally, click on
|
||||
the three dots on the upper right of the module and select :guilabel:`Upgrade`.
|
||||
|
||||
Application Type
|
||||
----------------
|
||||
|
||||
When creating the :guilabel:`Credentials` (OAuth Client ID and Client Secret), if
|
||||
:guilabel:`Desktop App` is selected for the :guilabel:`Application Type`, an
|
||||
:guilabel:`Authorization Error` appears.
|
||||
|
||||
.. image:: google_oauth/error-400.png
|
||||
:align: center
|
||||
:alt: Error 400 Redirect URI Mismatch.
|
||||
|
||||
To correct this error, delete the credentials already created and create new credentials, selecting
|
||||
:guilabel:`Web Application` for the :guilabel:`Application Type`. Then, under
|
||||
:guilabel:`Authorized redirect URIs`, click :guilabel:`ADD URI` and type:
|
||||
`https://yourdbname.odoo.com/google_gmail/confirm` in the field.
|
||||
|
||||
.. note::
|
||||
Replace *yourdbname* in the URL with the Odoo database name.
|
||||
BIN
content/administration/maintain/google_oauth/403-error.png
Normal file
|
After Width: | Height: | Size: 16 KiB |
|
After Width: | Height: | Size: 25 KiB |
BIN
content/administration/maintain/google_oauth/error-400.png
Normal file
|
After Width: | Height: | Size: 7.5 KiB |
BIN
content/administration/maintain/google_oauth/forbidden-error.png
Normal file
|
After Width: | Height: | Size: 10 KiB |
BIN
content/administration/maintain/google_oauth/green-token.png
Normal file
|
After Width: | Height: | Size: 25 KiB |
BIN
content/administration/maintain/google_oauth/new-project.png
Normal file
|
After Width: | Height: | Size: 9.8 KiB |
|
After Width: | Height: | Size: 16 KiB |
|
After Width: | Height: | Size: 6.1 KiB |
|
|
@@ -11,8 +11,6 @@ Depending on the platforms, you have to do it by yourself or contact our support
|
|||
From on-premises to Odoo Online
|
||||
===============================
|
||||
|
||||
.. warning:: Odoo Online is not compatible with **non-standard apps**.
|
||||
|
||||
1. Create a :ref:`duplicate <duplicate_premise>` of your database: in this duplicate, uninstall all the **non-standard apps**.
|
||||
2. Grab a "dump with filestore" of your database by using the Database Manager.
|
||||
3. **If you have time constraints, contact us earlier to schedule the transfer.**
|
||||
|
|
@@ -20,6 +18,11 @@ From on-premises to Odoo Online
|
|||
5. We will make sure your database is compatible and upload it to our cloud. In case of technical issues, we will get in touch with you.
|
||||
6. It's done!
|
||||
|
||||
.. important::
|
||||
- Odoo Online is not compatible with **non-standard apps**.
|
||||
- The database you are moving to Odoo Online must be in a :doc:`supported version
|
||||
<supported_versions>`.
|
||||
|
||||
From on-premises to Odoo.sh
|
||||
===========================
|
||||
|
||||
|
|
@@ -45,13 +48,37 @@ From Odoo Online to Odoo.sh
|
|||
From Odoo.sh to Odoo Online
|
||||
===========================
|
||||
|
||||
.. warning:: Odoo Online is not compatible with **non-standard apps**.
|
||||
#. Uninstall all the **non-standard apps**.
|
||||
#. `Create a support ticket <https://www.odoo.com/help>`_ and include the following:
|
||||
|
||||
1. Uninstall all the **non-standard apps**: test it in a staging build first, then do it in your production build.
|
||||
2. **If you have time constraints, contact us earlier to schedule the transfer.**
|
||||
3. `Create a support ticket <https://www.odoo.com/help>`_ and include your subscription number and the URL you want to use for your database (e.g.: my-company.odoo.com).
|
||||
4. We will make sure your database is compatible and upload it to our cloud. In case of technical issues, we will get in touch with you.
|
||||
5. It's done!
|
||||
- Your subscription number
|
||||
- The URL you want to use for your database (e.g., `example.odoo.com`)
|
||||
- Which brand you want to migrate
|
||||
- In which region you want to be hosted:
|
||||
|
||||
- Americas
|
||||
- Europe
|
||||
- Asia
|
||||
|
||||
- Which user(s) will be the administrator(s)
|
||||
- When (and in which timezone) you want the database to be up and running
|
||||
|
||||
#. We will make sure your database is compatible and upload it to our cloud. In case of technical
|
||||
issues, we will get in touch with you.
|
||||
#. All done!
|
||||
|
||||
.. important::
|
||||
- Odoo Online is not compatible with **non-standard apps**.
|
||||
- Make sure to uninstall all the **non-standard apps** in a staging build before doing it in your
|
||||
production build.
|
||||
|
||||
.. note::
|
||||
- Make sure you select the **region** that is closest to your users to reduce latency.
|
||||
- The future **administrator(s)** must have an odoo.com account.
|
||||
- The specific **date and time** at which you want the database to be up and running are mainly
|
||||
helpful to organize the switch from the odoo.sh server to the Odoo Online servers.
|
||||
- Databases are **not reachable** during their migration.
|
||||
- **If you have time constraints, contact us earlier to schedule the transfer**.
|
||||
|
||||
From Odoo.sh to on-premises
|
||||
===========================
|
||||
|
|
|
|||
|
|
@@ -68,14 +68,13 @@ This matrix shows the support status of every version.
|
|||
|
||||
🏁 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...
|
||||
.. |green| raw:: html
|
||||
|
||||
.. |green| image:: data:image/svg+xml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHZpZXdCb3g9IjAgMCAyMzIuMTkgMjMyLjE5Ij48Y2lyY2xlIGN4PSIxMTYuMDkiIGN5PSIxMTYuMDkiIHI9IjExNi4wOSIgc3R5bGU9ImZpbGw6IzAwYTcwMCIvPjwvc3ZnPg==
|
||||
:width: 15
|
||||
<span class="text-success" style="font-size: 32px; line-height: 0.5">●</span>
|
||||
|
||||
.. |red| image:: data:image/svg+xml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHZpZXdCb3g9IjAgMCAyMzIuMTkgMjMyLjE5Ij48Y2lyY2xlIGN4PSIxMTYuMDkiIGN5PSIxMTYuMDkiIHI9IjExNi4wOSIgc3R5bGU9ImZpbGw6I2QwMDAwMCIvPjwvc3ZnPg==
|
||||
:width: 15
|
||||
.. |red| raw:: html
|
||||
|
||||
<span class="text-danger" style="font-size: 32px; line-height: 0.5">●</span>
|
||||
|
||||
I run an older version of Odoo/OpenERP/TinyERP
|
||||
==============================================
|
||||
|
|
|
|||
|
|
@@ -167,7 +167,7 @@ In the above commands, the argument:
|
|||
* ``--stop-after-init`` will immediately shutdown the server instance after it completed the operations you asked.
|
||||
|
||||
More options are available and detailed in the
|
||||
:doc:`CLI documentation </developer/misc/other/cmdline>`.
|
||||
:doc:`CLI documentation </developer/cli>`.
|
||||
|
||||
You can find in the logs (*~/logs/odoo.log*) the addons path used by Odoo.sh to run your server.
|
||||
Look for "*odoo: addons paths*":
|
||||
|
|
@@ -232,6 +232,6 @@ Save the file and then run the Odoo Shell:
|
|||
Finally, *via* the Odoo Shell, you can trigger the piece of code/function/method
|
||||
you want to debug.
|
||||
|
||||
.. image:: ./media/pdb_sh.png
|
||||
.. image:: containers/pdb_sh.png
|
||||
:align: center
|
||||
:alt: Console screenshot showing ``pdb`` running in an Odoo.sh shell.
|
||||
|
|
|
|||
|
Before Width: | Height: | Size: 72 KiB After Width: | Height: | Size: 72 KiB |
|
|
@@ -44,7 +44,7 @@ On Odoo.sh, in the branches view of your project, choose the branch in which you
|
|||
|
||||
In the upper right corner, click on the *Submodule* button, and then on *Run*.
|
||||
|
||||
.. image:: ./media/advanced-submodules-button.png
|
||||
.. image:: submodules/advanced-submodules-button.png
|
||||
:align: center
|
||||
|
||||
A dialog with a form is shown. Fill the inputs as follows:
|
||||
|
|
@@ -53,12 +53,12 @@ A dialog with a form is shown. Fill the inputs as follows:
|
|||
* Branch: The branch you want to use.
|
||||
* Path: The folder in which you want to add this submodule in your branch.
|
||||
|
||||
.. image:: ./media/advanced-submodules-dialog.png
|
||||
.. image:: submodules/advanced-submodules-dialog.png
|
||||
:align: center
|
||||
|
||||
On Github, you can get the repository URL with the *Clone or download* button of the repository. Make sure to *use SSH*.
|
||||
|
||||
.. image:: ./media/advanced-submodules-github-sshurl.png
|
||||
.. image:: submodules/advanced-submodules-github-sshurl.png
|
||||
:align: center
|
||||
|
||||
.. _odoosh-advanced-submodules-withgit:
|
||||
|
|
|
|||
|
Before Width: | Height: | Size: 6.1 KiB After Width: | Height: | Size: 6.1 KiB |
|
Before Width: | Height: | Size: 13 KiB After Width: | Height: | Size: 13 KiB |
|
Before Width: | Height: | Size: 8.4 KiB After Width: | Height: | Size: 8.4 KiB |
|
|
@@ -8,7 +8,7 @@ Overview
|
|||
|
||||
The branches view gives you an overview of the different branches your repository has.
|
||||
|
||||
.. image:: ./media/interface-branches.png
|
||||
.. image:: branches/interface-branches.png
|
||||
:align: center
|
||||
|
||||
.. _odoosh-gettingstarted-branches-stages:
|
||||
|
|
@@ -20,7 +20,7 @@ Odoo.sh offers three different stages for your branches: production, staging and
|
|||
|
||||
You can change the stage of a branch by drag and dropping it into the stage section title.
|
||||
|
||||
.. image:: ./media/interface-branches-stagechange.png
|
||||
.. image:: branches/interface-branches-stagechange.png
|
||||
:align: center
|
||||
|
||||
.. _stage_production:
|
||||
|
|
@@ -42,7 +42,7 @@ instance will be held temporarily unavailable for maintenance reason.
|
|||
|
||||
This method is equivalent to perform an upgrade of the module through the Apps menu,
|
||||
or through the :code:`-u` switch of
|
||||
:doc:`the command line </developer/misc/other/cmdline>`.
|
||||
:doc:`the command line </developer/cli>`.
|
||||
|
||||
In the case the changes in the commit prevent the server to restart,
|
||||
or if the modules update fails,
|
||||
|
|
@@ -109,7 +109,7 @@ Merging your branches
|
|||
---------------------
|
||||
You can merge your branches easily by drag and dropping them into each other.
|
||||
|
||||
.. image:: ./media/interface-branches-merge.png
|
||||
.. image:: branches/interface-branches-merge.png
|
||||
:align: center
|
||||
|
||||
When you want to test the changes of your development branches with the production data,
|
||||
|
|
@@ -156,7 +156,7 @@ An overview of your branch history:
|
|||
* The messages of the commits and their authors,
|
||||
* The various events linked to the platform, such as stage changes, database imports, backup restores.
|
||||
|
||||
.. image:: ./media/interface-branches-history.png
|
||||
.. image:: branches/interface-branches-history.png
|
||||
:align: center
|
||||
|
||||
For each event, a status is displayed in the top right-hand corner.
|
||||
|
|
@@ -172,7 +172,7 @@ This tab contains the mail catcher. It displays an overview of the emails sent b
|
|||
The mail catcher is available for your development and
|
||||
staging branches as the emails of your production database are really sent instead of being intercepted.
|
||||
|
||||
.. image:: ./media/interface-branches-mails.png
|
||||
.. image:: branches/interface-branches-mails.png
|
||||
:align: center
|
||||
:scale: 50%
|
||||
|
||||
|
|
@@ -181,7 +181,7 @@ Shell
|
|||
A shell access to your container. You can perform basic linux commands (:code:`ls`, :code:`top`)
|
||||
and open a shell on your database by typing :code:`psql`.
|
||||
|
||||
.. image:: ./media/interface-branches-shell.png
|
||||
.. image:: branches/interface-branches-shell.png
|
||||
:align: center
|
||||
|
||||
You can open multiple tabs and drag-and-drop them to arrange the layout as you wish,
|
||||
|
|
@@ -197,7 +197,7 @@ Editor
|
|||
An online integrated development environment (IDE) to edit the source code.
|
||||
You can also open terminals, Python consoles and even Odoo Shell consoles.
|
||||
|
||||
.. image:: ./media/interface-branches-editor.png
|
||||
.. image:: branches/interface-branches-editor.png
|
||||
:align: center
|
||||
|
||||
You can open multiple tabs and drag-and-drop them to arrange the layout as you wish,
|
||||
|
|
@@ -207,7 +207,7 @@ 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.
|
||||
|
|
@@ -219,7 +219,7 @@ 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:
|
||||
|
|
@@ -243,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.
|
||||
|
|
@@ -279,13 +279,24 @@ The *import database* feature accepts database archives in the format provided b
|
|||
* the Odoo.sh backup download button of this *Backups* tab,
|
||||
* the Odoo.sh dump download button in the :ref:`Builds view <odoosh-gettingstarted-builds>`.
|
||||
|
||||
.. _odoo_sh/upgrade:
|
||||
|
||||
Upgrade
|
||||
-------
|
||||
|
||||
Available for production and staging branches for valid projects.
|
||||
|
||||
.. seealso::
|
||||
:doc:`Upgrade - Odoo.sh <../../upgrade/odoo_sh>`
|
||||
|
||||
.. _odoosh-gettingstarted-branches-tabs-settings:
|
||||
|
||||
Settings
|
||||
--------
|
||||
|
||||
Here you can find a couple of settings that only apply to the currently selected branch.
|
||||
|
||||
.. image:: ./media/interface-branches-settings.jpg
|
||||
.. image:: branches/interface-branches-settings.jpg
|
||||
:align: center
|
||||
|
||||
**Behaviour upon new commit**
|
||||
|
|
@@ -302,7 +313,7 @@ back from staging to development will automatically be set to 'Do nothing'.
|
|||
|
||||
Choose the modules to install automatically for your development builds.
|
||||
|
||||
.. image:: ./media/interface-settings-modulesinstallation.png
|
||||
.. image:: branches/interface-settings-modulesinstallation.png
|
||||
:align: center
|
||||
|
||||
* *Install only my modules* will install the modules of the branch only. This is the default option.
|
||||
|
|
@@ -384,7 +395,7 @@ 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 documentation about :ref:`SPF
|
||||
The configuration steps are explained in the documentation about :ref:`SPF
|
||||
<email_communication/spf_compliant>` and :ref:`DKIM <email_communication/dkim_compliant>`.
|
||||
|
||||
|
||||
|
|
@@ -397,7 +408,7 @@ Shell commands
|
|||
==============
|
||||
In the top right-hand corner of the view, different shell commands are available.
|
||||
|
||||
.. image:: ./media/interface-branches-shellcommands.png
|
||||
.. image:: branches/interface-branches-shellcommands.png
|
||||
:align: center
|
||||
|
||||
Each command can be copied in the clipboard to be used in a terminal,
|
||||
|
|
@@ -466,12 +477,12 @@ To do so, follow these steps:
|
|||
(only apply the step 1)
|
||||
#. Paste the copied content to your profile SSH keys and press "Add"
|
||||
|
||||
.. image:: ./media/SSH-key-pasting.png
|
||||
.. image:: branches/SSH-key-pasting.png
|
||||
:align: center
|
||||
|
||||
#. The key should appear below
|
||||
|
||||
.. image:: ./media/SSH-key-appearing.png
|
||||
.. image:: branches/SSH-key-appearing.png
|
||||
:align: center
|
||||
|
||||
Connection
|
||||
|
|
@@ -485,7 +496,7 @@ To connect to your builds using ssh use the following command in a terminal:
|
|||
|
||||
You will find a shortcut for this command into the SSH tab in the upper right corner.
|
||||
|
||||
.. image:: ./media/SSH-panel.png
|
||||
.. image:: branches/SSH-panel.png
|
||||
:align: center
|
||||
|
||||
Provided you have the :ref:`correct access rights <odoosh-gettingstarted-settings-collaborators>` on the project,
|
||||
|
|
|
|||
|
Before Width: | Height: | Size: 6.1 KiB After Width: | Height: | Size: 6.1 KiB |
|
Before Width: | Height: | Size: 23 KiB After Width: | Height: | Size: 23 KiB |
|
Before Width: | Height: | Size: 4.7 KiB After Width: | Height: | Size: 4.7 KiB |
|
Before Width: | Height: | Size: 66 KiB After Width: | Height: | Size: 66 KiB |
|
Before Width: | Height: | Size: 33 KiB After Width: | Height: | Size: 33 KiB |
|
Before Width: | Height: | Size: 12 KiB After Width: | Height: | Size: 12 KiB |
|
Before Width: | Height: | Size: 40 KiB After Width: | Height: | Size: 40 KiB |
|
Before Width: | Height: | Size: 27 KiB After Width: | Height: | Size: 27 KiB |
|
Before Width: | Height: | Size: 6.4 KiB After Width: | Height: | Size: 6.4 KiB |
|
Before Width: | Height: | Size: 84 KiB After Width: | Height: | Size: 84 KiB |
|
Before Width: | Height: | Size: 78 KiB After Width: | Height: | Size: 78 KiB |
|
Before Width: | Height: | Size: 8.3 KiB After Width: | Height: | Size: 8.3 KiB |
|
Before Width: | Height: | Size: 4.9 KiB After Width: | Height: | Size: 4.9 KiB |
|
Before Width: | Height: | Size: 5.6 KiB After Width: | Height: | Size: 5.6 KiB |
|
Before Width: | Height: | Size: 33 KiB After Width: | Height: | Size: 33 KiB |
|
Before Width: | Height: | Size: 5.1 KiB After Width: | Height: | Size: 5.1 KiB |
|
|
@@ -13,7 +13,7 @@ In Odoo.sh, a build is considered as a database loaded by an Odoo server
|
|||
running on a specific revision of your project repository in a containerized environment.
|
||||
Its purpose is to test the well-behavior of the server, the database and the features with this revision.
|
||||
|
||||
.. image:: ./media/interface-builds.png
|
||||
.. image:: builds/interface-builds.png
|
||||
:align: center
|
||||
|
||||
In this view, a row represents a branch, and a cell of a row represents a build of this branch.
|
||||
|
|
@@ -95,7 +95,7 @@ Features
|
|||
The production branch will always appear first,
|
||||
and then the other branches are ordered by last build created. You can filter out the branches.
|
||||
|
||||
.. image:: ./media/interface-builds-branches.png
|
||||
.. image:: builds/interface-builds-branches.png
|
||||
:align: center
|
||||
|
||||
For each branch, you can access the last build's database using the *Connect* link and jump to the branch code using
|
||||
|
|
@@ -103,7 +103,7 @@ the *Github* link. For other branches than the production, you can create a new
|
|||
of the branch using the link *rebuild*. This last link is not available when there is already a build in progress for
|
||||
the branch.
|
||||
|
||||
.. image:: ./media/interface-builds-build.png
|
||||
.. image:: builds/interface-builds-build.png
|
||||
:align: center
|
||||
|
||||
For each build, you can access the revision changes using the button with the Github icon.
|
||||
|
|
@@ -113,7 +113,7 @@ in the dropdown menu of the *Connect* button.
|
|||
|
||||
.. _odoosh-gettingstarted-builds-download-dump:
|
||||
|
||||
.. image:: ./media/interface-builds-build-dropdown.png
|
||||
.. image:: builds/interface-builds-build-dropdown.png
|
||||
:align: center
|
||||
|
||||
.. _odoosh-gettingstarted-builds-dropdown-menu:
|
||||
|
|
|
|||
|
Before Width: | Height: | Size: 4.4 KiB After Width: | Height: | Size: 4.4 KiB |
|
Before Width: | Height: | Size: 6.9 KiB After Width: | Height: | Size: 6.9 KiB |
|
Before Width: | Height: | Size: 2.5 KiB After Width: | Height: | Size: 2.5 KiB |
|
Before Width: | Height: | Size: 16 KiB After Width: | Height: | Size: 16 KiB |
|
|
@@ -10,7 +10,7 @@ Deploy your platform
|
|||
|
||||
Go to `Odoo.sh <https://www.odoo.sh/>`_ and hit the *Deploy your platform* button.
|
||||
|
||||
.. image:: ./media/deploy.png
|
||||
.. image:: create/deploy.png
|
||||
:align: center
|
||||
|
||||
Sign in with Github
|
||||
|
|
@@ -18,7 +18,7 @@ Sign in with Github
|
|||
|
||||
Sign in with your Github account. If you do not have an account yet, hit the *Create an account* link.
|
||||
|
||||
.. image:: ./media/github-signin.png
|
||||
.. image:: create/github-signin.png
|
||||
:align: center
|
||||
|
||||
Authorize Odoo.sh
|
||||
|
|
@@ -26,7 +26,7 @@ Authorize Odoo.sh
|
|||
|
||||
Grant Odoo.sh the required accesses to your account by clicking the *Authorize* button.
|
||||
|
||||
.. image:: ./media/github-authorize.png
|
||||
.. image:: create/github-authorize.png
|
||||
:align: center
|
||||
|
||||
Odoo.sh basically needs:
|
||||
|
|
@@ -62,7 +62,7 @@ When submitting the form, if you are notified your subscription is not valid, it
|
|||
|
||||
In case of doubt with your subscription, please contact the `Odoo support <https://www.odoo.com/help>`_.
|
||||
|
||||
.. image:: ./media/deploy-form.png
|
||||
.. image:: create/deploy-form.png
|
||||
:align: center
|
||||
|
||||
You're done !
|
||||
|
|
@@ -70,7 +70,7 @@ You're done !
|
|||
|
||||
You can start using Odoo.sh. Your first build is about to be created. You will soon be able to connect to your first database.
|
||||
|
||||
.. image:: ./media/deploy-done.png
|
||||
.. image:: create/deploy-done.png
|
||||
:align: center
|
||||
|
||||
.. _odoo_sh_import_your_database:
|
||||
|
|
@@ -113,12 +113,12 @@ Access the URL :file:`/web/database/manager` of your on-premise database and dow
|
|||
|
||||
You will need the master password of your database server. If you do not have it, contact your system administrator.
|
||||
|
||||
.. image:: ./media/create-import-onpremise-backup.png
|
||||
.. image:: create/create-import-onpremise-backup.png
|
||||
:align: center
|
||||
|
||||
Choose a zip including the filestore as the backup format.
|
||||
|
||||
.. image:: ./media/create-import-onpremise-backup-dialog.png
|
||||
.. image:: create/create-import-onpremise-backup-dialog.png
|
||||
:align: center
|
||||
|
||||
Odoo Online databases
|
||||
|
|
@@ -126,7 +126,7 @@ Odoo Online databases
|
|||
|
||||
`Access your databases manager <https://accounts.odoo.com/my/databases/manage>`_ and download a backup of your database.
|
||||
|
||||
.. image:: ./media/create-import-online-backup.png
|
||||
.. image:: create/create-import-online-backup.png
|
||||
:align: center
|
||||
|
||||
.. Warning::
|
||||
|
|
@@ -138,12 +138,12 @@ Upload the backup
|
|||
|
||||
Then, in your Odoo.sh project, in the backups tab of your production branch, import the backup you just downloaded.
|
||||
|
||||
.. image:: ./media/create-import-production.png
|
||||
.. image:: create/create-import-production.png
|
||||
:align: center
|
||||
|
||||
Once the backup imported, you can access the database using the *Connect* button in the history of the branch.
|
||||
|
||||
.. image:: ./media/create-import-production-done.png
|
||||
.. image:: create/create-import-production-done.png
|
||||
:align: center
|
||||
|
||||
Check your outgoing email servers
|
||||
|
|
|
|||
|
Before Width: | Height: | Size: 7.4 KiB After Width: | Height: | Size: 7.4 KiB |
|
Before Width: | Height: | Size: 7.9 KiB After Width: | Height: | Size: 7.9 KiB |
|
Before Width: | Height: | Size: 12 KiB After Width: | Height: | Size: 12 KiB |
|
Before Width: | Height: | Size: 18 KiB After Width: | Height: | Size: 18 KiB |
|
Before Width: | Height: | Size: 19 KiB After Width: | Height: | Size: 19 KiB |
|
Before Width: | Height: | Size: 24 KiB After Width: | Height: | Size: 24 KiB |
|
Before Width: | Height: | Size: 29 KiB After Width: | Height: | Size: 29 KiB |
|
Before Width: | Height: | Size: 34 KiB After Width: | Height: | Size: 34 KiB |
|
Before Width: | Height: | Size: 13 KiB After Width: | Height: | Size: 13 KiB |
|
Before Width: | Height: | Size: 6.9 KiB After Width: | Height: | Size: 6.9 KiB |
|
|
@@ -37,20 +37,20 @@ In the branches view:
|
|||
|
||||
|pic1| |pic2|
|
||||
|
||||
.. |pic1| image:: ./media/firstmodule-development-+.png
|
||||
.. |pic1| image:: first_module/firstmodule-development-+.png
|
||||
:width: 45%
|
||||
|
||||
.. |pic2| image:: ./media/firstmodule-development-fork.png
|
||||
.. |pic2| image:: first_module/firstmodule-development-fork.png
|
||||
:width: 45%
|
||||
|
||||
|
||||
Once the build created, you can access the editor and browse to the folder *~/src/user* to access
|
||||
to the code of your development branch.
|
||||
|
||||
.. image:: ./media/firstmodule-development-editor.png
|
||||
.. image:: first_module/firstmodule-development-editor.png
|
||||
:align: center
|
||||
|
||||
.. image:: ./media/firstmodule-development-editor-interface.png
|
||||
.. image:: first_module/firstmodule-development-editor-interface.png
|
||||
:align: center
|
||||
|
||||
From your computer
|
||||
|
|
@@ -95,7 +95,7 @@ Or, from your computer, if you have an :ref:`installation of Odoo <setup/install
|
|||
$ ./odoo-bin scaffold my_module ~/src/odoo-addons/
|
||||
|
||||
If you do not want to bother installing Odoo on your computer,
|
||||
you can also :download:`download this module structure template <media/my_module.zip>` in which you replace every occurrences of
|
||||
you can also :download:`download this module structure template <first_module/my_module.zip>` in which you replace every occurrences of
|
||||
*my_module* to the name of your choice.
|
||||
|
||||
The below structure will be generated:
|
||||
|
|
@@ -201,19 +201,19 @@ Test your module
|
|||
|
||||
Your branch should appear in your development branches in your project.
|
||||
|
||||
.. image:: ./media/firstmodule-test-branch.png
|
||||
.. image:: first_module/firstmodule-test-branch.png
|
||||
:align: center
|
||||
|
||||
In the branches view of your project,
|
||||
you can click on your branch name in the left navigation panel to access its history.
|
||||
|
||||
.. image:: ./media/firstmodule-test-branch-history.png
|
||||
.. image:: first_module/firstmodule-test-branch-history.png
|
||||
:align: center
|
||||
|
||||
You can see here the changes you just pushed, including the comment you set.
|
||||
Once the database ready, you can access it by clicking the *Connect* button.
|
||||
|
||||
.. image:: ./media/firstmodule-test-database.png
|
||||
.. image:: first_module/firstmodule-test-database.png
|
||||
:align: center
|
||||
|
||||
If your Odoo.sh project is configured to install your module automatically,
|
||||
|
|
@@ -234,12 +234,12 @@ You can either:
|
|||
|
||||
* Make your development branch a staging branch, by drag and dropping it onto the *staging* section title.
|
||||
|
||||
.. image:: ./media/firstmodule-test-devtostaging.png
|
||||
.. image:: first_module/firstmodule-test-devtostaging.png
|
||||
:align: center
|
||||
|
||||
* Merge it in an existing staging branch, by drag and dropping it onto the given staging branch.
|
||||
|
||||
.. image:: ./media/firstmodule-test-devinstaging.png
|
||||
.. image:: first_module/firstmodule-test-devinstaging.png
|
||||
:align: center
|
||||
|
||||
You can also use the :code:`git merge` command to merge your branches.
|
||||
|
|
@@ -247,7 +247,7 @@ You can also use the :code:`git merge` command to merge your branches.
|
|||
This will create a new staging build, which will duplicate the production database and make it run using a server
|
||||
updated with your latest changes of your branch.
|
||||
|
||||
.. image:: ./media/firstmodule-test-mergedinstaging.png
|
||||
.. image:: first_module/firstmodule-test-mergedinstaging.png
|
||||
:align: center
|
||||
|
||||
Once the database ready, you can access it using the *Connect* button.
|
||||
|
|
@@ -267,12 +267,12 @@ Your module may not appear directly in your apps to install either, you need to
|
|||
* in the apps menu, click the *Update Apps List* button,
|
||||
* in the dialog that appears, click the *Update* button.
|
||||
|
||||
.. image:: ./media/firstmodule-test-updateappslist.png
|
||||
.. image:: first_module/firstmodule-test-updateappslist.png
|
||||
:align: center
|
||||
|
||||
Your module will then appear in the list of available apps.
|
||||
|
||||
.. image:: ./media/firstmodule-test-mymoduleinapps.png
|
||||
.. image:: first_module/firstmodule-test-mymoduleinapps.png
|
||||
:align: center
|
||||
|
||||
Deploy in production
|
||||
|
|
@@ -283,7 +283,7 @@ and believe it is ready for production, you can merge your branch in the product
|
|||
|
||||
Drag and drop your staging branch on the production branch.
|
||||
|
||||
.. image:: ./media/firstmodule-test-mergeinproduction.png
|
||||
.. image:: first_module/firstmodule-test-mergeinproduction.png
|
||||
:align: center
|
||||
|
||||
You can also use the :code:`git merge` command to merge your branches.
|
||||
|
|
@@ -291,7 +291,7 @@ You can also use the :code:`git merge` command to merge your branches.
|
|||
This will merge the latest changes of your staging branch in the production branch,
|
||||
and update your production server with these latest changes.
|
||||
|
||||
.. image:: ./media/firstmodule-test-mergedinproduction.png
|
||||
.. image:: first_module/firstmodule-test-mergedinproduction.png
|
||||
:align: center
|
||||
|
||||
Once the database ready, you can access it using the *Connect* button.
|
||||
|
|
@@ -411,7 +411,7 @@ Or, from your computer terminal:
|
|||
|
||||
The platform will then create a new build for the branch *feature-1*.
|
||||
|
||||
.. image:: ./media/firstmodule-test-addachange-build.png
|
||||
.. image:: first_module/firstmodule-test-addachange-build.png
|
||||
:align: center
|
||||
|
||||
Once you tested your changes, you can merge your changes in the production branch, for instance by drag-and-dropping the
|
||||
|
|
|
|||
|
Before Width: | Height: | Size: 5.2 KiB After Width: | Height: | Size: 5.2 KiB |
|
Before Width: | Height: | Size: 18 KiB After Width: | Height: | Size: 18 KiB |
|
Before Width: | Height: | Size: 3.2 KiB After Width: | Height: | Size: 3.2 KiB |
|
Before Width: | Height: | Size: 2.8 KiB After Width: | Height: | Size: 2.8 KiB |
|
Before Width: | Height: | Size: 27 KiB After Width: | Height: | Size: 27 KiB |
|
Before Width: | Height: | Size: 22 KiB After Width: | Height: | Size: 22 KiB |
|
Before Width: | Height: | Size: 2.0 KiB After Width: | Height: | Size: 2.0 KiB |
|
Before Width: | Height: | Size: 10 KiB After Width: | Height: | Size: 10 KiB |
|
Before Width: | Height: | Size: 4.2 KiB After Width: | Height: | Size: 4.2 KiB |
|
Before Width: | Height: | Size: 3.4 KiB After Width: | Height: | Size: 3.4 KiB |
|
Before Width: | Height: | Size: 18 KiB After Width: | Height: | Size: 18 KiB |
|
Before Width: | Height: | Size: 18 KiB After Width: | Height: | Size: 18 KiB |
|
Before Width: | Height: | Size: 3.7 KiB After Width: | Height: | Size: 3.7 KiB |
|
Before Width: | Height: | Size: 11 KiB After Width: | Height: | Size: 11 KiB |
|
Before Width: | Height: | Size: 11 KiB After Width: | Height: | Size: 11 KiB |
|
Before Width: | Height: | Size: 1.6 KiB |
|
|
@@ -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
|
||||
|
|
@@ -37,7 +37,6 @@ The working directory is composed of the following folders:
|
|||
│ │ ├── enterprise Odoo Enterprise source code
|
||||
│ │ ├── themes Odoo Themes source code
|
||||
│ │ └── user Your repository branch source code
|
||||
│ ├── repositories The Git repositories used by your project
|
||||
│ ├── data
|
||||
│ │ ├── filestore database attachments, as well as the files of binary fields
|
||||
│ │ └── sessions visitors and users sessions
|
||||
|
|
@@ -66,20 +65,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 +87,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 +117,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 +159,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 +188,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
|
||||
|
|
|
|||
|
Before Width: | Height: | Size: 2.0 MiB After Width: | Height: | Size: 2.0 MiB |
|
Before Width: | Height: | Size: 17 KiB After Width: | Height: | Size: 17 KiB |
|
Before Width: | Height: | Size: 15 KiB After Width: | Height: | Size: 15 KiB |
|
Before Width: | Height: | Size: 7.8 KiB After Width: | Height: | Size: 7.8 KiB |
|
Before Width: | Height: | Size: 22 KiB After Width: | Height: | Size: 22 KiB |
|
Before Width: | Height: | Size: 42 KiB After Width: | Height: | Size: 42 KiB |
|
Before Width: | Height: | Size: 43 KiB After Width: | Height: | Size: 43 KiB |
|
Before Width: | Height: | Size: 44 KiB After Width: | Height: | Size: 44 KiB |
|
Before Width: | Height: | Size: 23 KiB After Width: | Height: | Size: 23 KiB |
|
|
@@ -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
|
||||
|
|
|
|||
|
Before Width: | Height: | Size: 10 KiB After Width: | Height: | Size: 10 KiB |
|
Before Width: | Height: | Size: 3.9 KiB After Width: | Height: | Size: 3.9 KiB |
|
Before Width: | Height: | Size: 4.9 KiB After Width: | Height: | Size: 4.9 KiB |
|
Before Width: | Height: | Size: 2.8 KiB After Width: | Height: | Size: 2.8 KiB |
|
Before Width: | Height: | Size: 19 KiB After Width: | Height: | Size: 19 KiB |
|
Before Width: | Height: | Size: 32 KiB After Width: | Height: | Size: 32 KiB |
|
Before Width: | Height: | Size: 12 KiB After Width: | Height: | Size: 12 KiB |
|
Before Width: | Height: | Size: 24 KiB After Width: | Height: | Size: 24 KiB |
|
Before Width: | Height: | Size: 18 KiB After Width: | Height: | Size: 18 KiB |
|
|
@@ -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
|
||||
|
|
|
|||
|
Before Width: | Height: | Size: 35 KiB After Width: | Height: | Size: 35 KiB |
|
|
@@ -1,66 +1,132 @@
|
|||
|
||||
=======
|
||||
Odoo.sh
|
||||
=======
|
||||
|
||||
Test upgrade request
|
||||
====================
|
||||
.. _upgrade/odoo_sh/overview:
|
||||
|
||||
Download a dump of your database (from the :ref:`Builds view
|
||||
<odoosh-gettingstarted-builds-download-dump>`), choose the **exact copy** and **without filestore**
|
||||
options. Upload the .sql.gz dump on https://upgrade.odoo.com/upload and select the testing purpose.
|
||||
Once it's processed, you'll get a dump of the database in return.
|
||||
Overview
|
||||
========
|
||||
|
||||
.. important::
|
||||
To have the most up-to-date test version of your database, create a backup of your production
|
||||
database just before creating your request. Upload it in your staging branch, select **Exact
|
||||
dump** and **Without filestore**, and then click *start*.
|
||||
|
||||
Test your upgraded database
|
||||
===========================
|
||||
|
||||
At the beginning of your upgrade project, make sure that you create a new staging branch for testing
|
||||
purposes by forking your main branch.
|
||||
|
||||
Once the staging build is complete (it doesn't matter if it failed due to the version
|
||||
incompatibility), import your upgraded dump in the *Backups* tab of the branch.
|
||||
Odoo.sh is integrated with the upgrade platform to make the upgrade process easier.
|
||||
|
||||
.. note::
|
||||
The platform automatically detects the version of the dump and changes the version of Odoo's
|
||||
source code to the corresponding version of the build.
|
||||
The :guilabel:`Upgrade` tab is available in the branches view. It is only available for valid
|
||||
projects with a valid production build.
|
||||
|
||||
Test the upgraded database and make sure everything runs as it's supposed to.
|
||||
.. image:: odoo_sh/odoo-sh-menu.png
|
||||
:align: center
|
||||
:alt: Click on the upgrade menu
|
||||
|
||||
Upgrade your production database
|
||||
================================
|
||||
The suggested upgrade steps on Odoo.sh are:
|
||||
|
||||
Once you've tested everything and you're satisfied, start the process over to get an up-to-date
|
||||
upgraded dump:
|
||||
|
||||
* Make a new dump of your production database (as described in step 1)
|
||||
* Upload it on upgrade.odoo.com and select the Production purpose
|
||||
* Receive the newly upgraded dump and import it in your production branch. The build might get
|
||||
marked as failed because the platform will run it with the upgraded databases' Odoo version
|
||||
together with the old custom code.
|
||||
* Merge or commit the upgraded custom code in the production branch
|
||||
|
||||
If anything goes wrong, remember you can restore a backup. The platform will always make one before
|
||||
you make any Odoo.sh operation on the production database. If the restored backup comes from a
|
||||
previous version, the platform will detect it and change the project's Odoo version back if it needs
|
||||
to.
|
||||
|
||||
Custom modules (if applicable)
|
||||
==============================
|
||||
|
||||
The upgrade of a database that contains custom modules is a 2 step process.
|
||||
|
||||
#. The standard upgrade is done when your upgrade request is completed.
|
||||
#. Your custom modules also need to be upgraded to keep them compatible with the new version.
|
||||
|
||||
Depending on your contract, the upgrade of your custom modules can be done
|
||||
- by yourself
|
||||
- by your Partner
|
||||
- by Odoo (if you hold a subscription to 'Maintenance of Customizations')
|
||||
#. On a :guilabel:`Development` branch, upgrade your custom modules to keep them compatible with the
|
||||
new version and thoroughly **test them**.
|
||||
#. Switch that branch to the :guilabel:`Staging` branch, **upgrade** the last daily production
|
||||
backup and **test it**. Write upgrade scripts if necessary.
|
||||
#. Trigger the production upgrade from your :guilabel:`Production` branch and sit tight.
|
||||
|
||||
.. seealso::
|
||||
- :ref:`upgrade/sla`
|
||||
- :doc:`../../administration/upgrade`
|
||||
- :doc:`Upgrade FAQ <../upgrade/faq>`
|
||||
- :doc:`Introduction to Odoo.sh <../odoo_sh/overview/introduction>`
|
||||
|
||||
.. _upgrade/odoo_sh/custom-modules:
|
||||
|
||||
Upgrade your custom modules
|
||||
===========================
|
||||
|
||||
The first step is to upgrade your custom modules to keep them compatible with the new version. Fork
|
||||
your :guilabel:`Production` branch in the :guilabel:`Development` stage, then go to the settings of
|
||||
your :guilabel:`Development` branch and select the Odoo version you target. If needed, modify your
|
||||
code to be compatible with the new version. Make sure to **test** your features are still working
|
||||
correctly.
|
||||
|
||||
.. note::
|
||||
Depending on your contract, the upgrade of your custom modules can be done by yourself, by your
|
||||
Partner or by Odoo (if you hold a subscription including maintenance of customizations).
|
||||
|
||||
.. _upgrade/odoo_sh/testing-phase:
|
||||
|
||||
Upgrade your database on a staging branch
|
||||
=========================================
|
||||
|
||||
Take the upgraded development branch and drag & drop it to :guilabel:`Staging`.
|
||||
|
||||
Go to the :guilabel:`Upgrade` tab and select the :guilabel:`target version`. Then, click on
|
||||
:guilabel:`Test Upgrade`.
|
||||
|
||||
.. image:: odoo_sh/odoo-sh-staging.png
|
||||
:align: center
|
||||
:alt: Odoo.sh project and tabs
|
||||
|
||||
The **latest production daily automatic backup** is sent to the
|
||||
`upgrade platform <https://www.upgrade.odoo.com>`_ to start the upgrade test process.
|
||||
|
||||
.. note::
|
||||
You can follow the upgrade process by going to the :guilabel:`Upgrade` menu of your
|
||||
:guilabel:`Production` branch.
|
||||
|
||||
When the upgraded backup is ready on the `upgrade platform <https://www.upgrade.odoo.com>`_, it is
|
||||
automatically downloaded back to your project.
|
||||
|
||||
The branch is now in a **special mode**: each time a **commit is pushed** on the branch, a
|
||||
**restore operation** of the upgraded backup occurs, and an **update of all the custom modules**
|
||||
happens. This allows you to quickly iterate on your custom modules upgrade scripts. The log file of
|
||||
the upgrade process can be found at :file:`~/logs/upgrade.log` in your newly upgraded staging build.
|
||||
|
||||
.. note::
|
||||
- The **special upgrade mode** is automatically closed after 30 days.
|
||||
- It may happen that custom modules are no longer needed after an upgrade. Custom modules in the
|
||||
upgraded database are set to be updated. If the modules are missing in the code, the update
|
||||
fails, thus failing the whole process. An empty module with a manifest and possibly some custom
|
||||
upgrade script are necessary to clean up the database. The complete removal of the module has
|
||||
to be handled afterwards.
|
||||
|
||||
Functionally test your upgraded database
|
||||
========================================
|
||||
|
||||
Now that the test upgraded database is available on your staging branch, **thoroughly test it** and
|
||||
make sure everything runs as it's supposed to. Once you are satisfied with the result, you are ready
|
||||
to upgrade your production database.
|
||||
|
||||
Production upgrade
|
||||
==================
|
||||
|
||||
Once you are happy with your testing, you can start the process on the :guilabel:`Production`
|
||||
branch.
|
||||
|
||||
On your :guilabel:`Production` branch, go to the :guilabel:`Upgrade` tab, select the
|
||||
:guilabel:`targeted version` and click on the :guilabel:`start Upgrade` button.
|
||||
|
||||
.. image:: odoo_sh/odoo-sh-prod.png
|
||||
:align: center
|
||||
:alt: View from the upgrade tab
|
||||
|
||||
The actual process is **triggered as soon as you push a new commit** in your branch. Make sure you
|
||||
are pushing code that is compatible with the new version. For example by merging the code from your
|
||||
upgraded staging branch.
|
||||
|
||||
.. note::
|
||||
You can see the progress of the upgrade by going to the :guilabel:`Upgrade` tab of the main
|
||||
branch.
|
||||
|
||||
.. image:: odoo_sh/odoo-sh-progress.png
|
||||
:align: center
|
||||
:alt: View showing the progress of the upgrade
|
||||
|
||||
.. important::
|
||||
Your database is unavailable throughout the process.
|
||||
|
||||
.. note::
|
||||
If anything goes wrong, the platform automatically reverts the upgrade, the same as it would be
|
||||
for a regular update. In case of success, a backup is always made.
|
||||
|
||||
The update of your custom modules must be successful to complete the entire upgrade process. Make
|
||||
sure the status of your staging upgrade is :guilabel:`successful` before trying it in production.
|
||||
|
||||
.. note::
|
||||
It may happen that custom modules are no longer needed after an upgrade. Custom modules in the
|
||||
upgraded database are set to be updated. If the modules are missing in the code, the update
|
||||
fails, thus failing the whole process. An empty module with a manifest and possibly some custom
|
||||
upgrade script are necessary to clean up the database. The complete removal of the module has to
|
||||
be handled afterwards.
|
||||
|
|
|
|||
BIN
content/administration/upgrade/odoo_sh/odoo-sh-menu.png
Normal file
|
After Width: | Height: | Size: 4.3 KiB |