docs/getting_started.md in mina-1.0.7 vs docs/getting_started.md in mina-1.1.0
- old
+ new
@@ -1,20 +1,19 @@
-Setting up a project
---------------------
+# Setting up a project
Let's deploy a project using Mina.
-### Step 0: Configure server
+## 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
+## Step 1: Create a config/deploy.rb
In your project, type `mina init` to create a sample of this file.
$ mina init
Created config/deploy.rb.
@@ -51,25 +50,27 @@
# invoke :'rvm:use', 'ruby-1.9.3-p125@default'
end
...
```
-### Step 2: Run 'mina setup'
+## Step 2: Run 'mina setup'
Back at your computer, do `mina setup` to set up the folder structure in `deploy_to` path.
This will connect to your server via SSH and create the right directories.
$ mina setup
-----> Creating folders... done.
-See [directory structure](https://github.com/mina-deploy/mina/wiki/Directory-structure) for more info.
+## Step 3: Deploy!
-### Step 3: Deploy!
-
Use `mina deploy` to run the `deploy` task defined in *config/deploy.rb*.
$ mina deploy
-----> Deploying to 2012-06-12-040248
...
Lots of things happening...
...
-----> Done.
+
+## Step 4: Considerations after first deploy
+
+If you changed `shared_files` and `shared_dirs` in your `deploy.rb` you have to run `mina setup` again. This ensures all needed folders are created.