Clone the repo #113
Clone the repo #113
Conversation
|
Anyone is welcome to have a look here, but I'm waiting to request review until the base is |
|
Inspired by this morning's meeting, I added a quick sentence to the forking docs that their fork will also be public: ac3bbc2 |
| - Do not change the "Full path" field when cloning. | ||
| You should retain the folder name `OpenScPCA-analysis`. |
There was a problem hiding this comment.
Do we need to tell people this? Why can't they change the name locally?
There was a problem hiding this comment.
I suppose it doesn't matter, just wanted to give some guidance about how they should interact with this step. Would you suggest telling them to choose their own journey here?
There was a problem hiding this comment.
I just wouldn't specify. The video doesn't show changing the default, I don't think, so no need to mention it.
| 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: |
There was a problem hiding this comment.
Do we want to mention anything about the difference between SSH and http here? If they have not set up SSH, they probably need to use the http version (This is what the clone from github.com will do by default)
There was a problem hiding this comment.
My sense is that things would just kind of work if they have signed into GitKraken with their github account, so I was trying to hide this "advanced" sort of information to avoid throwing too much information at them that isn't directly related to steps they need to take.
What level of detail are you proposing to add here?
There was a problem hiding this comment.
I don't think that is quite true. GitKraken only sets up https by default, I think. If you already have SSH keys, it will use them, and it can create and update SSH keys if you ask it to, but in the most basic setting it will only set up for http.
I would just recommend that they choose http unless they have set up SSH. Basically, if you know what you are doing you can choose ssh, but otherwise you probably want http.
There was a problem hiding this comment.
Ok, took a stab at it, let me know what you think!
Co-authored-by: Joshua Shapiro <[email protected]>
…s this was not entirely correct
docs/img/add-upstream-remote-3.png
Outdated
There was a problem hiding this comment.
just noting i replaced this with a smaller screenshot, it was too long before i think
|
|
||
| ## Adding images | ||
|
|
||
| All image files should be placed in `docs/img`. |
There was a problem hiding this comment.
Maybe add a comment about image sizes? Something like "Try to size images to ~2X the display size"? (Optimal to look good on high dpi displays without making them too big)
| @@ -19,7 +20,7 @@ Follow these steps to create your fork: | |||
|
|
|||
| 1. At the top right corner, click the "Fork" button: | |||
| (The numbers you see in this screenshot may differ from the numbers on the website - that's ok!) | |||
| {width="400"} <!-- No new line above, to keep tabbed in --> | |||
| {width="400"} <!-- No new line above, to keep tabbed in --> | |||
There was a problem hiding this comment.
Did you want to center these too? Or a different PR, maybe.
There was a problem hiding this comment.
Since you've approved this, I'll do it in a different PR
Co-authored-by: Joshua Shapiro <[email protected]>
Which issue does this address?
#12
Briefly describe the scope of the added docs file, including whether you link out to any external docs.
I've added docs for cloning the repository, and based on the discussion in #15, I also provided instructions for how to add the upstream remote that will allow them to stay in sync over time.
For cloning, I linked to a GitKraken video and provided some clarifying bullet points to guide them through parts of the video they may be uncertain about.
For the remote, I wrote those out directly and used screenshots to help explain.
Will you need additional visual aids for these docs?
No; I have already added images.
Any other comments for reviewers?
Note that this is stacked on #110.
I tried to provide some explanation about the terminology we're using - "upstream", "origin, and "remote" - without getting too into the weeds. IMO these terms are necessary "jargon" since it is inevitable contributors will encounter them while using git. Any feedback on this presentation would be great!
Author checklist
navsection inmkdocs.ymlReviewer checklist
Please refer to the docs style guide while reviewing this pull request.