Merge pull request #261 from wunderio/feature/startmd-hint-for-teammates

start.md — Fixes and new section for onboarding on already set up project

start.md

@@ -1,6 +1,89 @@
 # Quick start quide
 
-## To start a new project using WunderTools follow these simple steps:  
+## A – Onboarding onto an existing project
+
+To start working as a team member on a project that has _already been set up_ with wundertools, follow these steps:
+
+### 1.  Get the code
+
+Do a regular git clone of the repository.
+
+### 2. Prepare the VM
+
+On your host system, go to the root of your local git copy, and from there create the VM with:
+
+```bash
+vagrant up
+```
+
+
+### 3. Initialize application
+
+For this you need to be inside the VM (`vagrant ssh`) in the project root directory there (`cd /vagrant/drupal`).
+
+Go inside of your VM with:
+
+```bash
+vagrant ssh
+```
+
+And inside the VM, go to the app's directory:
+
+```bash
+cd /vagrant/drupal
+```
+
+From here you can …
+
+#### Either: Do a build from scratch.
+
+Run a full build inside the VM and the project root:
+
+```bash
+./build.sh create
+```
+
+The build.sh script will take a few minutes to run and will also do a _composer install_ for you implicitly.
+
+Stay tuned during the build process, as you'll have to answer some questions:
+
+* `Type yes to verify you want to create a new installation`
+**yes**
+* `You are about to DROP all tables in your 'drupal' database. Do you want to continue? (y/n):`
+**y**
+
+#### Or: Update and get current DB from server.
+
+##### Do an update build
+
+Run the build update (inside your VM and the project root directory):
+
+```bash
+./build.sh update
+```
+
+##### Get current database from server
+
+If there is a server to sync from, you can get the dump by running (inside your VM and project root):
+
+```bash
+./syncdb.sh
+```
+By default, this will sync the database from production to your local VM.
+See `./syncdb.sh -h` for all the other options. Note: syncdb relies on drush aliases, so those need to be defined (drush aliases are normally created by WunderOps team when they create the server instances and should be under drupal/drush/ with a name matching the project_name defined in project.yml, e.g. project_name.aliases.drushrc.php).
+
+### Verify the application is running
+
+After that, your application should be served by the vm, and you should be able in your host system to **point your browser to the host name** you had set in step 3, e.g. 'intra.dev' and see the application being served.
+
+Your can now `exit` out of your vm.
+
+If you experience a problem, have a look at the "Common Problems" section at the end of this document.
+
+
+## B – Setup a new project
+
+To start a new project using WunderTools follow these simple steps:  
 
 ### 1. Clone the repository and cd into it
 
@@ -78,7 +161,7 @@ vagrant ssh
 ```
 
 Now you're inside the guest vm created by vagrant in the last step.
-Got to the app's directory …
+Go to the app's directory …
 
 ```bash
 cd /vagrant/drupal
@@ -99,11 +182,15 @@ Stay tuned during the build process, as you'll have to answer some questions:
 * `You are about to DROP all tables in your 'drupal' database. Do you want to continue? (y/n):`
 **y**
 
-After that, your application should be server by the vm, and you should be able in your host system to **point your browser to the host name** you had set in step 3, e.g. 'intra.dev' and see the application being served.
+### 6. Verify the application is running
+
+After that, your application should be served by the vm, and you should be able in your host system to **point your browser to the host name** you had set in step 3, e.g. 'intra.dev' and see the application being served.
 
 Your can now `exit` out of your vm.
 
-### 6. Commit the created/changed files
+If you experience a problem, have a look at the "Common Problems" section at the end of this document.
+
+### 7. Commit the created/changed files
 
 The build process creates some files, a symlink and exports the Drupal configuration. **Commit those changes to git** and push to your remote origin.
 
@@ -113,7 +200,9 @@ Also consider to do fix permissions on Drupal's sites/default on your host syste
 chmod 755 drupal/web/sites/default
 ```
 
-### 7. Common Problems
+
+
+## C – Common Problems
 
 #### Host name serves no or wrong content