department-of-veterans-affairs / va.gov-cms

Editor-centered management for Veteran-centered content.
https://prod.cms.va.gov
GNU General Public License v2.0
99 stars 69 forks source link

ERD diagram #4509

Open kevwalsh opened 3 years ago

kevwalsh commented 3 years ago

User Story or Problem Statement

As a front end dev, i have an ERD to refer to when working on a liquid template. Relevant slack thread

As a product support team engineer, content model designer, or other CMS team member, i can create ERDs for documentation purposes, using a standardized tool available to most team members.

ERDs are typically going to be product-focused, or content-type focused. Some products are probably too complex to be documented with a single ERD (eg VAMC system).

Acceptance Criteria

Implementation steps

One possible implementation route, but there are probably better options out there.

Example (incomplete) ERD generated with the ERD contrib module.

clp-erd-example

mpelzsherman commented 3 years ago

@kevwalsh - I guess we can close this ticket. Between the murals you've been providing and graphql explorer, we can get the general idea of entities and relationships in the CMS system.

I still like the idea of having an ERD though. It would be more useful without all of the attributes - those we can get from graphql explorer. We just need a diagram showing the entities and relationships. This might take some of the guesswork out of writing graphql queries.

cc @ncksllvn @kelsonic @brangi @jt20816