Skip to content

Database diagram and protocols#411

Merged
jessiejofielding merged 5 commits intomainfrom
database_diagram
Sep 29, 2020
Merged

Database diagram and protocols#411
jessiejofielding merged 5 commits intomainfrom
database_diagram

Conversation

@jessiejofielding
Copy link
Contributor

Changes:

  • update requirements.txt to include relevant packages for keeping the db diagram up to date
  • add current db diagram
  • update docs to include protocols for database changes
  • update docs to include protocols for code coverage

To test:

  • pip install -r requirements.txt
  • if you have trouble with pygraphviz, try brew install graphviz and then pip install pygraphviz; if this doesn't work contact me or stackoverflow (this is an intermittent problem with dependencies and installation paths and sometimes incomplete installations, brew fixed it for me, but pip supposedly works for many people).
  • run python manage.py graph_models -a -o models.png and check there are no errors (this should also rewrite models.png, a change which you can discard instead of pushing)
  • read over the updated docs and ensure they are free of typos and clear

Closes #402 and closes #403

Copy link
Contributor

@k-y-le k-y-le left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

looks good to me!

@jessiejofielding jessiejofielding merged commit e73a4df into main Sep 29, 2020
@jessiejofielding jessiejofielding deleted the database_diagram branch September 29, 2020 01:31
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

2 participants