From c9d4dde19c1ff6b12e162b159d88415f5c1fde1b Mon Sep 17 00:00:00 2001 From: Julianna Tetreault <32834804+juliannatetreault@users.noreply.github.com> Date: Thu, 6 Feb 2020 10:53:12 -0700 Subject: [PATCH] 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 --- docs/installation/mac.md | 15 +++++++++------ 1 file changed, 9 insertions(+), 6 deletions(-) diff --git a/docs/installation/mac.md b/docs/installation/mac.md index e1cb069b7..3af0ce3f0 100644 --- a/docs/installation/mac.md +++ b/docs/installation/mac.md @@ -89,10 +89,13 @@ To start elasticsearch as a daemonized process: ## Installing DEV 1. Fork DEV's repository, e.g. -1. Clone your forked repository, e.g. - `git clone https://github.com//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//dev.to.git` + - e.g. with SSH: `git clone git@github.com:/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