[IMP] odoo.sh: partial update of the section

closes odoo/documentation#15317

X-original-commit: 6b6069a2f9
Signed-off-by: Xavier Platteau (xpl) <xpl@odoo.com>

content/administration/hosting.rst

@@ -39,8 +39,8 @@ To Odoo Online
 To Odoo.sh
 ----------
 
-Follow the instructions found in :ref:`the Import your database section
+Follow the instructions found in :ref:`the Import a database section <odoo-sh/create/import>` of the
-<odoo_sh_import_your_database>` of the Odoo.sh *Create your project* documentation.
+Odoo.sh *Create a project* documentation.
 
 Transferring an Odoo Online database
 ====================================
@@ -82,8 +82,8 @@ To Odoo.sh
    next to the database name, then selecting :icon:`fa-cloud-download` :guilabel:`Download`. If the
    download fails due to the file being too large, `contact Odoo support
    <https://www.odoo.com/help>`_.
-#. Follow the instructions found in :ref:`the Import your database section
+#. Follow the instructions found in :ref:`the Import a database section <odoo-sh/create/import>` of
-   <odoo_sh_import_your_database>` of the Odoo.sh *Create your project* documentation.
+   the Odoo.sh *Create a project* documentation.
 
 Transferring an Odoo.sh database
 ================================
@@ -119,5 +119,5 @@ To Odoo Online
 To on-premise
 -------------
 
-#. Download a :ref:`backup of your Odoo.sh production database <odoo_sh_branches_backups>`.
+#. Download a :ref:`backup of your Odoo.sh production database <odoo-sh/branches/tabs/backups>`.
 #. Restore the database from the database manager on your local server using the backup.

content/administration/odoo_sh.rst

@@ -1,12 +1,16 @@
-:nosearch:
+:show-content:
+:show-toc:
 
 =======
 Odoo.sh
 =======
 
+Odoo.sh is the official cloud platform for hosting and managing Odoo applications. It offers a
+range of features such as web shell, module dependencies, continuous integration, and SSH access.
 
 .. toctree::
+   :titlesonly:
 
-    odoo_sh/overview
    odoo_sh/getting_started
+   odoo_sh/first_module
    odoo_sh/advanced

content/administration/odoo_sh/first_module.rst

@@ -7,7 +7,7 @@ Overview
 
 This chapter helps you to create your first Odoo module and deploy it in your Odoo.sh project.
 
-This tutorial requires :ref:`you created a project on Odoo.sh <odoosh-gettingstarted-create>`, and
+This tutorial requires you created a project on Odoo.sh, and
 you know your Github repository's URL.
 
 Basic use of Git and Github is explained.
@@ -85,7 +85,7 @@ From the Odoo.sh editor, in a terminal:
 
   $ odoo-bin scaffold my_module ~/src/user/
 
-Or, from your computer, if you have an :doc:`installation of Odoo <../../on_premise/source>`:
+Or, from your computer, if you have an installation of Odoo:
 
 .. code-block:: bash
 
@@ -304,6 +304,8 @@ you have to install it manually as explained in the
 :ref:`above section about installing your module in staging databases
 <odoosh-gettingstarted-firstmodule-productiondata-install>`.
 
+.. _odoo-sh/module/add:
+
 Add a change
 ============
 

content/administration/odoo_sh/getting_started.rst

@@ -1,8 +1,51 @@
-:nosearch:
+:show-content:
 
-===========
+===============
-Get started
+Getting started
-===========
+===============
+
+Main components
+---------------
+
+When working with Odoo.sh, it is important to understand the main components involved. While they
+are all interconnected, each one plays a distinct role in the development and deployment of Odoo
+applications:
+
+- **GitHub repository**: a version-controlled space where the Odoo applications' source code is
+  stored. It tracks every change, supports collaboration, and can be either public or private.
+
+  .. image:: getting_started/github-repository.png
+     :alt: Example of a GitHub repository
+
+- **Odoo.sh project**: a Platform as a Service (PaaS) that integrates with GitHub and enables
+  streamlined development, testing, and deployment of Odoo applications. It includes tools such as
+  automated backups, staging environments, and continuous integration pipelines.
+
+  .. image:: getting_started/odoo-sh-project.png
+     :alt: Example of an Odoo.sh project
+
+- **Odoo database**: a database stores all the operational data used and generated by Odoo
+  applications, such as business records, configurations, and user data.
+
+  .. image:: getting_started/odoo-database.png
+     :alt: Example of an Odoo database
+
+Together, they form a cohesive pipeline from code development to a live business use.
+
+User types
+----------
+
+Odoo.sh involves different types of users, each with a specific role in the project lifecycle:
+
+- GitHub users: developers with access to the GitHub repository linked to the Odoo.sh project.
+  Access to the repository does not automatically make someone a collaborator on the Odoo.sh
+  project.
+
+- Odoo.sh collaborators: individuals managing the Odoo.sh project. Each collaborator must be
+  linked to a GitHub user. However, collaborators are not the same as database users.
+
+- Database users: end-users of the deployed Odoo database. They interact with the live system but
+  are not involved in development or project management.
 
 .. toctree::
    :titlesonly:
@@ -13,4 +56,3 @@ Get started
    getting_started/status
    getting_started/settings
    getting_started/online-editor
-   getting_started/first_module

content/administration/odoo_sh/getting_started/builds.rst

@@ -120,5 +120,5 @@ button.
 .. _odoosh-gettingstarted-builds-dropdown-menu:
 
 In the dropdown menu of the build, you can access the same features than in :ref:`the branches view
