Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Added troubleshooting instructions for environment set up #6833

Merged
merged 6 commits into from
Apr 12, 2024
Merged

Added troubleshooting instructions for environment set up #6833

Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
f6afaf0
Added troubleshooting instructions for environment set up
GumpacG Apr 2, 2024
8a0907d
Merge branch 'opensearch-project:main' into integ-6800-troubleshooting
GumpacG Apr 2, 2024
0f5ed80
Update CONTRIBUTING.md
GumpacG Apr 12, 2024
18d9abc
Update CONTRIBUTING.md
GumpacG Apr 12, 2024
211e92e
Update CONTRIBUTING.md
GumpacG Apr 12, 2024
1048f19
Update CONTRIBUTING.md
GumpacG Apr 12, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down
Loading