welaika / wordmove

Multi-stage command line deploy/mirroring and task runner for Wordpress
https://wptools.it/wordmove
MIT License
1.87k stars 167 forks source link

Please describe what exactly happens with each command. #337

Closed COLABORATI closed 7 years ago

COLABORATI commented 8 years ago

It is not clear to understand what actually happens when commands are executed. Please add a description of what exactly happens, e.g. like this:

wordmove push does this:
* export database via mysqldump to a file called xzy in directory abc
* rsync all files from source/directory to destination/directory
* on remote server execute mysql command to overwrite old database
* maybe something else happens, I want to read about it before using it

Hopefully you get the idea. There is just too much magic happening and not enough explanation. Some questions to help:

Thank you very much!

alessandro-fazzi commented 8 years ago

Hi @COLABORATI !

Thanks for enquiring us; where should be intended to be kept those informations? In the documentation? README? Wiki?

And what should be the intended final goal? Reaching more users? Simplify debugging processes?

About the magic happening, sorry, but as far as I am concerned, software is not magic when you can read the code :)

I'm really interested in contributing more on this topic. Thanks in advance for you insights.

Cheers

alessandro-fazzi commented 7 years ago

Just added a FAQ in the wiki https://github.com/welaika/wordmove/wiki/FAQ

I hope it could be a good start point