-<odoosh-gettingstarted-branches-tabs>`: *Logs*, *Web Shell*, *Editor*, *Outgoing e-mails*. You also
+<odoo-sh/branches/tabs>`: *Logs*, *Web Shell*, *Editor*, *Outgoing e-mails*. You also
 have the possibility to *Download a dump* of the build's database.

content/administration/odoo_sh/getting_started/create.rst

@@ -1,205 +1,192 @@
+================
+Create a project
+================
 
-.. _odoosh-gettingstarted-create:
+Deploy a platform
-
-===================
-Create your project
-===================
-
-Deploy your platform
-====================
-
-Go to `Odoo.sh <https://www.odoo.sh/>`_ and hit the *Deploy your platform* button.
-
-.. image:: create/deploy.png
-   :align: center
-
-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:: create/github-signin.png
-   :align: center
-
-Authorize Odoo.sh
 =================
 
-Grant Odoo.sh the required accesses to your account by clicking the *Authorize* button.
+#. Visit `Odoo.sh <https://www.odoo.sh>`_ and click :guilabel:`Deploy your platform`.
+
+   .. image:: create/deploy-button.png
+      :alt: The Deploy your platform button on Odoo.sh
+
+#. Sign in with a `GitHub <https://github.com>`_ account.
+
+   .. image:: create/github-sign-in.png
+      :alt: Signing in to GitHub
+
+#. Authorize Odoo.sh by clicking :guilabel:`Authorize odoo` twice.
 
    .. image:: create/github-authorize.png
-   :align: center
+      :alt: Granting Odoo.sh permissions to perform actions and access data on GitHub
 
-Odoo.sh basically needs:
+   .. image:: create/github-authorize.png
+      :alt: Granting Odoo.sh additional permissions to perform actions and access data on GitHub
 
-* to know your Github login and email,
+   .. note::
-* to create a new repository in case you decide to start from scratch,
+      Odoo.sh requests GitHub to:
-* to read your existing repositories, including the ones of your organizations, in case you want to
-  start from an existing repository,
-* to create a webhook to be notified each time you push changes,
-* to commit changes to make your deployment easier, merging branches or adding new `submodules
-  <https://git-scm.com/book/en/v2/Git-Tools-Submodules>`_ for example.
 
-Submit your project
+      - Access your GitHub login and email.
-===================
+      - Create a new repository, in case you start from scratch.
-
+      - Access existing repositories, including organization ones, in case you start from an
-Choose if you want to start from scratch by creating a new repository, or if you want to use an
         existing repository.
+      - Create a webhook to notify you each time changes are pushed.
+      - Commit changes for easier deployment.
 
-Then, choose a name or select the repository you want to use.
+#. Fill in the :guilabel:`Deploy your platform` form and click :guilabel:`Deploy`:
 
-Choose the Odoo version you want to use. If you plan to import an existing database or an existing
+   - :guilabel:`Github repository`: to create a new repository, choose :guilabel:`New repository`
-set of applications, you might need to choose the according version. If you start from scratch, use
+     and enter a name; to use an existing one, choose :guilabel:`Existing repository` and select it.
-the latest version.
+   - :guilabel:`Odoo Version`: select the major version of Odoo you want to use.
 
-Enter your *subscription code*. This is also called *subscription referral*, *contract number* or
+     .. tip::
+        - Use the latest major version of Odoo version when creating a new repository. If you are
+          planning to import an existing database or applications, it might be required that their
+          versions match.
+        - If you are starting on Odoo Online and plan to migrate to Odoo.sh later, create your
+          database using `odoo.com/start-lts <https://www.odoo.com/start-lts>`_ to ensure
+          compatibility, as minor versions are not supported by Odoo.sh.
+
+   - :guilabel:`Subscription Code`: enter your Odoo Enterprise subscription code that includes
+     Odoo.sh. It is also sometimes called the *subscription referral*, *contract number*, or
      *activation code*.
 
-It should be the code of your Enterprise subscription that includes Odoo.sh.
+      .. tip::
+         Partners can use their partnership codes to initiate a trial (trial builds are limited to 1
+         GB storage and two staging). If a client proceeds to start a project, they must subscribe
+         to an Odoo Enterprise plan that includes Odoo.sh hosting and use their subscription code.
 
-Partners can use their partnership codes to start a trial. Should their clients start a project,
+   - :guilabel:`Hosting location`: select the region where your platform will be hosted.
-they ought to get an Enterprise subscription including Odoo.sh and use its subscription code. The
-partner will get 50% of the amount back as commission. Contact your sales representative or account
-manager in order to get it.
-
-When submitting the form, if you are notified your subscription is not valid, it either means:
-
-* it is not an existing subscription,
-* it is not a partnership subscription,
-* it is an enterprise subscription, but which does not include Odoo.sh,
-* it is neither a partnership subscription or an enterprise subscription (e.g. an online
-  subscription).
-
-In case of doubt with your subscription, please contact the `Odoo support
-<https://www.odoo.com/help>`_.
 
    .. image:: create/deploy-form.png
-   :align: center
+      :alt: The Deploy your platform form
 
-You're done !
+.. _odoo-sh/create/import:
-=============
 
-You can start using Odoo.sh. Your first build is about to be created. You will soon be able to
+Import a database
-connect to your first database.
+=================
 
-.. image:: create/deploy-done.png
+Once your platform is deployed, you can import a database into your Odoo.sh project, provided it
-   :align: center
+uses a :doc:`supported version <../../supported_versions>` of Odoo.
 
-.. _odoo_sh_import_your_database:
+.. note::
+   Due to `Odoo's backup policy <https://www.odoo.com/cloud-sla>`_, the import process requires
+   **four times** the size of your database dump in available storage. For example, a 10 GB dump
+   file will require at least 40 GB of available space. We recommend allocating **more than four
+   times×** the dump size temporarily, then reducing storage after the import is complete.
 
-Import your database
+   If your project is a trial created with a partnership code, you can only import database dumps up
-====================
+   to **1 GB** in size.
 
-You can import your database in your Odoo.sh project as long as it is in a :doc:`supported version
+Push modules in production
-</administration/supported_versions>` of Odoo.
+--------------------------
 
-Push your modules in production
+If you are using community or custom modules, add them to a branch in your GitHub repository.
--------------------------------
 
