Improve instructions for setting up the development environment #1181
Conversation
|
@jhp0tter is attempting to deploy a commit to the Mastodon Team on Vercel. A member of the Team first needs to authorize it. |
content/en/dev/setup.md
Outdated
| @@ -49,31 +49,41 @@ You can follow the [pre-requisites instructions from the production guide]({{<re | |||
| Run the following commands in the project directory: | |||
|
|
|||
| ```sh | |||
| bundle config set --local path vendor/bundle | |||
There was a problem hiding this comment.
is this necessary? i don't remember having to do this
There was a problem hiding this comment.
I just went through the dev setup instructions myself (hence the drive-by comments, sorry 😅) and didn't have to do this either.
There was a problem hiding this comment.
Running bundle install on Fedora 37 with the rubygem-bundler package gives:
@trwnh @nuztalgia Were you using RVM or rbenv? Perhaps that's why it wasn't necessary
There was a problem hiding this comment.
don't the prereqs say to use rbenv?
There was a problem hiding this comment.
@trwnh But the Vagrantfile uses RVM 🤔
Also, I think rbenv/RVM Bundler still installs the gems globally, it just doesn't require root since rbenv/RVM install Ruby per-user in the home directory. I was thinking that it's better to isolate the gems per-project, which AFAIK rbenv/RVM don't do by default, unless you use gemsets or something?
There was a problem hiding this comment.
unfortunately i do not know enough about the ruby ecosystem to have an informed opinion on this ^_^; but i guess it might be worth making a more general statement about how dependencies have to be installed in a non-root way, and then suggest using one of rbenv, rvm, or setting the bundle local path. or, based on some quick googling, i see that other people might recommend chruby for this? not really sure if any of these approaches are "best", or what the industry standards might be
|
This pull request has merge conflicts that must be resolved before it can be merged. |
|
@jhp0tter can you please rebase? |
|
@vmstan Does this work? |
|
This pull request has resolved merge conflicts and is ready for review. |
| {{</hint>}} | ||
|
|
||
| {{<hint style="info">}} | ||
| On some operating systems, such as Debian and Fedora, `yarn` has been renamed to `yarnpkg`. On these systems, run `yarnpkg` instead of `yarn`. |
There was a problem hiding this comment.
Fedora isn't covered by the prerequisites page, and on Debian yarn will come as part of installing Node.js via Nodesource.
| @@ -50,30 +50,37 @@ Run the following commands in the project directory: | |||
|
|
|||
| ```sh | |||
| bundle install | |||
| yarn install | |||
| yarn | |||
There was a problem hiding this comment.
Would prefer this stay as-is, unless there's a justification?
This is another attempt at #1024, because I think there is still some room for improvement after @trwnh's edits.
Changes: