IntenseWebs/discourse
3
0
Fork 0
mirror of https://github.com/discourse/discourse.git synced 2025-02-25 18:55:32 -06:00
Code Issues Packages Projects Releases Wiki Activity

Update required Ruby version in documentation

Browse Source
This commit is contained in:
Gerhard Schlager 2018-11-09 16:00:11 +01:00
parent 9ddd40df13
commit 3e68539ef5
5 changed files with 10 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
README.md
View File

@ -30,7 +30,7 @@ To get your environment setup, follow the community setup guide for your operati
If you're familiar with how Rails works and are comfortable setting up your own environment, you can also try out the [**Discourse Advanced Developer Guide**](docs/DEVELOPER-ADVANCED.md), which is aimed primarily at Ubuntu and macOS environments. If you're familiar with how Rails works and are comfortable setting up your own environment, you can also try out the [**Discourse Advanced Developer Guide**](docs/DEVELOPER-ADVANCED.md), which is aimed primarily at Ubuntu and macOS environments.
Before you get started, ensure you have the following minimum versions: [Ruby 2.4+](http://www.ruby-lang.org/en/downloads/), [PostgreSQL 10+](http://www.postgresql.org/download/), [Redis 2.6+](http://redis.io/download). If you're having trouble, please see our [**TROUBLESHOOTING GUIDE**](docs/TROUBLESHOOTING.md) first! Before you get started, ensure you have the following minimum versions: [Ruby 2.5+](http://www.ruby-lang.org/en/downloads/), [PostgreSQL 10+](http://www.postgresql.org/download/), [Redis 2.6+](http://redis.io/download). If you're having trouble, please see our [**TROUBLESHOOTING GUIDE**](docs/TROUBLESHOOTING.md) first!
## Setting up Discourse ## Setting up Discourse

4
docs/DEVELOPER-ADVANCED.md
View File

@ -21,8 +21,8 @@ To get your Ubuntu 16.04 or 18.04 LTS install up and running to develop Discours
# exit the terminal and open it again to activate RVM # exit the terminal and open it again to activate RVM
rvm install 2.5.1 rvm install 2.5.3
rvm --default use 2.5.1 # If this error out check https://rvm.io/integration/gnome-terminal rvm --default use 2.5.3 # If this error out check https://rvm.io/integration/gnome-terminal
gem install bundler mailcatcher rake gem install bundler mailcatcher rake
# Download and install postgresql-10 from https://wiki.postgresql.org/wiki/Apt # Download and install postgresql-10 from https://wiki.postgresql.org/wiki/Apt

8
docs/DEVELOPMENT-OSX-NATIVE.md
View File

@ -4,7 +4,7 @@ These instructions assume you have read and understood the **[Discourse Advanced
OS X has become a popular platform for developing Ruby on Rails applications; as such, if you run OS X, you might find it more congenial to work on **[Discourse](http://discourse.org)** in your native environment. These instructions should get you there. OS X has become a popular platform for developing Ruby on Rails applications; as such, if you run OS X, you might find it more congenial to work on **[Discourse](http://discourse.org)** in your native environment. These instructions should get you there.
Obviously, if you **already** develop Ruby on OS X, a lot of this will be redundant, because you'll have already done it, or something like it. If that's the case, you may well be able to just install Ruby 2.4+ using RVM and get started! Discourse has enough dependencies, however (note: not a criticism!) that there's a good chance you'll find **something** else in this document that's useful for getting your Discourse development started! Obviously, if you **already** develop Ruby on OS X, a lot of this will be redundant, because you'll have already done it, or something like it. If that's the case, you may well be able to just install Ruby 2.5+ using RVM and get started! Discourse has enough dependencies, however (note: not a criticism!) that there's a good chance you'll find **something** else in this document that's useful for getting your Discourse development started!
## Quick Setup ## Quick Setup
@ -76,11 +76,11 @@ If you do already have RVM installed, this should make sure everything is up to
# If autolibs is set to 0-2, it will give an error for things that are missing, instead. # If autolibs is set to 0-2, it will give an error for things that are missing, instead.
rvm requirements rvm requirements
Either way, you'll now want to install Ruby 2.4+ (we recommend 2.4.4 or higher). Either way, you'll now want to install Ruby 2.5+ (we recommend 2.5.2 or higher).
# Now, install Ruby # Now, install Ruby
rvm install 2.4.4 rvm install 2.5.3
rvm use 2.4.4 --default # Careful with this if you're already developing Ruby rvm use 2.5.3 --default # Careful with this if you're already developing Ruby
## Git ## Git

2
docs/INSTALL.md
View File

@ -23,7 +23,7 @@ Hosting Rails applications is complicated. Even if you already have Postgres, Re
- [Postgres 10+](http://www.postgresql.org/download/) - [Postgres 10+](http://www.postgresql.org/download/)
- [Redis 2.6+](http://redis.io/download) - [Redis 2.6+](http://redis.io/download)
- [Ruby 2.4+](http://www.ruby-lang.org/en/downloads/) (we recommend 2.4.4 or higher) - [Ruby 2.5+](http://www.ruby-lang.org/en/downloads/) (we recommend 2.5.2 or higher)
## Security ## Security

4
docs/TROUBLESHOOTING.md
View File

@ -4,9 +4,9 @@ Are you having trouble setting up Discourse? Here are some basic things to check
reaching out to the community for help: reaching out to the community for help:
1. Are you running Ruby 2.4 or later? 1. Are you running Ruby 2.5 or later?
Discourse is designed for Ruby 2.4 or later. We recommend 2.4.4 p296 or later. You can check your version by typing Discourse is designed for Ruby 2.5 or later. We recommend 2.5.2 or later. You can check your version by typing
`ruby -v` and checking the response. `ruby -v` and checking the response.