diff --git a/docs/development/README.md b/docs/development/README.md index 154e2f3a0ec..57d588d1419 100644 --- a/docs/development/README.md +++ b/docs/development/README.md @@ -107,20 +107,19 @@ This code of conduct is adapted from the [Contributor Covenant](http://contribut -## OpenProject Contributor License Agreement (CLA) +## OpenProject Contributor License Agreement (CLA) -If you want to contribute to OpenProject, please make sure to accept our Contributor License Agreement first. The contributor license agreement documents the rights granted by contributors to OpenProject. +If you want to contribute to OpenProject, please make sure to accept our Contributor License Agreement first. The contributor license agreement documents the rights granted by contributors to OpenProject. [Read and accept the Contributor License Agreement here.](http://openproject.org/contributor-license-agreement/) # Additional resources -* [Development environment for Ubuntu 16.04.](development-environment-ubuntu) +* [Development environment for Ubuntu 18.04](development-environment-ubuntu) * [Development environment for Mac OS X](development-environment-osx) * [Developing Plugins](create-openproject-plugin) * [Running Tests](running-tests) * [API Documentation](/api/) * [Report a Bug](report-a-bug) - diff --git a/docs/development/development-environment-osx/README.md b/docs/development/development-environment-osx/README.md index e9b868c6a44..94112eaa262 100644 --- a/docs/development/development-environment-osx/README.md +++ b/docs/development/development-environment-osx/README.md @@ -2,7 +2,7 @@ To develop OpenProject a setup similar to that for using OpenProject in production is needed. -This guide assumes that you have a Mac OS Xinstallation installation with administrative rights. +This guide assumes that you have a Mac OS Xinstallation installation with administrative rights. OpenProject will be installed with a PostgreSQL database. **Please note**: This guide is NOT suitable for a production setup, but only for developing with it! @@ -23,7 +23,7 @@ rbenv is a ruby version manager that lets you quickly switch between ruby versio ruby-build is an addon to rbenv that installs ruby versions. ```bash -# Install +# Install $ brew install rbenv ruby-build # Initialize rbenv $ rbenv init @@ -32,7 +32,7 @@ $ rbenv init **Installing ruby-2.6** With both installed, we can now install the actual ruby version 2.6. You can check available ruby versions with `rbenv install --list`. -At the time of this writing, the latest stable version is `2.6.1`, which we also require. +At the time of this writing, the latest stable version is `2.6.5`, which we also require. 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. @@ -96,11 +96,12 @@ $ nodenv init **Install latest LTS node version** You can find the latest LTS version here: https://nodejs.org/en/download/ -Currently, this is v12.13.0. Install and activate it with: + +At the time of writing this is v12.16.1. Install and activate it with: ```bash -nodenv install 12.13.0 -nodenv global 12.13.0 +nodenv install 12.16.1 +nodenv global 12.16.1 ``` ## Verify your installation @@ -115,7 +116,7 @@ $ bundler --version Bundler version 2.0.2 $ npm --version -12.13.0 +12.16.1 ``` # Install OpenProject diff --git a/docs/development/development-environment-ubuntu/README.md b/docs/development/development-environment-ubuntu/README.md index 29dc870cb7e..42854c6bdd7 100644 --- a/docs/development/development-environment-ubuntu/README.md +++ b/docs/development/development-environment-ubuntu/README.md @@ -5,7 +5,7 @@ To develop OpenProject a setup similar to that for using OpenProject in producti This guide assumes that you have a Ubuntu 18.04 installation with administrative rights. This guide will work analogous with all other distributions, but may require slight changes in the required packages. _Please, help us to extend this guide with information on other distributions should there be required changes._ -OpenProject will be installed with a PostgreSQL database. +OpenProject will be installed with a PostgreSQL database. **Please note**: This guide is NOT suitable for a production setup, but only for developing with it! @@ -32,7 +32,7 @@ ruby-build is an addon to rbenv that installs ruby versions. ```bash # Install rbenv locally for the dev user git clone https://github.com/rbenv/rbenv.git ~/.rbenv -# Optional: Compile bash extensions +# Optional: Compile bash extensions cd ~/.rbenv && src/configure && make -C src # Add rbenv to the shell's $PATH. echo 'export PATH="$HOME/.rbenv/bin:$PATH"' >> ~/.bashrc @@ -134,12 +134,13 @@ git clone https://github.com/nodenv/node-build.git $(nodenv root)/plugins/node-b **Install latest LTS node version** You can find the latest LTS version here: https://nodejs.org/en/download/ -Currently, this is v12.13.0 Install and activate it with: + +At the time of writing this is v12.16.1 Install and activate it with: ```bash -nodenv install 12.13.0 -nodenv global 12.13.0 -nodenv rehash +nodenv install 12.16.1 +nodenv global 12.16.1 +nodenv rehash ``` ## Verify your installation @@ -154,7 +155,7 @@ bundler --version Bundler version 2.0.2 npm --version -6.12.0 +12.6.1 ``` # Install OpenProject