Skip to content

Commit

Permalink
add clone docs with images used to show how to add the remote
Browse files Browse the repository at this point in the history
  • Loading branch information
sjspielman committed Mar 6, 2024
1 parent 53f3f39 commit 67f6852
Show file tree
Hide file tree
Showing 4 changed files with 48 additions and 0 deletions.
Binary file added docs/img/add-upstream-remote-1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/img/add-upstream-remote-2.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/img/add-upstream-remote-3.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
48 changes: 48 additions & 0 deletions docs/technical-setup/clone-the-repo.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
# Clone the repository

After [forking the `OpenScPCA` repository](./fork-the-repo.md), you will need to _clone_ your forked repository to your computer.
Cloning provides you with a local copy of the repository to work with.
You will need to clone the repository to every computer (or remote server) you want to use to contribute to the project.

!!! note
You should clone your forked repository, _not_ `AlexsLemonade/OpenScPCA-analysis`.


## Clone your forked repository

Please follow the [instructions in this GitKraken video](https://help.gitkraken.com/gitkraken-client/open-clone-init/#cloning-an-existing-project) to clone your repository.

This video presents two approaches to cloning: `Clone with URL`, and Clone based on your integrated `GitHub.com` account.
Either approach is fine to take!

While watching these instructions, please bear in mind the following:

- Do not change the "Full path" field when cloning.
You should retain the folder name `OpenScPCA-analysis`.
- You can feel free to ignore all references to `LFS` ("large file storage") in this video.
This does not apply to `OpenScPCA-analysis`.

## Add the upstream repository as a remote

The next step is to link the upstream repository (`AlexsLemonade/OpenScPCA-analysis`) as a remote.
A _remote_ is a repository on GitHub.com that you are connected to.
For example, your forked repository on GitHub.com is your _origin remote_.

Adding the `AlexsLemonade` _upstream remote_ will allow you to interact with it from your computer which can you keep your fork in sync with the `OpenScPCA` project.
But, you will still be working in your fork when writing analysis code.

Follow these steps to add the upstream remote:

1. From your repository in GitKraken, hover over the `1/1` text on the left-hand side `Remote` menu.
This text will then turn into a plus-sign icon.
Click that icon.
![Click button to add the remote.](../img/add-upstream-remote-1.png){width="600"} <!-- No new line above, to keep tabbed in -->

2. The following screen will prompt you to add a remote.
Select `AlexsLemonade/OpenScPCA-analysis` from the dropdown menu, and click the button `Add remote`.
![Add the upstream remote.](../img/add-upstream-remote-2.png){width="400"} <!-- No new line above, to keep tabbed in -->

3. You should then see a second remote called `AlexsLemonade` on the left-hand side `Remote` menu.
The specific listed items under this remote that you see will look different from the screenshot below; this is expected.
As long as you see that `AlexsLemonade` is listed in the menu, you have successfully added the upstream remote.
![View the added remote.](../img/add-upstream-remote-3.png){width="325"} <!-- No new line above, to keep tabbed in. Width needs to be >=325 for proper spacing, it seems. -->

0 comments on commit 67f6852

Please sign in to comment.