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

Jump to bottom

chore(docs): Update ruby install instructions in environment setup readme #11714

Closed
wants to merge 4 commits into from
+10 −3
Closed

chore(docs): Update ruby install instructions in environment setup readme #11714

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
54b56a4
Update ruby install instructions with commands
MajorLift Oct 9, 2024
3c91471
Update docs/readme/environment.md
MajorLift Oct 17, 2024
7303d77
Revert "Update ruby install instructions with commands"
MajorLift Oct 18, 2024
385a936
Update ruby install instructions with example commands for rbenv
MajorLift Oct 18, 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
13 changes: 10 additions & 3 deletions docs/readme/environment.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,11 +19,18 @@ brew install watchman

### Ruby

MacOS ships with an old ruby version that is incompatible with this project
MacOS ships with an old ruby version that is incompatible with this project.

It is recommended to install a Ruby version manager such as [rbenv](https://github.com/rbenv/rbenv?tab=readme-ov-file#installation)
It is recommended to install a ruby version manager, and use it to install the ruby version defined in the file `.ruby-version`.

Install ruby version defined in the file `.ruby-version`
For example, the following commands will [install `rbenv`](https://github.com/rbenv/rbenv?tab=readme-ov-file#installation) and use it to [install the configured ruby version](https://github.com/rbenv/rbenv#installing-ruby-versions):

```bash
brew install rbenv
rbenv init
rbenv install
rbenv local # if installation is successful, this will print the installed ruby version.
```
Comment on lines +24 to +33
Copy link
Contributor Author

@MajorLift MajorLift Oct 18, 2024 •
edited
Loading

Choose a reason for hiding this comment

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

@joaoloureirop @legobeat Thanks for the feedback! I understand the need to avoid endorsing a specific version manager, but feel like the reservations around providing instructions...

it will require intervention every time our .ruby-version changes.
Down the road when intervention is needed (installing a new ruby version, rehashing, removing...), the official documentation is the best help they can get.

... might apply to any external package we don't manage but provide instructions for in our readmes.

I attempted a rewrite but I'm not sure how well it addresses your concerns. If either of you have suggestions around adding stronger disclaimer language or editing/removing the additions I'd be happy to apply them.

Copy link
Contributor

Choose a reason for hiding this comment

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

... might apply to any external package we don't manage but provide instructions for in our readmes.

Instructions should be provided in our readmes when the configuration differs from the default or when the official docs miss the installation/configuration guide.
Other than that, official docs should be the single source of truth.

the node version manager section is as vague as the ruby version manager section for the same reason.

Copy link
Contributor

Choose a reason for hiding this comment

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

What is the added value here that the official docs don't already provide?

Copy link
Contributor Author

@MajorLift MajorLift Oct 18, 2024 •
edited
Loading

Choose a reason for hiding this comment

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

Providing immediate, explicit, unambiguous instructions would hopefully serve as a better first line of defense against troubleshooting threads like these, some of them quite huge:

If our internal developers (myself included) have this much trouble with the current instructions for this step I don't think the situation will be much better for external contributors.

In the end I guess this comes down to the question of what's a higher priority for a readme: being correct or being helpful.


### Gems

Expand Down
Loading