openaustralia / morph

Take the hassle out of web scraping
https://morph.io
GNU Affero General Public License v3.0
461 stars 74 forks source link

Update encrypted file handling #1156

Closed auxesis closed 7 years ago

auxesis commented 7 years ago

Update the documentation on how to handle encrypted files.

auxesis commented 7 years ago

@equivalentideas I think this whole section of documentation is a bit of a mess.

by ignoring the encrypted files, how will people have the files to be decrypted? That's not clear in these instructions.

It won't work unless you have all the credentials in place, and the only credentials we ship are encrypted ones. There's no documentation about how to set up credentials from scratch when setting up a local dev environment.

Do you think we should move this bit up in the readme so people see it before they clone? Or is it really just for us? Maybe we should start a new section, 'Setting up to deploy to the production instance at https://morph.io'?

This section of documentation should help any user who wants to set up a public-facing copy of Morph, either for production use or testing.

Right now, the documentation only "helps" us.

It comes back to what I said above: we need to write documentation that covers:

auxesis commented 7 years ago

@equivalentideas and to be clear: I think that new documentation should be handled in a separate PR.

equivalentideas commented 7 years ago

That all sounds very sensible to me @auxesis , I'll merge this.

henare commented 7 years ago

Relates to #948.