Skip to content

[Feature] Add database documentation #127

Description

@Dynnammo

Context
Currently, as a developer, I can struggle to understand how works the Decidim database.

Indeed, a "lite" decidim installation (ie. with only official modules) has about ~120 tables with ~1200 columns, which can bring some confusion both for :

  • developers to understand what's the purpose of each table in the global scheme
  • data workers : analyse and extract data, since the open data rely on such diagram

Solution
It would be great to use a dedicated language to describe relations in the Decidim database.

We could DBML as a first step to describe tables and columns precisely, and embed such diagrams/docs in the current documentation, but I'm open to any other tool that could be relevant, as long as it is versionable on Git

Use of such tools would also ease the process of seeing differences between the different minor versions of Decidim.

Founding
Open Source Politics

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions