Added troubleshooting instructions for environment set up (#6833)

* Added troubleshooting instructions for environment set up Signed-off-by: Guian Gumpac <[email protected]> * Update CONTRIBUTING.md Co-authored-by: Naarcha-AWS <[email protected]> Signed-off-by: Guian Gumpac <[email protected]> * Update CONTRIBUTING.md Co-authored-by: Naarcha-AWS <[email protected]> Signed-off-by: Guian Gumpac <[email protected]> * Update CONTRIBUTING.md Co-authored-by: Naarcha-AWS <[email protected]> Signed-off-by: Guian Gumpac <[email protected]> * Update CONTRIBUTING.md Co-authored-by: Naarcha-AWS <[email protected]> Signed-off-by: Guian Gumpac <[email protected]> --------- Signed-off-by: Guian Gumpac <[email protected]> Co-authored-by: Naarcha-AWS <[email protected]>
opensearch-project · Apr 12, 2024 · 758bb17 · 758bb17
1 parent 5b7f574
commit 758bb17
Showing 1 changed file with 9 additions and 0 deletions.
diff --git 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/[email protected]` 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: