petabyte-research / redflags

Automagically checks and filters risky public procurements
http://www.redflags.eu/
Apache License 2.0
4 stars 4 forks source link

Should developer documentation mention that redflags-database.sql is needed #18

Closed KrzysztofMadejski closed 8 years ago

KrzysztofMadejski commented 8 years ago

Should the docs here http://docs.redflags.eu/developer/first/ mention that redflags-database.sql is needed for engine to work?

Or is the redflags-auto.sh checks if the database exists and run the script if not?

I've run the script and it seems going without initiating the db. On the other hand i see that db has no tables. So I guess it will fail at later point, will it?

KrzysztofMadejski commented 8 years ago

Should it mention also redflags-helper-tables.sql? Should I run both? If yes, then, shouldn't these scripts be merged?

dzierzy commented 8 years ago

redflags-database.sql script should be described in docs.

redflags-helper-tables.sql is covered by sh script, it's being executed after engine finish processing procurements

juzraai commented 8 years ago

As I wrote it in the ToC, I constructed the documentation assuming developers will read through the first two sections (user, maintainer) too before reading developer docs. :)

Maintainer documentation tells every step required to set up the database, including both scripts: http://docs.redflags.eu/maintainer/database/

shouldn't these scripts be merged?

Nope. :)

KrzysztofMadejski commented 8 years ago

Sorry, I was too eager! :)