Skip to content

Commit

Permalink
Documentation/update ruby version docs (#16522)
Browse files Browse the repository at this point in the history
fix(docs): ruby version is required and declared in .ruby-version
  • Loading branch information
as-op authored Aug 26, 2024
1 parent ca3d97a commit caf4945
Show file tree
Hide file tree
Showing 3 changed files with 24 additions and 19 deletions.
12 changes: 5 additions & 7 deletions docs/development/development-environment-osx/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,16 +43,14 @@ $ rbenv init

#### Installing ruby

With both installed, we can now install the actual ruby version. You can check available ruby versions
with `rbenv install --list`.
At the time of this writing, the latest stable version is `3.3.4`, which we also require.
With both installed, we can now install the actual ruby version.
You can check available ruby versions with `rbenv install --list`.

We suggest you install the version we require in the [Gemfile](https://github.com/opf/openproject/blob/dev/Gemfile).
Search for the `ruby '~> X.Y.Z'` line
and install that version.
We suggest you install the version we require in [.ruby-version](https://github.com/opf/openproject/blob/dev/.ruby-version).
Read the first line e.g. `3.3.4` and install that version.

```shell
# Install the required version as read from the Gemfile
# Install the required version as read from the .ruby-version file
rbenv install 3.3.4
```

Expand Down
20 changes: 11 additions & 9 deletions docs/development/development-environment-ubuntu/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,9 +39,12 @@ sudo apt-get install git curl build-essential zlib1g-dev libyaml-dev libssl-dev
### Install Ruby

Use [rbenv](https://github.com/rbenv/rbenv) and [ruby-build](https://github.com/rbenv/ruby-build#readme) to install
Ruby. We always require the latest ruby versions, and you can check which version is required
by [checking the Gemfile](https://github.com/opf/openproject/blob/dev/Gemfile#L31) for the `ruby "~> X.Y"` statement. At
the time of writing, this version is "3.3.4"
Ruby.
You can check available ruby versions with `rbenv install --list`.
At the time of this writing, the latest stable version is `3.3.4`, which we also require.

We suggest you install the version we require in [.ruby-version](https://github.com/opf/openproject/blob/dev/.ruby-version).
Read the first line e.g. `3.3.4` and install that version.

#### Install rbenv and ruby-build

Expand Down Expand Up @@ -74,15 +77,14 @@ git clone https://github.com/rbenv/ruby-build.git ~/.rbenv/plugins/ruby-build

#### Installing ruby

With both installed, we can now install ruby. You can check available ruby versions with `rbenv install --list`.
At the time of this writing, the latest stable version is `3.3.4` which we also require.
With both installed, we can now install ruby.
You can check available ruby versions with `rbenv install --list`.

We suggest you install the version we require in the [Gemfile](https://github.com/opf/openproject/blob/dev/Gemfile).
Search for the `ruby '~> X.Y.Z'` line
and install that version.
We suggest you install the version we require in [.ruby-version](https://github.com/opf/openproject/blob/dev/.ruby-version).
Read the first line e.g. `3.3.4` and install that version.

```shell
# Install the required version as read from the Gemfile
# Install the required version as read from the .ruby-version file
rbenv install 3.3.4
```

Expand Down
11 changes: 8 additions & 3 deletions docs/installation-and-operations/installation/manual/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -96,9 +96,9 @@ Lastly, revert to the previous system user:

## Installation of Ruby

The are several possibilities to install Ruby on your machine. We will
use [rbenv](https://github.com/rbenv/rbenv). Please be aware that the actual installation of a specific Ruby version takes some
time to finish.
The are several possibilities to install Ruby on your machine.
We will use [rbenv](https://github.com/rbenv/rbenv).
Please be aware that the actual installation of a specific Ruby version takes some time to finish.

```shell
[root@host] su openproject --login
Expand All @@ -107,7 +107,12 @@ time to finish.
[openproject@host] echo 'eval "$(rbenv init -)"' >> ~/.profile
[openproject@host] source ~/.profile
[openproject@host] git clone https://github.com/sstephenson/ruby-build.git ~/.rbenv/plugins/ruby-build
```

We suggest you install the version we require in [.ruby-version](https://github.com/opf/openproject/blob/dev/.ruby-version).
Read the first line e.g. `3.3.4` and install that version.

```shell
[openproject@host] rbenv install 3.3.4
[openproject@host] rbenv rehash
[openproject@host] rbenv global 3.3.4
Expand Down

0 comments on commit caf4945

Please sign in to comment.