-If you use community or custom modules, add them in a branch in your Github repository.
+.. note::
-Databases hosted on the Odoo.com online platform do not have any custom modules.
+   Databases hosted on Odoo Online do not support custom modules.
-Users of these databases can therefore skip this step.
 
-You can structure your modules as you wish, Odoo.sh will automatically detect the folders containing
+Odoo.sh automatically detects folders containing Odoo modules. You can organize them however you
-Odoo addons. For instance, you can put all your modules folder in the root directory of your
+prefer. For example, you can place them directly in the root directory of your repository or group
-repository, or group the modules in folders by categories that you define (accounting, project,
+them by category (e.g., `accounting`, `project`, etc.).
-...).
 
-For community modules available in public Git repositories,
+For publicly available community modules, you may also consider using :doc:`submodules
-you can also consider to add them using :ref:`Submodules <odoosh-advanced-submodules>`.
+<../advanced/submodules>`.
-
-Then, either :ref:`make this branch the production branch <odoosh-gettingstarted-branches-stages>`,
-or :ref:`merge it into your production branch <odoosh-gettingstarted-branches-mergingbranches>`.
 
 Download a backup
 -----------------
 
-On-premise databases
+.. tabs::
-~~~~~~~~~~~~~~~~~~~~
 
-Access the URL :file:`/web/database/manager` of your on-premise database and download a backup.
+   .. group-tab:: On-premise
 
-.. Warning::
+      Go to `/web/database/manager` on your on-premise Odoo instance and click :icon:`fa-floppy-o`
+      :guilabel:`Backup`.
 
-  If you cannot access the database manager, it may have been disabled by your system administrator.
+      .. image:: create/on-premise-manager.png
-  See the :ref:`database manager security documentation <db_manager_security>`.
+         :alt: The on-premise web manager interface
 
-You will need the master password of your database server. If you do not have it, contact your
+      Select :guilabel:`zip (includes filestore)` as the :guilabel:`Backup Format`.
-system administrator.
 
-.. image:: create/create-import-onpremise-backup.png
+      .. image:: create/on-premise-backup.png
-   :align: center
+         :alt: Downloading an on-premise database backup
 
-Choose a zip including the filestore as the backup format.
+      .. note::
+         - You will need the :guilabel:`Master Password` of your Odoo server. If you do not have it,
+           contact your system administrator.
+         - If you cannot access the database manager, it may have been disabled by your system
+           administrator. Refer to the :ref:`database manager security documentation
+           <db_manager_security>`.
 
-.. image:: create/create-import-onpremise-backup-dialog.png
+   .. group-tab:: Odoo Online
-  :align: center
 
-Odoo Online databases
+      Log in to your portal account and navigate to the `My Databases page
-~~~~~~~~~~~~~~~~~~~~~
+      <https://www.odoo.com/my/databases>`_, and download a backup by clicking the :icon:`fa-gear`
+      (:guilabel:`gear`) icon, then :icon:`fa-cloud-download` :guilabel:`Download`.
 
-`Access your databases manager <https://accounts.odoo.com/my/databases/manage>`_ and download a
+      .. image:: create/odoo-online-backup.png
-backup of your database.
+         :alt: Downloading an Odoo Online database backup
 
-.. image:: create/create-import-online-backup.png
+      .. warning::
-   :align: center
+         Only major versions of Odoo are compatible with Odoo.sh.
-
-.. Warning::
-
-  Online versions (e.g. *saas-**) are not supported on Odoo.sh.
 
 Upload the backup
 -----------------
 
-Then, in your Odoo.sh project, in the backups tab of your production branch, import the backup you
+In your Odoo.sh project, navigate to the :guilabel:`Backups` tab of your :guilabel:`Production`
-just downloaded.
+branch, and click :guilabel:`Import Database` to upload the backup you previously downloaded.
 
-.. image:: create/create-import-production.png
+.. image:: create/import-database.png
-   :align: center
+   :alt: Importing a database backup on Odoo.sh
 
