From 8d8f30d600bbabb3a0e0e4a132c016024a6c87bd Mon Sep 17 00:00:00 2001 From: Raphael Miedl Date: Tue, 13 Nov 2018 00:11:58 +0100 Subject: [PATCH] Fix typos and wording in installation docs. (#1108) --- docs/installation/linux.md | 10 +++++----- docs/installation/mac-os.md | 6 +++--- docs/installation/windows.md | 6 +++--- 3 files changed, 11 insertions(+), 11 deletions(-) diff --git a/docs/installation/linux.md b/docs/installation/linux.md index bd47bd384..66d08b067 100644 --- a/docs/installation/linux.md +++ b/docs/installation/linux.md @@ -4,16 +4,16 @@ These prerequisites assume you're working on a Linux-based operating system but ### Ruby -1. If you don't already a Ruby version manager, we highly recommend [rbenv](https://github.com/rbenv/rbenv). Please follow their [installation guide](https://github.com/rbenv/rbenv#installation). -2. With the Ruby version manager, install Ruby verion listed on our badge. (ie with rbenv: `rbenv install 2.5.3`) +1. If you don't already have a Ruby version manager, we highly recommend [rbenv](https://github.com/rbenv/rbenv). Please follow their [installation guide](https://github.com/rbenv/rbenv#installation). +2. With the Ruby version manager, install the Ruby version listed on our badge. (ie with rbenv: `rbenv install 2.5.3`) -For very detailed rbenv installation directions on several distros, please vist [DigitalOcean's guide](https://www.digitalocean.com/community/tutorials/how-to-install-ruby-on-rails-with-rbenv-on-ubuntu-18-04). +For very detailed rbenv installation directions on several distros, please visit [DigitalOcean's guide](https://www.digitalocean.com/community/tutorials/how-to-install-ruby-on-rails-with-rbenv-on-ubuntu-18-04). ### Yarn There are two ways to install Yarn. -- Yarn's offical [installation guide](https://yarnpkg.com/en/docs/install#debian-stable). +- Yarn's official [installation guide](https://yarnpkg.com/en/docs/install#debian-stable). - [DigitalOcean's detailed tutorial](https://www.digitalocean.com/community/tutorials/how-to-install-node-js-on-ubuntu-18-04) describes how to install [Node version Manager](https://github.com/creationix/nvm). By installing NVM you can select a Node version (we recommend either LTS or current), the guide will also explain how to install NPM. This way you'll have Node, NPM, and then you can run `npm install -g yarn` to install Yarn. ### PostgreSQL @@ -34,7 +34,7 @@ There are more than one way to setup Postgres. For additional configuration, che 7. Set up your environment variables/secrets - Take a look at `Envfile`. This file lists all the `ENV` variables we use and provides a fake default for any missing keys. You'll need to get your own free [Algolia credentials](http://docs.dev.to/get-api-keys-dev-env/#algolia) to get your development environment running. -- This [guide](http://docs.dev.to/get-api-keys-dev-env/) will show you how to get free API keys for additional servies that may be required to run certain parts of the app. +- This [guide](http://docs.dev.to/get-api-keys-dev-env/) will show you how to get free API keys for additional services that may be required to run certain parts of the app. - For any key that you wish to enter/replace: 8. Create `config/application.yml` by copying from the provided template (ie. with bash: `cp config/sample_application.yml config/application.yml`). This is a personal file that is ignored in git. diff --git a/docs/installation/mac-os.md b/docs/installation/mac-os.md index d892085a9..5050febba 100644 --- a/docs/installation/mac-os.md +++ b/docs/installation/mac-os.md @@ -2,8 +2,8 @@ ### Ruby -1. If you don't already a Ruby version manager, we highly recommend [rbenv](https://github.com/rbenv/rbenv). Please follow their [installation guide](https://github.com/rbenv/rbenv#installation). -2. With the Ruby version manager, install Ruby version listed on our badge. (ie with rbenv: `rbenv install 2.5.3`) +1. If you don't already have a Ruby version manager, we highly recommend [rbenv](https://github.com/rbenv/rbenv). Please follow their [installation guide](https://github.com/rbenv/rbenv#installation). +2. With the Ruby version manager, install the Ruby version listed on our badge. (ie with rbenv: `rbenv install 2.5.3`) ### Yarn @@ -26,7 +26,7 @@ For additional configuration, [click here](/additional-postgres-setup) 7. Set up your environment variables/secrets - Take a look at `Envfile`. This file lists all the `ENV` variables we use and provides a fake default for any missing keys. You'll need to get your own free [Algolia credentials](http://docs.dev.to/get-api-keys-dev-env/#algolia) to get your development environment running. -- This [guide](http://docs.dev.to/get-api-keys-dev-env/) will show you how to get free API keys for additional servies that may be required to run certain parts of the app. +- This [guide](http://docs.dev.to/get-api-keys-dev-env/) will show you how to get free API keys for additional services that may be required to run certain parts of the app. - For any key that you wish to enter/replace: 8. Create `config/application.yml` by copying from the provided template (ie. with bash: `cp config/sample_application.yml config/application.yml`). This is a personal file that is ignored in git. diff --git a/docs/installation/windows.md b/docs/installation/windows.md index 4d1bdda93..50cc6ff2c 100644 --- a/docs/installation/windows.md +++ b/docs/installation/windows.md @@ -54,7 +54,7 @@ node -v npm -v ``` -If `npm -v` give Syntax error: word unexpected (expecting "in"), restart the terminal and try again. +If `npm -v` gives `Syntax error: word unexpected (expecting "in")`, restart the terminal and try again. And now, for rails itself: @@ -103,12 +103,12 @@ Pay attention to the username and password you setup during installation of Post 4. Install foreman gem with `gem install foreman` 5. Run `rbenv rehash` when foreman installation is done. 6. Install our ruby dependencies with `bundle install` - While installing, you might ran into an error due to pg gem require PostgreSQL libraries. If so, please run `sudo apt-get install libpq-dev` before retrying. + While installing, you might run into an error due to the pg gem requiring PostgreSQL libraries. If so, please run `sudo apt-get install libpq-dev` before retrying. 7. Install our frontend dependencies with `bin/yarn` 8. Set up your environment variables/secrets - Take a look at `Envfile`. This file lists all the `ENV` variables we use and provides a fake default for any missing keys. You'll need to get your own free [Algolia credentials](http://docs.dev.to/get-api-keys-dev-env/#algolia) to get your development environment running. -- This [guide](http://docs.dev.to/get-api-keys-dev-env/) will show you how to get free API keys for additional servies that may be required to run certain parts of the app. +- This [guide](http://docs.dev.to/get-api-keys-dev-env/) will show you how to get free API keys for additional services that may be required to run certain parts of the app. - For any key that you wish to enter/replace: 10. Create `config/application.yml` by copying from the provided template (ie. with bash: `cp config/sample_application.yml config/application.yml`). This is a personal file that is ignored in git.