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

Add Makefile for entity relational diagrams, organize docs #795

Open
wants to merge 2 commits into
base: master
Choose a base branch
from

Conversation

hancush
Copy link

@hancush hancush commented Mar 10, 2022

Overview

This PR adds a Makefile for diagrams of our core models (person, organization, violation), plus locations, which shows areas of operation and emplacements for organizations, to keep the organization diagram reasonable in size. The output of this recipe is stored in docs/diagrams/.

It also moves docs from the root directory to a new docs/ directory.

Testing Instructions

  • Rebuild the app image.
  • Delete and rebuild the diagrams:
docker-compose run --rm app make clean_diagrams
docker-compose run --rm app make diagrams

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant