Skip to content

Commit 611d4b1

Browse files
authored
Merge pull request #17 from ModestCoders/documentation
Documentation
2 parents eee4d4f + 2ba75ce commit 611d4b1

File tree

6 files changed

+27
-23
lines changed

6 files changed

+27
-23
lines changed

README.md

Lines changed: 5 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -4,12 +4,16 @@
44

55
## Performance Comparison
66

7-
#### 5x faster than any other docker setup on MacOS
7+
#### Up to 10x faster development experience on OSX
88

99
<a href="https://youtu.be/sGmXc_lzTNM" target="_blank">
1010
<img src="docs/img/comparison_speed_video.png" alt="Dockergento speed comparison" width="240" height="180" border="10" />
1111
</a>
1212

13+
#### Check out all benchmarks
14+
15+
* [Benchmarks: Dockergento vs Standard Docker](docs/benchmarks.md)
16+
1317
## Motivation
1418

1519
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
148152

149153
## Usage
150154

151-
### Video Demos
152-
153-
<a href="https://www.youtube.com/watch?v=rtr8waq7DHo&list=PLBt8dizedSZBhcjTL8SM2PS2HEy0mFf5F" target="_blank">
154-
<img src="docs/img/wizard_install_video.png" alt="Dockergento video demos" width="240px" height="180px" border="10" />
155-
</a>
156-
157155
### Start Application
158156

159157
```
@@ -181,20 +179,6 @@ See detailed documentation about development workflow with dockergento
181179

182180
* [Docker Images List](docs/docker_images.md)
183181

184-
## Troubleshooting
185-
186-
### Named volumes suddenly bind to host
187-
188-
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:
189-
190-
* `dockergento volumes-check`
191-
192-
In case of confirmation that volumes are broken, restart dockergento:
193-
194-
* `dockergento restart`
195-
196-
**NOTE**: if volumes are still broken after restarting, you need to restart the docker app :(
197-
198182
## ChangeLog
199183

200184
* [CHANGELOG.md](CHANGELOG.md)

docs/benchmarks.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
# Benchmarks
2+
3+
4+
## Specifications
5+
6+
* **Computer:** macOs Sierra 10.12.6, i7 - 3.1 GHz, 16GB RAM
7+
* **Docker version:** 18.06.1-ce-mac73
8+
* **Magento mode:** developer
9+
* **Data:** luma theme with magento sample data
10+
11+
## Charts
12+
13+
#### Shorter is better
14+
15+
![Benchmark Home Page](img/benchmark_home.png)
16+
17+
![Benchmark Home Page](img/benchmark_category.png)
18+
19+
![Benchmark Home Page](img/benchmark_product.png)
20+

docs/img/benchmark_category.png

238 KB
Loading

docs/img/benchmark_home.png

232 KB
Loading

docs/img/benchmark_product.png

236 KB
Loading

docs/xdebug_phpstorm.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

55
Xdebug needs to be enabled inside the `phpfpm` container.
66

7-
* You can do that as explained in `magento2-dockergento-console` -> [enable xdebug](https://github.com/ModestCoders/magento2-dockergento-console/tree/master/docs/workflow#xdebug)
7+
* 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)
88

99
```
1010
dockergento debug-enable
@@ -41,4 +41,4 @@ Xdebug needs to be enabled inside the `phpfpm` container.
4141

4242

4343

44-
44+

0 commit comments

Comments
 (0)