Skip to content

Commit fc1ab90

Browse files
committed
[IMP] odoo sh: settings update
closes #15742 Signed-off-by: Audrey Vandromme (auva) <auva@odoo.com>
1 parent 3039236 commit fc1ab90

23 files changed

+254
-200
lines changed

content/administration/odoo_sh/advanced/submodules.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ and add them to your addons path automatically so you can install them in your d
2828
If you add private repositories as submodules in your branches,
2929
you need to configure a deploy key in your Odoo.sh project settings and in your repository settings.
3030
Otherwise Odoo.sh won't be allowed to download them.
31-
The procedure is detailed in the chapter :ref:`Settings > Submodules <odoosh-gettingstarted-settings-submodules>`.
31+
The procedure is detailed in the chapter :ref:`Settings > Submodules <odoo-sh/settings/submodules>`.
3232

3333
Adding a submodule
3434
==================
@@ -38,7 +38,7 @@ With Odoo.sh (simple)
3838

3939
.. warning::
4040
For now it is not possible to add **private** repositories with this method. You can nevertheless
41-
do so :ref:`with Git <odoosh-advanced-submodules-withgit>`.
41+
do so :ref:`with Git <odoo-sh/settings/submodules>`.
4242

4343
On Odoo.sh, in the branches view of your project, choose the branch in which you want to add a submodule.
4444

content/administration/odoo_sh/getting_started/branches.rst

Lines changed: 36 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
Branches
33
========
44

5-
The branches view provides an overview of the different branches in your repository.
5+
The :guilabel:`Branches` view provides an overview of the different branches in your repository.
66

77
.. _odoo-sh/branches/stages:
88

