Merge pull request #11 from ModestCoders/doc-updates

Doc updates

Author: danielozano

CHANGELOG.md

@@ -11,6 +11,16 @@ and this project adheres to [Semantic Version](http://semver.org/spec/v2.0.0.htm
 
 ### Removed
 
+## [1.3] - 05-09-2018
+
+### Changed
+
+* Documentation about how to sync `vendor` and `generated` volumes according to latest changes on [magento2-dockergento-console](https://github.com/ModestCoders/magento2-dockergento-console) 
+
+### Removed
+
+* Remove first 2 steps to configure xdebug in PHPStorm are not longer needed because it is enough by just setting the debug port and server configuration
+* Remove bind mount of `generated` folder in `unison container. Unison container is now only meant to be used for `watch` command inside vendor modules.
 
 ## [1.2.0] - 30-08-2018
 ### Added

README.md

@@ -4,6 +4,8 @@
 
 ## Performance Comparison
 
+#### 10x faster than any other docker setup on MacOS
+
 <a href="https://youtu.be/sGmXc_lzTNM" target="_blank">
   <img src="docs/img/comparison_speed_video.png" alt="Dockergento speed comparison" width="240" height="180" border="10" />
 </a>
@@ -45,35 +47,9 @@ As a work-around for this behavior, you can put vendor or third-party library di
 	* pub/static
 	* pub/media
 
-* Synchronise `vendor` and `generated` volumes using a specific `unison` container. 
-
-	<details>
-	<summary>How to sync volumes between host and container</summary>
-	
-	See [dockergento workflow](#workflow) for a better understanding about whole development process with dockergento.
-	
-	There are 2 options to sync the volumes `vendor` and `generated`
-
-	**Option 1: One time sync**
-
-	This option must be used most of the times. You should only need to sync `vendor` and `generated` from time to time for debugging purposes
-
-	```
-	docker-compose run --rm unison sync -path vendor -path generated
-	```
-
-	NOTE: For faster and more specific syncs, you can specify a subfolder like `sync -path vendor/<company_name>`.
-
-	**Option 2: Watch**
-
-	This option is only recommended if you are implementing code in a vendor module.
-
-	```
-	docker-compose run --rm unison watch -path vendor/<company_name>/<module_name>`
-	```	
-	
-	</details>
-	
+* Custom synchronisation of `vendor` and `generated`:
+	* These volumes are synchronised seamless thanks to [magento2-dockergento-console](https://github.com/ModestCoders/magento2-dockergento-console)
+	* See [dockergento workflow](#workflow) for a better understanding about whole development process with dockergento.	
 
 ## Preconditions
 
@@ -215,9 +191,9 @@ See detailed documentation about development workflow with dockergento
 
 ## Troubleshooting
 
-### Named volumes suddenly binded to host
+### Named volumes suddenly bind to host
 
-There is bug in docker that causes volumes to stop working and start behabing like a binded mount. If you notice a performance decrease, try the following:
+There is bug in docker that causes volumes to stop working and start behaving like a bind mount. If you notice a performance decrease, try the following:
 
 * `dockergento volumes-check`
 

docker-compose.yml

@@ -47,9 +47,7 @@ services:
     image: modestcoders/unison:2.51.2
     volumes:
       - app-vendor:/var/www/html/vendor
-      - app-generated:/var/www/html/generated
       - ./vendor:/sync/vendor
-      - ./generated:/sync/generated
     environment:
       - SYNC_SOURCE_BASE_PATH=/sync
       - SYNC_DESTINATION_BASE_PATH=/var/www/html

docs/samples/composer_json.md

@@ -85,4 +85,4 @@
     }
   }
 }
-``
+```

docs/xdebug_phpstorm.md

@@ -1,51 +1,37 @@
 # PHPStorm + Xdebug Setup
 
-## Enable xdebug
+## Enable Xdebug
 
-`xdebug` needs to be enabled inside the `phpfpm` container. You can do that as explained in `magento2-dockergento-console`
+Xdebug needs to be enabled inside the `phpfpm` container. 
 
-* workflow -> [enable xdebug](https://github.com/ModestCoders/magento2-dockergento-console/tree/master/docs/workflow#xdebug)
+* You can do that as explained in `magento2-dockergento-console` -> [enable xdebug](https://github.com/ModestCoders/magento2-dockergento-console/tree/master/docs/workflow#xdebug)
 
-## PHPStorm configuration
-
-1. `Build, Execution, Deployment > Docker`
-
-	* Add new docker profile (i.e dockergento)
-
-2. `PHPStorm > Preferences > Languages & Frameworks > PHP`
-
-	* Add new CLI interpreter
+	```
+	dockergento debug-enable
+	```
 
-	![cli_new_interpreter](img/cli_new_interpreter.png)
-	
-	* Select CLI Interpreter from Docker
-
-	![interpreter_from_docker](img/interpreter_from_docker.png)
-	
-	* Select `phpfpm` docker image
-
-	![interpreter_phpfpm_image](img/interpreter_phpfpm_image.png)
+## PHPStorm configuration
 
-3. `PHPStorm > Preferences > Languages & Frameworks > PHP > Debug`	
+1. `PHPStorm > Preferences > Languages & Frameworks > PHP > Debug`	
 	* Debug Port: 9001
 
 	![debug_port](img/debug_port.png)
 
-4. `PHPStorm > Preferences > Languages & Frameworks > PHP > Servers`
+2. `PHPStorm > Preferences > Languages & Frameworks > PHP > Servers`
 
 	* Name: `localhost` (Same as `PHP_IDE_CONFIG` in `docker-compose.yml`)
 	* Port: 8000
 	* Mapping: `/Users/<username>/Sites/<project> -> /var/www/html`
 
 	![debug_server_mapping](img/debug_server_mapping.png)
 
-5. Start Listening for PHP Debug connections
+3. Start Listening for PHP Debug connections
 
 	**NOTE**: Be sure to activate that only after setting the right debug port. Changes in Debug port are ignored once the listener has started.
 
 	![PHPStorm Debug Listener](img/phpstorm_debug_listener.png)
 
-6. Install and enable `Xdebug helper` plugin in Chrome
+4. Install and enable `Xdebug helper` plugin in Chrome
 
 	* [https://chrome.google.com/webstore/detail/xdebug-helper](https://chrome.google.com/webstore/detail/xdebug-helper/eadndfjplgieldjbigjakmdgkmoaaaoc)