riparias / gbif-alert

GBIF Alert is a GBIF occurrence based alert system.
https://gbif-alert-demo.thebinaryforest.net/
MIT License
8 stars 2 forks source link

Improve installation document #249

Closed damianooldoni closed 1 year ago

damianooldoni commented 1 year ago

Hi @niconoe. This PR is a kind of review of your INSTALL.md document. I know, it was still not finalized, but I landed on this document and I thought you could already take advantage of this first review. I stopped at ~ line 66 as from then it seems more or less work in progress.

The only thing I think you still should check/add are:

  1. PostgreSQL and Redis: is there a minimum version required? At the moment it's not mentioned, but I think there should be, as for Python or PostGIS
  2. If I follow the installation via Docker-compose, which other software do I need? Do I need all of the ones mentioned at the very begin, i.e. Python (for sure), PostgreSQL,PostGis, Redis, Django?

Notice also that the CONTRIBUTING.md is at the moment more or less a kind of detailed version of INSTALL.md 😄 Probably at the end of all editing, the contributing page should be something more like this: https://docs.ropensci.org/frictionless/CONTRIBUTING.html. If you think a more detailed installation page is needed, you can hold it of course: rename it and maybe point to this page in the INSTALL.md at some point.

I hope this helps! Feel free to scrumble anything I added/changed as you wish 👋