RFR: Section on cloning [v3]

[Kevin Rushforth]

On Thu, 12 Aug 2021 19:27:56 GMT, Jesper Wilhelmsson <jwilhelm at openjdk.org> wrote:

>> Added a section on cloning from GitHub, and an example of building on Mac. Also fixed two minor bugs that caused problems with syntax highlighting in Atom.
>
> Jesper Wilhelmsson has updated the pull request incrementally with one additional commit since the last revision:
> 
>   Updates after review

src/index.md line 999:

> 997: 
> 998:     $ git clone git at github.com:JesperIRL/jdk.git
> 999:     $ git remote add upstream git at github.com:openjdk/jdk.git

I typically recommend using https for the "fetch" URL and "ssh" (i.e., `git@`) for the push URL. More importantly, I don't recommend using ssh at all for the upstream repo, since it is read-only for developers. Here is my suggestion:


$ git clone https://github.com/JesperIRL/jdk.git
$ cd jdk
$ git remote set-url origin --push git at github.com:JesperIRL/jdk.git
$ git remote add upstream https://github.com/openjdk/jdk.git


If you prefer not to introduce the complexity of separate fetch and push URLs for `origin`, I at least would like to see an `https` URL for the upstream.

src/index.md line 1006:

> 1004: 
> 1005:     $ git checkout master
> 1006:     $ git checkout -b JDK-8272373

Minor: you could achieve the same thing with:


    $ git checkout -b JDK-8272373 master

-------------

PR: https://git.openjdk.java.net/guide/pull/59