diff --git a/contributing/documentation/introduction_guide.rst b/contributing/documentation/introduction_guide.rst index 4986aa594..cadac2cb3 100644 --- a/contributing/documentation/introduction_guide.rst +++ b/contributing/documentation/introduction_guide.rst @@ -11,7 +11,7 @@ documentation, whether you plan to make a minor content change or document an ap scratch. .. note:: - This tutorial only concern the `user documentation + This tutorial only concerns the `user documentation `_ of Odoo. The documentation for `developing in Odoo `_ in maintained alongside the source code of Odoo at `github.com/odoo/odoo `_. diff --git a/odoo_sh/getting_started/branches.rst b/odoo_sh/getting_started/branches.rst index bb72d7321..22b776f56 100644 --- a/odoo_sh/getting_started/branches.rst +++ b/odoo_sh/getting_started/branches.rst @@ -409,13 +409,39 @@ Uploads the changes you just added in the *master* branch on your remote reposit SSH --- -Connect to your builds using ssh. +Setup +~~~~~ +In order to use SSH, you have to set up your profile SSH public key (if it is not already done). +To do so, follow these steps: + +#. `Generate a new SSH key + `_ +#. `Copy the SSH key to your clipboard + `_ + (only apply the step 1) +#. Paste the copied content to your profile SSH keys and press "Add" + + .. image:: ./media/SSH-key-pasting.png + :align: center + +#. The key should appear below + + .. image:: ./media/SSH-key-appearing.png + :align: center + +Connection +~~~~~~~~~~ + +To connect to your builds using ssh use the following command in a terminal: .. code-block:: bash $ ssh @ -You can configure your ssh keys in your profile settings in the top-right menu when clicking on your username. +You will find a shortcut for this command into the SSH tab in the upper right corner. + +.. image:: ./media/SSH-panel.png + :align: center Provided you have the :ref:`correct access rights ` on the project, you'll be granted ssh access to the build. diff --git a/odoo_sh/getting_started/media/SSH-key-appearing.png b/odoo_sh/getting_started/media/SSH-key-appearing.png new file mode 100644 index 000000000..d56cd2b34 Binary files /dev/null and b/odoo_sh/getting_started/media/SSH-key-appearing.png differ diff --git a/odoo_sh/getting_started/media/SSH-key-pasting.png b/odoo_sh/getting_started/media/SSH-key-pasting.png new file mode 100644 index 000000000..b32d403c4 Binary files /dev/null and b/odoo_sh/getting_started/media/SSH-key-pasting.png differ diff --git a/odoo_sh/getting_started/media/SSH-panel.png b/odoo_sh/getting_started/media/SSH-panel.png new file mode 100644 index 000000000..de4ee214a Binary files /dev/null and b/odoo_sh/getting_started/media/SSH-panel.png differ