-Once the backup imported, you can access the database using the *Connect* button in the history of
+Once the import is complete, you can access the database using the :guilabel:`Connect` button in the
-the branch.
+branch's :guilabel:`History` tab.
 
-.. image:: create/create-import-production-done.png
+.. important::
-   :align: center
+   Importing a backup **overwrites all data** currently in the branch. Consider downloading a manual
+   backup beforehand if you want to preserve the existing data.
 
-Check your outgoing email servers
+Check outgoing email servers
----------------------------------
-
-There is a default mail server provided with Odoo.sh.
-To use it, there must be no enabled outgoing mail server configured in your database in
-:menuselection:`Settings --> Technical --> Outgoing Mail Servers` (:ref:`Developer mode
-<developer-mode>` must be activated).
-
-After the import of your database, all outgoing email servers are disabled so you use the Odoo.sh
-email server provided by default.
-
-.. warning::
-   Port 25 is (and will stay) closed. If you want to connect to an external SMTP server, you should
-   use ports 465 and 587.
-
-Check your scheduled actions
 ----------------------------
 
-All scheduled actions are disabled after the import.
+Odoo.sh provides a default email server. To use it, ensure that **no outgoing mail server is
+enabled** in your database by enabling :ref:`developer mode <developer-mode>` and navigating to
+:menuselection:`Settings --> Technical --> Email: Outgoing Mail Servers`
 
-This is to prevent your newly imported database to perform actions that could impact your running
+After importing your database, all configured outgoing mail servers are **disabled**, and the
-production, such as sending the mails remaining in the queue, processing mass mailings, or
+default Odoo.sh server is used.
-third-party services synchronization (Calendars, files hosting, ...).
 
-If you plan to make the imported database your production, enable the scheduled actions you need.
+.. warning::
-You can check what is enabled in the database of origin and enable the same actions in the imported
+   Port **25** is and will remain closed. If connecting to an external SMTP server, use port **465**
-database. Scheduled actions are located under :menuselection:`Settings --> Technical --> Automation
+   or **587**.
---> Scheduled Actions`.
 
-Register your subscription
+Check scheduled actions
---------------------------
+-----------------------
 
-Your subscription is unlinked after the import.
+Scheduled actions are **disabled by default** after importing your database. This prevents your
+newly imported database from performing potentially disruptive operations such as:
 
-The imported database is considered a duplicate by default and the enterprise subscription is
+- sending queued emails,
-therefore removed, as you can only have one database linked per subscription.
+- triggering mass mailings, or
+- syncing with third-party services (e.g., calendars, cloud storage).
 
-If you plan to make it your production, unlink your former database from the subscription, and
+If you intend to use this imported database in production, **re-enable** only the scheduled actions
-register the newly imported database. Read the :doc:`database registration documentation
+you need by enabling :ref:`developer mode <developer-mode>` and going to :menuselection:`Settings
-<../../on_premise>` for instructions.
+--> Technical --> Automation: Scheduled Actions`.
+
+Register the subscription
+-------------------------
+
+After import, the database is considered a **duplicate** and will be unlinked from your enterprise
+subscription.
+
+.. note::
+   You are allowed only one active database per subscription.
+
+If you intend to make the imported database your production environment:
+
+#. Unlink your previous database from the subscription.
+#. Register the new one.
+
+Refer to the :doc:`database registration documentation <../../on_premise>` for step-by-step
+instructions.

content/administration/odoo_sh/getting_started/online-editor.rst

@@ -16,7 +16,7 @@ It also gives you the possibility to open terminals, Python consoles, Odoo Shell
    :align: center
 
 You can access the editor of a build through
