Skip to content

Document the process to update the db diagram #275

Description

@fe51

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.

Metadata

Metadata

Assignees

No one assigned

    Labels

    questionFurther information is requestedtopic: docsImprovements or additions to documentation

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions