empress
empress copied to clipboard
Make it clear where to clone the repo to
The docs don't specify where to clone the repo to.
There are two options:
- Clone to deploy machine (locally, your laptop, etc.)
- @bnvk's (and my) use case (for email migration etc) clone to remote machine.
These two options need to be documented, probably on a wiki that's linked from the readme.
Want to back this issue? Post a bounty on it! We accept bounties via Bountysource.
Should probably also give pros/cons of both approaches.
@PiPeep also suggests using a docs/
folder instead of GitHub's wiki (since it's not synced with the repo). Good suggestion. :+1:
Re pros/cons, the basics are: if deploy machine's connection goes down and you're doing it from there things can get broken. If you're doing it remotely and you brick the server, users can lose their customizations of user.yml
.