-:ref:`the branches tabs <odoosh-gettingstarted-branches-tabs>`,
+:ref:`the branches tabs <odoo-sh/branches/tabs>`,
 :ref:`the builds dropdown menu <odoosh-gettingstarted-builds-dropdown-menu>`
 or by adding */odoo-sh/editor* to your build domain name
 (e.g. *https://odoo-addons-master-1.dev.odoo.com/odoo-sh/editor*).
@@ -139,7 +139,7 @@ In this last command,
    In other words, this means you can have multiple builds on the same branch, but on different revisions.
 
 Once your changes are pushed,
-according to your :ref:`branch push behavior <odoosh-gettingstarted-branches-tabs-settings>`,
+according to your :ref:`branch push behavior <odoo-sh/branches/tabs/settings>`,
 a new build may be created. You can continue to work in the editor you pushed from,
 as it will have the same revision as the new build that was created, but always make sure to be
 in an editor of a build using the latest revision of your branch.

content/administration/odoo_sh/getting_started/settings.rst

@@ -241,7 +241,7 @@ Custom domains
 ==============
 
 To configure additional domains please refer to the corresponding branch's :ref:`settings tab
-<odoosh-gettingstarted-branches-tabs-settings>`.
+<odoo-sh/branches/tabs/settings>`.
 
 .. _odoosh-gettingstarted-settings-submodules:
 

content/administration/odoo_sh/overview.rst

@@ -1,10 +0,0 @@
-:nosearch:
-
-========
-Overview
-========
-
-.. toctree::
-   :titlesonly:
-
-   overview/introduction

content/administration/odoo_sh/overview/introduction.rst

@@ -1,10 +0,0 @@
-=======================
-Introduction to Odoo.sh
-=======================
-
-.. youtube:: QuNsa9n9PMg
-    :align: right
-    :width: 700
-    :height: 394
-
-The documentation will help you go live with your Odoo.sh project in no time.

content/applications/general/email_communication/faq.rst

@@ -319,7 +319,7 @@ Email is not received
 
       .. seealso::
          For more information on logs and how to access them via the Odoo.sh dashboard, refer to the
-         :ref:`Odoo.sh logs documentation <odoosh/logs>`.
+         :ref:`Odoo.sh logs documentation <odoo-sh/branches/tabs/logs>`.
 
          For more information on accessing logs via the command line, refer to the :ref:`developer
          logging documentation <reference/cmdline/server/logging>`.

content/applications/general/iot/iot_advanced/updating_iot.rst

@@ -80,8 +80,8 @@ are not functioning properly with the IoT system, proceed as follows:
 
 .. important::
    If you have an :doc:`on-premise </administration/on_premise>` or :doc:`Odoo.sh
-   </administration/odoo_sh/overview/introduction>` database, the configured server must be
+   </administration/odoo_sh>` database, the configured server must be up-to-date to ensure the
-   up-to-date to ensure the handlers' code includes the latest fixes and patches.
+   handlers' code includes the latest fixes and patches.
 
 .. note::
    A handler update is also performed automatically every time the IoT system is restarted unless

content/applications/websites/website/configuration/domain_names.rst

@@ -365,7 +365,7 @@ Map a domain name to an Odoo database
          :alt: Mapping a domain name to an Odoo.sh branch
 
       .. seealso::
-         :ref:`Odoo.sh branches: settings tab <odoosh-gettingstarted-branches-tabs-settings>`
+         :ref:`Odoo.sh branches: settings tab <odoo-sh/branches/tabs/settings>`
 
 .. _domain-name/ssl:
 

content/developer/howtos/website_themes/going_live.rst

@@ -48,7 +48,7 @@ Go to :guilabel:`Apps` and click on :guilabel:`Update Apps List` in the menu. Se
 in the list and install it.
 
 .. seealso::
-   :doc:`Introduction to Odoo.sh <../../../administration/odoo_sh/overview/introduction>`
+   :doc:`Introduction to Odoo.sh <../../../administration/odoo_sh>`
 
 .. _website_themes/going_live/whats_next:
 

redirects/17.0.txt

@@ -1,3 +1,8 @@
+# administration/odoo_sh
+
+administration/odoo_sh/getting_started/first_module.rst administration/odoo_sh/first_module.rst
+administration/odoo_sh/overview/introduction.rst administration/odoo_sh.rst
+
 # developer/reference
 
 developer/reference/backend/views.rst developer/reference/user_interface/view_records.rst