Describe the database schema with text and a graphic
Submitted by Gil Forcada
Damned-Lies is built on top of Django and it uses a SQL backend to store its data, it would be extremely cool if we could have a text description of the database schema (tables, fields and relations) and a dia/something-updatable to point to newcomers when they want to start hacking on Damned-Lies.
A recurrent first patch then could be to simply go over this documentation and update it according to its new developments that happened on Damned-Lies since the last update.
This means basically:
- create a plain text file (.rst is also ok) describing the tables involved, which fields are and which relations exist between tables. This is not literacy, a straight to the point kind of documentation is enough. Still, some tips here and there about a field or a relation is always welcome.
- alongside this text documentation, a dia graphic with the tables, fields and showing its relations