From bcbeb66c98fdf1bcef4bb337af53edfbd9e8c510 Mon Sep 17 00:00:00 2001 From: Christina Date: Fri, 12 Feb 2021 10:45:34 -0600 Subject: [PATCH] Update Ruby Section and Add Additional Error (#12669) Adding additional information to the Ruby section to help contributors who are not used to Ruby. Also explicitly stating that the project must be cloned and forked before using rbenv install $(cat .ruby-version) Also adding a common error Nick and I encountered with a solution. --- docs/installation/mac.md | 19 +++++++++++++++---- 1 file changed, 15 insertions(+), 4 deletions(-) diff --git a/docs/installation/mac.md b/docs/installation/mac.md index a2c835f4a..19f0ddb33 100644 --- a/docs/installation/mac.md +++ b/docs/installation/mac.md @@ -8,14 +8,18 @@ title: macOS ### Ruby -1. If you don't already have a Ruby version manager, we highly recommend - [rbenv](https://github.com/rbenv/rbenv). Please follow their - [installation guide](https://github.com/rbenv/rbenv#installation). +1. **Note:** MacOS ships with a version of Ruby, needed for various operating systems. + To avoid causing an issue with your operating system you should use a version manager for Ruby. + + If you don't already have a Ruby version manager, we highly recommend [rbenv](https://github.com/rbenv/rbenv). This will allow you to have different versions running on a per project basis. The MacOS system version of Ruby will stay intact while giving you the ability to use the version needed for this Forem project. +Please follow their [installation guide](https://github.com/rbenv/rbenv#installation). 2. With the Ruby version manager, install the Ruby version listed on our badge. (i.e. with rbenv: `rbenv install $(cat .ruby-version)`) + + **Note:** The repository must be forked and cloned before running the `rbenv install $(cat .ruby-version)` command. + ### Yarn - Please refer to their [installation guide](https://yarnpkg.com/en/docs/install). ### PostgreSQL @@ -236,6 +240,13 @@ your local Elasticsearch installation, for example: ### Possible error messages +**Error:** +`rbenv install hangs at ruby-build: using readline from homebrew` + +**_Solution:_** +[Stackoverflow answer](https://stackoverflow.com/questions/63599818/rbenv-install-hangs-at-ruby-build-using-readline-from-homebrew) +`RUBY_CONFIGURE_OPTS=--with-readline-dir="$(brew --prefix readline)" rbenv install 2.0.0` + **Error:** `__NSPlaceholderDate initialize] may have been in progress in another thread when fork() was called`