Skip to content

Commit 7b1ca05

Browse files
committed
wip[IMP] upgrade documentation
1 parent 88c2aac commit 7b1ca05

33 files changed

+228
-18
lines changed

content/administration/maintain/odoo_online.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ Trigger a database upgrade.
3131

3232
.. seealso::
3333
For more information about the upgrade process, check out the :doc:`Odoo Online upgrade
34-
documentation <../upgrade/odoo_online>`.
34+
documentation <../../upgrade/request/odoo_online>`.
3535

3636
.. _odoo_online/duplicate:
3737

content/administration/odoo_sh/getting_started/branches.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -295,7 +295,7 @@ Upgrade
295295
Available for production and staging branches for valid projects.
296296

297297
.. seealso::
298-
:doc:`Upgrade - Odoo.sh <../../upgrade/odoo_sh>`
298+
:doc:`Upgrade - Odoo.sh <../../../upgrade/request/odoo_sh>`
299299

300300
.. _odoosh-gettingstarted-branches-tabs-settings:
301301

content/administration/upgrade.rst

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -12,10 +12,10 @@ Upgrade
1212
.. toctree::
1313
:titlesonly:
1414

15-
upgrade/odoo_online
16-
upgrade/odoo_sh
17-
upgrade/on_premise
18-
upgrade/faq
15+
../upgrade/request/odoo_online
16+
../upgrade/request/odoo_sh
17+
../upgrade/request/on_premise
18+
../upgrade/faq
1919

2020
An upgrade is switching to a newer version of Odoo (e.g., Odoo 14.0 to Odoo 15.0).
2121

@@ -54,9 +54,9 @@ The upgrade process in a nutshell:
5454
newly upgraded database (this is done automatically on Odoo Online).
5555

5656
.. seealso::
57-
- :doc:`Upgrade process for Odoo Online <upgrade/odoo_online>`
58-
- :doc:`Upgrade process for Odoo.sh <upgrade/odoo_sh>`
59-
- :doc:`Upgrade process for On-Premise <upgrade/on_premise>`
57+
- :doc:`Upgrade process for Odoo Online <../upgrade/request/odoo_online>`
58+
- :doc:`Upgrade process for Odoo.sh <../upgrade/request/odoo_sh>`
59+
- :doc:`Upgrade process for On-Premise <../upgrade/request/on_premise>`
6060

6161
.. _upgrade/testing-phase:
6262

@@ -105,7 +105,7 @@ Request a test database
105105
Follow the instructions available per hosting type on the `website form
106106
<https://upgrade.odoo.com>`_ and select *Testing* purpose.
107107

108-
.. image:: upgrade/test-purpose.png
108+
.. image:: ../upgrade/request/test-purpose.png
109109
:align: center
110110
:alt: Selection of the "Testing" purpose in the upgrade form on Odoo
111111

@@ -131,7 +131,7 @@ via the `Odoo Support page <https://www.odoo.com/help>`_.
131131

132132
Under the *Ticket Description* section, select *An issue related to my upgrade* ticket type.
133133

134-
.. image:: upgrade/test-assistance.png
134+
.. image:: ../upgrade/request/test-assistance.png
135135
:align: center
136136
:alt: Selection of "An issue related to my upgrade" as Ticket Type in the support form on Odoo
137137

@@ -259,6 +259,6 @@ The following upgrade-related services are **not** included:
259259
.. note:: |assistance-contact|
260260

261261
.. seealso::
262-
- :doc:`Upgrade FAQ <upgrade/faq>`
262+
- :doc:`Upgrade FAQ <../upgrade/faq>`
263263
- :doc:`Odoo.sh documentation <odoo_sh>`
264264
- :doc:`Supported Odoo versions <maintain/supported_versions>`

content/index.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,5 +9,6 @@ Odoo Documentation
99

1010
applications
1111
administration
12+
upgrade
1213
developer
1314
contributing

