pyro-api icon indicating copy to clipboard operation
pyro-api copied to clipboard

Document the process to update the db diagram

Open fe51 opened this issue 2 years ago • 1 comments

Thanks to the documentation effort, this repo is much more accessible than in the past. Thanks @frgfm :)

We now have a diagram from dbdiagram.io describing our database in the README : https://github.com/pyronear/pyro-api#how-is-the-database-organized

In order to ensure that it is updated over time as changes are made to the repo, it would be cool to have the process describing the production of a new diagram following changes to the api (how to pass from the code in the repo to this diagram without having to rewrite everything on dbdiagram.io ?)

Could you describe this process ?

Maybe we could add a section to CONTRIBUTING.md like "Documenting updates in schema" ?

Thanks a lot, Happy to discuss it :)

PS: At the very least, you can quickly explain the process here and someone will be able to produce a clean doc update.

fe51 avatar Aug 05 '23 11:08 fe51

Quite simply, I have a pseudocode that lead to this graph in dbdiagram that I update :) Happy to put it somewhere in the repo if that can help :+1: Or show an example code/visualization so that people can do it on their own

frgfm avatar Oct 08 '23 15:10 frgfm