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.

Sign up for GitHub

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

Update database diagram using MySQL Workshop #22

Merged
merged 1 commit into from
Oct 9, 2020
Merged

Update database diagram using MySQL Workshop #22

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .gitattributes
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,3 +4,4 @@
*.svg filter=lfs diff=lfs merge=lfs -text
*.vsdx filter=lfs diff=lfs merge=lfs -text
*.jpg filter=lfs diff=lfs merge=lfs -text
*.mwb filter=lfs diff=lfs merge=lfs -text
6 changes: 4 additions & 2 deletions docs/development/tips_and_tricks.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -131,7 +131,9 @@ Note that the ``cat`` example above will also add the ATHS info for the
Architecture Diagrams
---------------------
Copy link
Member Author

Choose a reason for hiding this comment

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

As a side note, this section is extremely buried in our docs right now, suggestions for reorganizing welcome for a follow-up PR :)


Some helpful diagrams for getting a sense of the SecureDrop application architecture are stored `here
<https://github.com/freedomofpress/securedrop/tree/develop/docs/diagrams>`_, including a high-level view of the SecureDrop database structure:
Some helpful diagrams for getting a sense of the SecureDrop application
architecture are stored `here <https://github.com/freedomofpress/securedrop-docs/tree/main/docs/diagrams>`_,
including a high-level view of the SecureDrop database structure:

.. image:: ../diagrams/securedrop-database.png
:width: 100%
Copy link
Member Author

Choose a reason for hiding this comment

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

This ensures that clicking the diagram will display the full-size version.

6 changes: 4 additions & 2 deletions docs/diagrams/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,8 +16,10 @@ an entry here:
`SecureDrop-visio.png`. For context, see [#274][].
- `SecureDrop-0.3-DFD.png`: A WIP DFD (data flow diagram) created for
SecureDrop 0.3. WIP.
- `securedrop-database.png`: A diagram of the tables and columns in the securedrop app's SQLite database.
- `securedrop-database.tex`: TeX used to generate the `securedrop-database.png` figure.
- `securedrop-database.png`: An entity relationship diagram of the
SecureDrop SQLite database
- `securedrop-database.mwb`: MySQL Workshop file used to generate
and update the diagram
- `SecureDrop_DataFlow.png`: Data flow diagram for SecureDrop.
- `SecureDrop_DataFlow.draw`: XML used to generate with [Draw.io][].
[SecureDrop website FAQ]: https://securedrop.org/faq#how_works
Expand Down
3 changes: 3 additions & 0 deletions docs/diagrams/securedrop-database.mwb
View file
Open in desktop
Git LFS file not shown
4 changes: 2 additions & 2 deletions docs/diagrams/securedrop-database.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
132 changes: 0 additions & 132 deletions docs/diagrams/securedrop-database.tex
View file
Open in desktop

This file was deleted.