Skip to content

Commit

Permalink
Update clone method section in clone.rst
Browse files Browse the repository at this point in the history
- Move ssh method above https and mention that ssh method
is highly preferred.

Refs NOAA-EMC#1272
  • Loading branch information
KateFriedman-NOAA committed Jan 31, 2023
1 parent a21c26e commit 75f1942
Showing 1 changed file with 7 additions and 5 deletions.
12 changes: 7 additions & 5 deletions docs/source/clone.rst
Original file line number Diff line number Diff line change
Expand Up @@ -39,11 +39,7 @@ Clone workflow and component repositories
Workflow
********

https method:

::

git clone https://github.com/NOAA-EMC/global-workflow.git
There are several ways to clone repositories from GitHub. Below we describe how to clone the global-workflow using either the ssh or https methods. **The ssh method is highly preferred and recommended.**

ssh method (using a password protected SSH key):

Expand All @@ -54,6 +50,12 @@ ssh method (using a password protected SSH key):
.. note::
When using ssh methods you need to make sure that your GitHub account is configured for the computer from which you are accessing the repository (See `this link <https://docs.github.com/en/authentication/connecting-to-github-with-ssh/adding-a-new-ssh-key-to-your-github-account>`_)

https method:

::

git clone https://github.com/NOAA-EMC/global-workflow.git

Check what you just cloned (by default you will have only the develop branch):

::
Expand Down

0 comments on commit 75f1942

Please sign in to comment.