Permalink
Browse files

update readme

  • Loading branch information...
1 parent 74b6bd8 commit d91b9337817754784b04d0aa10da7510b3fc97c5 @d4be4st d4be4st committed Jul 8, 2016
Showing with 37 additions and 17 deletions.
  1. +3 −3 .rubocop.yml
  2. +12 −12 Readme.md
  3. +1 −1 docs/command_line_options.md
  4. +1 −1 docs/deploying.md
  5. +11 −0 docs/faq.md
  6. +9 −0 docs/getting_started.md
View
@@ -209,7 +209,7 @@ Metrics/AbcSize:
Description: >-
A calculated magnitude based on number of assignments,
branches, and conditions.
- Reference: 'http://c2.com/cgi/wiki?AbcMetric'
+ Reference: 'https://c2.com/cgi/wiki?AbcMetric'
Enabled: false
Max: 20
@@ -358,7 +358,7 @@ Rails/ScopeArgs:
Rails/TimeZone:
Description: 'Checks the correct usage of time zone aware methods.'
StyleGuide: 'https://github.com/bbatsov/rails-style-guide#time'
- Reference: 'http://danilenko.org/2012/7/6/rails_timezones'
+ Reference: 'https://danilenko.org/2012/7/6/rails_timezones'
Enabled: false
Rails/Validation:
@@ -644,7 +644,7 @@ Style/FormatString:
Style/GlobalVars:
Description: 'Do not introduce global variables.'
StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#instance-vars'
- Reference: 'http://www.zenspider.com/Languages/Ruby/QuickRef.html'
+ Reference: 'https://www.zenspider.com/Languages/Ruby/QuickRef.html'
Enabled: false
Style/GuardClause:
View
@@ -3,7 +3,7 @@
[![Code Climate](https://codeclimate.com/repos/5774207165982076ca005984/badges/6877153919d603250738/gpa.svg)](https://codeclimate.com/repos/5774207165982076ca005984/feed)
[![Test Coverage](https://codeclimate.com/repos/5774207165982076ca005984/badges/6877153919d603250738/coverage.svg)](https://codeclimate.com/repos/5774207165982076ca005984/coverage)
[![Build Status](https://semaphoreci.com/api/v1/d4be4st/mina/branches/master/shields_badge.svg)](https://semaphoreci.com/d4be4st/mina)
-[![Gem Version](https://badge.fury.io/rb/mina.svg)](http://badge.fury.io/rb/mina)
+[![Gem Version](https://badge.fury.io/rb/mina.svg)](https://badge.fury.io/rb/mina)
Really fast deployer and server automation tool.
@@ -40,7 +40,7 @@ Acknowledgements
© 2012-2015, Nadarei.
2015-2016, Infinum.
-Released under the [MIT License](http://www.opensource.org/licenses/mit-license.php).
+Released under the [MIT License](https://www.opensource.org/licenses/mit-license.php).
Mina is authored [Rico Sta. Cruz][rsc] and [Michael Galero][mg] with help from its [contributors][c] and their startup, [Nadarei][nd].
It is maintained by [Stjepan Hadjić][sh] and [Gabrijel Škoro][gs] and sponsored by [Infinum][inf].
@@ -57,24 +57,24 @@ Gabrijel:
Rico:
- * [My website](http://ricostacruz.com) (ricostacruz.com)
- * [Github](http://github.com/rstacruz) (@rstacruz)
- * [Twitter](http://twitter.com/rstacruz) (@rstacruz)
+ * [My website](https://ricostacruz.com) (ricostacruz.com)
+ * [Github](https://github.com/rstacruz) (@rstacruz)
+ * [Twitter](https://twitter.com/rstacruz) (@rstacruz)
Michael:
* [My website][mg] (michaelgalero.com)
- * [Github](http://github.com/mikong) (@mikong)
+ * [Github](https://github.com/mikong) (@mikong)
Nadrei:
- * [Nadarei](http://nadarei.co) (nadarei.co)
- * [Github](http://github.com/nadarei) (@nadarei)
+ * [Nadarei](https://nadarei.co) (nadarei.co)
+ * [Github](https://github.com/nadarei) (@nadarei)
-[rsc]: http://ricostacruz.com
-[mg]: http://devblog.michaelgalero.com/
-[c]: http://github.com/mina-deploy/mina/graphs/contributors
-[nd]: http://nadarei.co
+[rsc]: https://ricostacruz.com
+[mg]: https://devblog.michaelgalero.com/
+[c]: https://github.com/mina-deploy/mina/graphs/contributors
+[nd]: https://nadarei.co
[sh]: https://github.com/d4be4st
[gs]: https://github.com/gabskoro
[inf]: https://infinum.co
@@ -20,7 +20,7 @@ Beside normal rake options mina added some of its own:
### Tasks
-There are many tasks available. See the [tasks reference](http://mina-deploy.github.io/mina/tasks/), or
+There are many tasks available. See the [tasks reference](https://mina-deploy.github.io/mina/tasks/), or
type `mina -T`.
### Variables
View
@@ -8,7 +8,7 @@ Mina provides the `deploy` command which runs your commands on remote backend.
set :domain, 'flipstack.com'
set :user, 'flipstack'
set :deploy_to, '/var/www/flipstack.com'
-set :repository, 'http://github.com/flipstack/flipstack.git'
+set :repository, 'https://github.com/flipstack/flipstack.git'
task :deploy do
deploy do
View
@@ -1 +1,12 @@
+Frequently Asked Questions
+--------------------
+
+* `command not found: bundle`
+
+You need to setup your server correctly [getting_started.md#step-0-configure-server], then install bundler.
+
+ gem install bundler
+
+
+
# WIP
@@ -3,6 +3,15 @@ Setting up a project
Let's deploy a project using Mina.
+### Step 0: Configure server
+
+Your server needs to be properly configured for mina to work. Requirements for mina 1.0 to work:
+- SSH public/private key pair set up
+- deploy user to have access to folders where you want to install the application
+- installed git
+- installed ruby (some ruby manager recommended rbenv/rvm/chruby)
+- installed bundler
+
### Step 1: Create a config/deploy.rb
In your project, type `mina init` to create a sample of this file.

0 comments on commit d91b933

Please sign in to comment.