@@ -109,9 +109,14 @@ documentation <odoo-sh/module/add>` to view examples.
109109

110110
Staging databases are not automatically backed up. Nevertheless, you can restore a backup of the
111111
production database in a staging branch for testing purposes or to manually recover data that has
112-
been accidently deleted from the production database. It is possible to create manual backups of
112+
been accidentally deleted from the production database. It is possible to create manual backups of
113113
staging databases.
114114

115+
.. warning::
116+
Databases created for staging branches are intended to last up to three months. After that, they
117+
can be automatically blocked without prior notice. Only rebuilding the branch will allow you to
118+
use that specific branch again.
119+
115120
.. _odoo-sh/branches/stages/development:
116121

117122
Development
@@ -704,7 +709,9 @@ Clone
704709
The clone command is used to create a local copy of your Git repository.
705710

706711
.. example::
707-
:command:`git clone --recurse-submodules --branch development git@github.com:my-organization/my-repository.git`
712+
.. code-block:: shell
713+
714+
git clone --recurse-submodules --branch development git@github.com:my-organization/my-repository.git
708715
709716
- `--recurse-submodules` to download the submodules of your repository
710717
- `--branch main` to check out to a specific branch of the repository (e.g., `development`)
@@ -720,11 +727,13 @@ Fork
720727
The fork command is used to create a new branch based on the current one.
721728

722729
.. example::
723-
:command:`git checkout -b main-1 development && git push -u origin development-1`
730+
.. code-block:: shell
731+
732+
git checkout -b main-1 development && git push -u origin development-1
724733
725-
- :command:`git checkout -b main-1 main` a command to create a new branch (e.g., `development-1`)
734+
- `git checkout -b main-1 main` a command to create a new branch (e.g., `development-1`)
726735
based on the current branch (e.g., `development`)
727-
- :command:`git push -u origin development-1` a command to upload the new branch (e.g.,
736+
- `git push -u origin development-1` a command to upload the new branch (e.g.,
728737
`development-1`) to the remote repository
729738

730739
.. _odoo-sh/branches/shell-commands/merge:
@@ -735,11 +744,13 @@ Merge
735744
The merge command is used to combine changes on one branch into another branch.
736745

737746
.. example::
738-
:command:`git merge staging-1 && git push -u origin staging`
747+
.. code-block:: shell
739748
740-
- :command:`git merge staging-1` a command to merge the changes of the current branch into
749+
git merge staging-1 && git push -u origin staging
750+
751+
- `git merge staging-1` a command to merge the changes of the current branch into
741752
another branch (e.g., `staging-1`)
742-
- :command:`git push -u origin staging` a command to upload the merged changes to the remote
753+
- `git push -u origin staging` a command to upload the merged changes to the remote
743754
repository branch (e.g., `staging`)
744755

745756
.. _odoo-sh/branches/shell-commands/ssh:
@@ -764,13 +775,15 @@ To use the SSH command, it is necessary to set up an SSH key first. To do so:
764775
:alt: Adding an SSH key manually
765776

766777
.. example::
767-
:command:`ssh 25004381@my-user-my-repository-staging-25004381.dev.odoo.com`
778+
.. code-block:: shell
779+
780+
ssh 25004381@my-user-my-repository-staging-25004381.dev.odoo.com
768781
769782
- `25004381` the build ID
770783
- `my-user-my-repository-staging-25004381.dev.odoo.com` the domain used to connect to the build
771784

772-
Provided you have the necessary :ref:`access rights <odoosh-gettingstarted-settings-collaborators>`
773-
on the project, you will be granted SSH access to the build.
785+
Provided you have the necessary :ref:`access rights <odoo-sh/settings/collaborators>` on the
786+
project, you will be granted SSH access to the build.
774787

775788
.. note::
776789
Long-running SSH connections are not guaranteed. Idle connections can be disconnected to free up
@@ -788,13 +801,15 @@ submodule.
788801
:doc:`Submodules documentation <../advanced/submodules>`
789802

790803
.. example::
791-
:command:`git submodule add -b master <URL> <PATH> && git commit -a && git push -u origin staging`
804+
.. code-block:: shell
792805
793-
- :command:`git submodule add -b master <URL> <PATH>` a command to add a specific branch (e.g.,
806+
git submodule add -b master <URL> <PATH> && git commit -a && git push -u origin staging
807+
808+
- `git submodule add -b master <URL> <PATH>` a command to add a specific branch (e.g.,
794809
`master`) of a repository (`<URL>`) as a submodule under the specified path (`<PATH>`) in
795810
your current branch.
796-
- :command:`git commit -a` a command to commit all current changes
797-
- :command:`git push -u origin staging` a command to upload the changes of the current branch
811+
- `git commit -a` a command to commit all current changes
812+
- `git push -u origin staging` a command to upload the changes of the current branch
798813
(e.g., `staging`) to the remote repository.
799814

800815
.. _odoo-sh/branches/shell-commands/delete:
@@ -809,11 +824,13 @@ The delete command is used to delete a branch from your repository.
809824
are not automatically backed up, but can be manually. Development branches cannot be backed up.
810825

811826
.. example::
812-
:command:`git push origin :staging && git branch -D staging`
827+
.. code-block:: shell
828+
829+
git push origin :staging && git branch -D staging
813830
814-
- :command:`git push origin :staging` a command to delete a specific branch (e.g., `staging`) on
831+
- `git push origin :staging` a command to delete a specific branch (e.g., `staging`) on
815832
the remote repository
816-
- :command:`git branch -D staging` a command to delete the specific branch on your local copy of
833+
- `git branch -D staging` a command to delete the specific branch on your local copy of
817834
the repository
818835

819836
.. warning::

content/administration/odoo_sh/getting_started/builds.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ Overview
1616
.. image:: builds/builds-overview.png
1717
:alt: Overiew of the builds
1818

19-
In the :guilabel:`Builds` overview, a row represents a branch, and a cell within that row represents
19+
In the :guilabel:`Builds` view, a row represents a branch, and a cell within that row represents
2020
a build of that branch.
2121

2222
Most builds are created after pushes to your GitHub repository branches. They can also be created

0 commit comments

Comments
 (0)