content/upgrade.rst

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
:nosearch:
2+
:show-content:
3+
:hide-page-toc:
4+
:show-toc:
5+
6+
.. |assistance-contact| replace::
7+
If you need Odoo assistance on this matter, please get in touch with your Odoo Account Manager or
8+
our `Sales department`_.
9+
.. _Sales department: mailto:sales@odoo.com
10+
11+
=======
12+
Upgrade
13+
=======
14+
15+
These guides provide information on the upgrade process of your Odoo database as a whole, from planning and
16+
allocating resources for an upgrade, all the way to the post-upgrade support
17+
18+
TODO added this that was from the old upgrade page
19+
20+
An upgrade does not cover:
21+
22+
* Changing :ref:`editions <upgrade-faq/editions-change>` (i.e., Community to Enterprise edition)
23+
* Switching :ref:`hosting type <upgrade-faq/hosting-types-switch>` (i.e., On-Premise to Odoo Online
24+
or Odoo.sh)
25+
* Migration from another ERP to Odoo
26+
27+
.. note:: |assistance-contact|
28+
29+
.. seealso::
30+
- :ref:`upgrade/sla`
31+
32+
.. toctree::
33+
34+
upgrade/introduction
35+
upgrade/full_process
36+
upgrade/version_target
37+
upgrade/request
38+
upgrade/advanced

content/upgrade/advanced.rst

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
========
2+
Advanced
3+
========
4+
5+
.. toctree::
6+
:titlesonly:
7+
8+
advanced/odoo_shell
9+
advanced/util_package
10+
advanced/migration_scripts
11+
advanced/upgrade_data
12+
advanced/upgrade_studio_views
13+
advanced/upgrade_custom_code
Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
============================
2+
What are Migration Scripts ?
3+
============================
Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
==========
2+
Odoo Shell
3+
==========
4+
5+
If you're familiar with Odoo, you probably know the user-friendly Graphical User Interface (GUI), which is the web page where you carry out your operations in Odoo, commonly referred to as the web client or front-end.
6+
7+
.. image:: odoo_shell/odoo-web-client.png
8+
:alt: The Odoo web client we all know and love
9+
:align: center
10+
11+
The front-end simplifies complex operations like invoice validation, product transfers, and more, often triggered by a single button click. However, beneath this simplicity lies a significant amount of code execution, sometimes involving hundreds of lines!
12+
13+
Occasionally, you might face situations where you need to perform a straightforward operation on numerous records, such as checking a checkbox for each project in the Project App. Manually navigating menus for such tasks can be time-consuming and tedious 🥱
14+
15+
At Odoo, we value efficiency, and this is where the "Odoo Shell" comes into play. For seasoned Odoo users, it's a handy trick. The Odoo Shell allows direct interaction with the Object-Relational-Mapping (ORM), enabling you to manipulate data almost as if you were working directly within Odoo's source code. With just a few lines of code, you can, for instance, update all contact names in your database by adding an exclamation mark to each. This operation would take seconds in the Odoo Shell but potentially hours in the front-end. The Odoo Shell is a true blessing ! 🙏
16+
17+
.. image:: odoo_shell/odoo-shell-example.png
18+
:alt: An example of the use of the shell of Odoo : multiple lines of Python code that change the name of each partner to add an exclamation mark at the end of each partner
19+
:align: center
20+
21+
The Odoo Shell is essentially an extension of the `IPython shell <https://ipython.readthedocs.io/en/stable/>`_, directly connected to the Odoo database. While it's somewhat similar to creating a server or automated action and executing it, the Odoo Shell offers the flexibility to write code incrementally, exploring Odoo's inner workings. It's a valuable tool for developing migration scripts, allowing you to test the code you wrote before starting the whole upgrade process instead of risking a full database upgrade only to discover a minor coding error.
22+
23+
Accessing the Odoo Shell depends on your hosting type. For On-Premise databases, you can add the "shell" keyword as the first parameter when executing your instance. For instance, if you use `./odoo-bin -d my_database`, you can simply use `./odoo-bin shell -d my_database`. On Odoo SH, it's even simpler, as you have direct access to a bash terminal via the "Shell" tab. Once in the terminal, you can run the command `odoo-bin shell` to gain immediate access to your database's Odoo Shell. Convenient, isn't it?
24+
25+
The Odoo shell is not applicable to Odoo Online since users only have access to the web client, and not the server running their Odoo database.
18.1 KB
Loading
665 KB
Loading

0 commit comments

Comments
 (0)