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.

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

[DOC] Installing ruby for Apple silicon missing #8618

Merged
merged 12 commits into from
Nov 8, 2024

Conversation

brianf-aws
Copy link
Contributor

Add small lines for installing apple silicon, This blog post helped but I want to write it formally here to avoid any friction for future developers. I propose to change the installation step for ruby

```
curl -sSL https://get.rvm.io | bash -s stable
rvm install 3.2.4
ruby -v
```

to

For Non-Apple Silicon machines:

curl -sSL https://get.rvm.io | bash -s stable
rvm install 3.2.4
ruby -v

For Apple Silicon machines. Source: Installing Ruby on Apple Silicon by Emmanuel Bernard

### Assuming brew is installed
curl -sSL https://get.rvm.io | bash -s stable
rvm install 3.2.4 --with-openssl-dir=$(brew --prefix [email protected])
ruby -v
  • Request a change to existing documentation
  • Add new documentation
  • Report a technical problem with the documentation
  • Other

Currently the documentation for getting started as shown in the contributing doc does not show a option for instaling ruby on Apple silicon machines
*Version: all.

What other resources are available? Provide links to related issues, POCs, steps for testing, etc.

Copy link

Thank you for submitting your PR. The PR states are In progress (or Draft) -> Tech review -> Doc review -> Editorial review -> Merged.

Before you submit your PR for doc review, make sure the content is technically accurate. If you need help finding a tech reviewer, tag a maintainer.

When you're ready for doc review, tag the assignee of this PR. The doc reviewer may push edits to the PR directly or leave comments and editorial suggestions for you to address (let us know in a comment if you have a preference). The doc reviewer will arrange for an editorial review.

CONTRIBUTING.md Outdated Show resolved Hide resolved
CONTRIBUTING.md Outdated Show resolved Hide resolved
CONTRIBUTING.md Outdated Show resolved Hide resolved
brianf-aws and others added 3 commits October 24, 2024 14:17
Change header to bold for non-apple silicon.

Co-authored-by: Naarcha-AWS <[email protected]>
Signed-off-by: Brian Flores <[email protected]>
change header for bold for apple silicon

Co-authored-by: Naarcha-AWS <[email protected]>
Signed-off-by: Brian Flores <[email protected]>
This commit adds more information of where a user can look to see what openSSL versions they can use to install. this way we wont need to update both the SSL version and ruby version if it changes.

Signed-off-by: Brian Flores <[email protected]>
brianf-aws and others added 4 commits October 29, 2024 10:18
Signed-off-by: Brian Flores <[email protected]>
Signed-off-by: Brian Flores <[email protected]>
Signed-off-by: Brian Flores <[email protected]>
@Naarcha-AWS Naarcha-AWS added the 5 - Editorial review PR: Editorial review in progress label Nov 8, 2024
Copy link
Collaborator

@natebower natebower left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@Naarcha-AWS @brianf-aws Just a few changes. Thanks!

CONTRIBUTING.md Outdated Show resolved Hide resolved
CONTRIBUTING.md Outdated Show resolved Hide resolved
CONTRIBUTING.md Outdated Show resolved Hide resolved
@Naarcha-AWS Naarcha-AWS merged commit bcbf138 into opensearch-project:main Nov 8, 2024
5 checks passed
epugh pushed a commit to o19s/documentation-website that referenced this pull request Nov 23, 2024
)

* Adds documentation for installing ruby for apple silicon fixes opensearch-project#8614

Signed-off-by: Brian Flores <[email protected]>

* shrinked header size

Signed-off-by: Brian Flores <[email protected]>

* Update CONTRIBUTING.md

Change header to bold for non-apple silicon.

Co-authored-by: Naarcha-AWS <[email protected]>
Signed-off-by: Brian Flores <[email protected]>

* Update CONTRIBUTING.md

change header for bold for apple silicon

Co-authored-by: Naarcha-AWS <[email protected]>
Signed-off-by: Brian Flores <[email protected]>

* Added place holder for openSSL version for users choice

This commit adds more information of where a user can look to see what openSSL versions they can use to install. this way we wont need to update both the SSL version and ruby version if it changes.

Signed-off-by: Brian Flores <[email protected]>

* ruby -> Ruby

Signed-off-by: Brian Flores <[email protected]>

* Update CONTRIBUTING.md

Signed-off-by: Brian Flores <[email protected]>

* Fixed typo

Signed-off-by: Brian Flores <[email protected]>

* Move silicon command to new troubleshooting section.

Signed-off-by: Naarcha-AWS <[email protected]>

* Apply suggestions from code review

Co-authored-by: Nathan Bower <[email protected]>
Signed-off-by: Naarcha-AWS <[email protected]>

---------

Signed-off-by: Brian Flores <[email protected]>
Signed-off-by: Naarcha-AWS <[email protected]>
Co-authored-by: Naarcha-AWS <[email protected]>
Co-authored-by: Nathan Bower <[email protected]>
Signed-off-by: Eric Pugh <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
5 - Editorial review PR: Editorial review in progress
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants