search

SORMAS-Foundation / SORMAS-Glossary

This glossary contains definitions of all the entities and attributes in SORMAS.
https://hzi-braunschweig.github.io/SORMAS-Glossary/en
GNU General Public License v3.0
5 stars 6 forks source link

Auto document the DB #5

Closed JonasCir closed 4 years ago

JonasCir commented 4 years ago

I came across this tool schemaspy and if it keeps what it promises it can help to "document your database simply and easily". Maybe @Candice-Louw @bernardsilenou , we can check it out tomorrow in our meeting? Their pitch really got me:

Do you hate starting on a new project and having to try to figure out someone 
else’s idea of a database? Or are you in QA and the developers 
expect you to understand all the relationships in their schema? 
If so then this tool’s for you.
JonasCir commented 4 years ago

For convenient usage https://hub.docker.com/r/schemaspy/schemaspy/

JonasCir commented 4 years ago

In schemaspy, you can add comments to database columns and export the result as PDF, CSV or Excel. It would look like this: schemaspy We could start with @BasilKaburi 's work on cases as a proof of concept. Later on, I would think of introducing a CI/CD pipeline which automatically generates the documentation PDFs for all tables after a merged PR and include them in GitHub pages. By this we would have up to date DB docs in an readable and accessible format on a website, helping core devs as well as interested contributors :) What do you think @Candice-Louw @bernardsilenou ? :)

bernardsilenou commented 4 years ago

@JonasCir Grossartig! We discuss it tomorrow