NextERP/documentation
5
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

[IMP] contributing/documentation: suggest to clone with ssh

Browse Source 
GitHub requires users to "use token-based authentication for all
authenticated operations", for example `git push`. See
https://github.blog/2020-12-15-token-authentication-requirements-for-git-operations/

This commit suggests new contributors to clone the repository with SSH
so that the remote URL is automatically configured with the SSH
protocol.

task-3036845

closes odoo/documentation#3040

X-original-commit: dfb7801484
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
This commit is contained in:
Antoine Vandevenne (anv) 2022-11-25 12:30:55 +00:00
parent 001966ea5f
commit cd5a6305b4
1 changed files with 28 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

31
content/contributing/documentation.rst
View File

@ -159,24 +159,43 @@ the mean of a :abbr:`PR (Pull Request)` (:dfn:`proposal of content changes`) to
of the changes before updating the sources of the documentation. of the changes before updating the sources of the documentation.
Prior to submitting a modification, you need to make a copy of the sources and download that copy on Prior to submitting a modification, you need to make a copy of the sources and download that copy on
your machine. your machine. Git's CLI (:dfn:`command-line interface`) allows downloading the sources by passing an
URL to its :command:`git clone` command. You must choose the protocol of the URL depending on what
you want to do with the sources: choose HTTPS if you intend to only build the documentation locally;
choose SSH if you plan on proposing content changes.
#. Go to `github.com/odoo/documentation <https://github.com/odoo/documentation>`_ and click on the #. Go to `github.com/odoo/documentation <https://github.com/odoo/documentation>`_ and click on the
**Fork** button in the top right corner. **Fork** button in the top right corner. If work at Odoo, skip this step.
.. image:: documentation/fork-button.png .. image:: documentation/fork-button.png
#. Execute the following commands in a terminal: #. Execute the following commands in a terminal:
.. tabs::
.. tab:: Clone with HTTPS
.. code-block:: console .. code-block:: console
$ git clone https://github.com/odoo/documentation $ git clone https://github.com/<username>/documentation.git
$ cd documentation/ $ cd documentation/
Replace `<username>` with your GitHub username. If you work at Odoo, replace it with
`odoo`.
.. tab:: Clone with SSH
.. important:: .. important::
If you do not have edit rights on the repository owned by Odoo, replace "odoo" with your Make sure that you `registered your SSH key on GitHub
Github username in the URL of the command above. If you do have edit rights, it is not <https://docs.github.com/en/authentication/connecting-to-github-with-ssh>`_.
necessary to fork the repository.
.. code-block:: console
$ git clone git@github.com:<username>/documentation.git
$ cd documentation/
Replace `<username>` with your GitHub username. If you work at Odoo, replace it with
`odoo`.
#. In order to ease the collaboration between writers coming from many different systems and teams, #. In order to ease the collaboration between writers coming from many different systems and teams,
execute the following group of commands that correspond to your :abbr:`OS (Operating System)` in execute the following group of commands that correspond to your :abbr:`OS (Operating System)` in