add documentation #1
Draft
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
jonavellecuerdo
force-pushed
the
add-docs
branch
from
441a71e
to
bf7b0d7
Compare
jonavellecuerdo
force-pushed
the
add-docs
branch
from
bf7b0d7
to
2d07ea7
Compare
jonavellecuerdo
force-pushed
the
add-docs
branch
from
2d07ea7
to
0cd4531
Compare
jonavellecuerdo
force-pushed
the
add-docs
branch
from
0cd4531
to
beedd22
Compare
ehanson8
reviewed
Apr 30, 2024
docs/entity_relationship_diagram.md
Outdated
There was a problem hiding this comment.
Very helpful for establishing the context of this workflow!
| @@ -0,0 +1,74 @@ | |||
| # Publication Email Request Service (PERS) | |||
|
|
|||
| The following are sequence diagrams describing the workflow for sending publication email requests with this service. At high-level the steps involved are: | |||
There was a problem hiding this comment.
Minor and optional, but maybe email requests for publications for clarity
|
|
||
| The following are sequence diagrams describing the workflow for sending publication email requests with this service. At high-level the steps involved are: | ||
|
|
||
| 1. Import citations for authors |
There was a problem hiding this comment.
Optional rephrasing to improve clarity (but please correct if I'm getting it wrong!):
1. Import Publication citations for Authors to database
2. Create emails requesting the Publications based on the citations
3. Review and (optionally) update emails
4. Send emails to Liaisons who will send them to Authors
ehanson8
reviewed
May 1, 2024
| * When an `Email` is created, it is assigned to **one** `Author` and **one** `Liaison`. | ||
| The entities involved in PERS are as follows: | ||
|
|
||
| * `DLC`: Represents a department, lab, or center at MIT and is managed by a single **liaison**. A **DLC** can comprise of many **authors**, but an author is assigned to a single **DLC**. |
There was a problem hiding this comment.
Extra detail is very helpful
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Purpose and background context
Add documentation describing the Publication Email Request Service (PERS) workflow. These diagrams were created from reviewing the existing Solenoid workflow and data models.
What are the relevant tickets?
Developer
Code Reviewer(s)