From 758bb171dc4c019686d0e745bfbb96662f253296 Mon Sep 17 00:00:00 2001 From: Guian Gumpac Date: Fri, 12 Apr 2024 21:12:54 +0000 Subject: [PATCH] Added troubleshooting instructions for environment set up (#6833) * Added troubleshooting instructions for environment set up Signed-off-by: Guian Gumpac * Update CONTRIBUTING.md Co-authored-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> Signed-off-by: Guian Gumpac * Update CONTRIBUTING.md Co-authored-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> Signed-off-by: Guian Gumpac * Update CONTRIBUTING.md Co-authored-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> Signed-off-by: Guian Gumpac * Update CONTRIBUTING.md Co-authored-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> Signed-off-by: Guian Gumpac --------- Signed-off-by: Guian Gumpac Co-authored-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> --- CONTRIBUTING.md | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 7697ce7008..f9f1a23f51 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -98,6 +98,15 @@ Follow these steps to set up your local copy of the repository: bundle install ``` +#### Troubleshooting + +If you encounter an error while trying to build the documentation website, find the error in the following troubleshooting list: + +- When running `rvm install 3.2` if you receive a `Error running '__rvm_make -j10'`, resolve this by running `rvm install 3.2.0 -C --with-openssl-dir=/opt/homebrew/opt/openssl@3.2` instead of `rvm install 3.2`. +- If receive a `bundle install`: `An error occurred while installing posix-spawn (0.3.15), and Bundler cannot continue.` error when trying to run `bundle install`, resolve this by running `gem install posix-spawn -v 0.3.15 -- --with-cflags=\"-Wno-incompatible-function-pointer-types\"`. Then, run `bundle install`. + + + #### Making, viewing, and submitting changes Here's how to build the website, make changes, and view them locally: