Adjust cloning example to use SSH rather than HTTPS (#5802)

* Adjust cloning example to use SSH rather than HTTPS

* Add SSH example alongside HTTPS example when cloning DEV repo
This commit is contained in:
Julianna Tetreault 2020-02-06 10:53:12 -07:00 committed by GitHub
parent 01dc81afa9
commit c9d4dde19c
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23

View file

@ -89,10 +89,13 @@ To start elasticsearch as a daemonized process:
## Installing DEV
1. Fork DEV's repository, e.g. <https://github.com/thepracticaldev/dev.to/fork>
1. Clone your forked repository, e.g.
`git clone https://github.com/<your-username>/dev.to.git`
1. Install bundler with `gem install bundler`
1. Set up your environment variables/secrets
2. Clone your forked repository in one of two ways:
- e.g. with HTTPS: `git clone https://github.com/<your-username>/dev.to.git`
- e.g. with SSH: `git clone git@github.com:<your-username>/dev.to.git`
3. Install bundler with `gem install bundler`
4. Set up your environment variables/secrets
- Take a look at `Envfile` to see all the `ENV` variables we use and the fake
default provided for any missing keys.
@ -107,7 +110,7 @@ To start elasticsearch as a daemonized process:
(i.e. with bash:
`cp config/sample_application.yml config/application.yml`). This is a
personal file that is ignored in git.
1. Obtain the development variable and apply the key you wish to
2. Obtain the development variable and apply the key you wish to
enter/replace. i.e.:
```shell
@ -122,7 +125,7 @@ To start elasticsearch as a daemonized process:
- You do not need "real" keys for basic development. Some features require
certain keys, so you may be able to add them as you go.
1. Run `bin/setup`
5. Run `bin/setup`
### Possible error messages