Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Document the process to update the db diagram #275

Open
fe51 opened this issue Aug 5, 2023 · 1 comment
Open

Document the process to update the db diagram #275

fe51 opened this issue Aug 5, 2023 · 1 comment
Labels
question Further information is requested topic: docs Improvements or additions to documentation

Comments

@fe51
Copy link
Member

fe51 commented Aug 5, 2023

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 fe51 added topic: docs Improvements or additions to documentation question Further information is requested labels Aug 5, 2023
@frgfm
Copy link
Member

frgfm commented Oct 8, 2023

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 👍
Or show an example code/visualization so that people can do it on their own

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
question Further information is requested topic: docs Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

2 participants