Merge pull request #17 from ModestCoders/documentation

Documentation

README.md

@@ -4,12 +4,16 @@
 
 ## Performance Comparison
 
-#### 5x faster than any other docker setup on MacOS
+#### Up to 10x faster development experience on OSX
 
 <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>
 
+#### Check out all benchmarks
+
+* [Benchmarks: Dockergento vs Standard Docker](docs/benchmarks.md)
+
 ## Motivation
 
 This project aims to offer a good performance solution for Mac users that want to use docker on development.
@@ -148,12 +152,6 @@ See [dockergento workflow](#workflow) for a better understanding about whole dev
 
 ## Usage
 
-### Video Demos
-
-<a href="https://www.youtube.com/watch?v=rtr8waq7DHo&list=PLBt8dizedSZBhcjTL8SM2PS2HEy0mFf5F" target="_blank">
-  <img src="docs/img/wizard_install_video.png" alt="Dockergento video demos" width="240px" height="180px" border="10" />
-</a>
-
 ### Start Application
 
 ```
@@ -181,20 +179,6 @@ See detailed documentation about development workflow with dockergento
 
 * [Docker Images List](docs/docker_images.md)
 
-## Troubleshooting
-
-### Named volumes suddenly bind to host
-
-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`
-
-In case of confirmation that volumes are broken, restart dockergento:
-
-* `dockergento restart`
-
-**NOTE**: if volumes are still broken after restarting, you need to restart the docker app :(
-
 ## ChangeLog
 
 * [CHANGELOG.md](CHANGELOG.md)

docs/benchmarks.md

@@ -0,0 +1,20 @@
+# Benchmarks
+
+
+## Specifications
+
+* **Computer:** macOs Sierra 10.12.6, i7 - 3.1 GHz, 16GB RAM
+* **Docker version:** 18.06.1-ce-mac73
+* **Magento mode:** developer
+* **Data:** luma theme with magento sample data
+
+## Charts
+
+#### Shorter is better
+
+![Benchmark Home Page](img/benchmark_home.png)
+
+![Benchmark Home Page](img/benchmark_category.png)
+
+![Benchmark Home Page](img/benchmark_product.png)
+

docs/xdebug_phpstorm.md

@@ -4,7 +4,7 @@
 
 Xdebug needs to be enabled inside the `phpfpm` container. 
 
-* You can do that as explained in `magento2-dockergento-console` -> [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/blob/master/docs/workflow.md#6-xdebug)
 
 	```
 	dockergento debug-enable
@@ -41,4 +41,4 @@ Xdebug needs to be enabled inside the `phpfpm` container.
 
 
 
-
+