Skip to content

[IMP] odoo.sh: complete update of the section #13954

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
wants to merge 1 commit into
base: 16.0
Choose a base branch
from
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions content/administration/hosting.rst
Original file line number Diff line number Diff line change
Expand Up @@ -39,8 +39,8 @@ To Odoo Online
To Odoo.sh
----------

Follow the instructions found in :ref:`the Import your database section
<odoo_sh_import_your_database>` of the Odoo.sh *Create your project* documentation.
Follow the instructions found in :ref:`the Import a database section <odoo-sh/create/import>` of the
Odoo.sh *Create a project* documentation.

Transferring an Odoo Online database
====================================
Expand Down Expand Up @@ -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
<odoo_sh_import_your_database>` of the Odoo.sh *Create your project* documentation.
#. Follow the instructions found in :ref:`the Import a database section <odoo-sh/create/import>` of
the Odoo.sh *Create a project* documentation.

Transferring an Odoo.sh database
================================
Expand Down
12 changes: 8 additions & 4 deletions content/administration/odoo_sh.rst
Original file line number Diff line number Diff line change
@@ -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, modules dependencies, continuous integration, and SSH access.

.. toctree::
:titlesonly:

odoo_sh/overview
odoo_sh/getting_started
odoo_sh/advanced
odoo_sh/getting_started
odoo_sh/first_module
odoo_sh/advanced
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down Expand Up @@ -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

Expand Down
53 changes: 48 additions & 5 deletions content/administration/odoo_sh/getting_started.rst
Original file line number Diff line number Diff line change
@@ -1,8 +1,52 @@
:nosearch:
:show-content:
:show-toc:

===========
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:
Expand All @@ -13,4 +57,3 @@ Get started
getting_started/status
getting_started/settings
getting_started/online-editor
getting_started/first_module
Loading