diff --git a/docs/work_states.md b/docs/work_states.md new file mode 100644 index 000000000..7d3e8b270 --- /dev/null +++ b/docs/work_states.md @@ -0,0 +1,59 @@ +# Work States +This document describes the different states works go through as part of the systen + +## State Definitions + +* Before it is saved its state is empty +* Draft - The creator is in the process of depositing their dataset into PDC Describe + * It must have a draft DOI + * It must have a title(s) + * It must have a creator(s) + * It must have a collection (it may be a default) +* Awaiting Approval - The creator is ready for a curator to review their dataset and metadata + * Complete the wizard + * description + * publication year (default to current year) + * publisher (default Princeton) + * one or more files + * We send notification to curator(s) of the collection + * in app notification + * email +* Approved - The curators are ready for this dataset to be published for the public to find + * Indexed to PDC Discovery + * published in DataCite with the PDC Discovery URL + * Move to the Princeton Data Commons Globus collection + * No ARK will be minted for newly deposited items + * An item with an existing ARK should be updated to have the new PDC Discovery URL + * Notify the Depositor that my item has been approved + * email +* Withdrawn - The user no longer wants to publish this dataset. + * removed from PDC Discovery Index + * Marked as Registered DataCite + * Notify the Curators + * Removed the Data & delete the object + * If an ARK exists we should withdraw it + * We send notification to curator who approved the work + * Draft to withdrawn will not notify + * in app notification - awaiting approval & approved + * email - approved +* Tombstone - The Curator has deleted the data and specified that this will not be recovered + * The curator would delete files **(not automated)** + * The curator may have the ability to delete the DOI **(not automated)** + +```mermaid +stateDiagram-v2 + draft: Draft + await: Awaiting Approval + approve: Approved + withdrawn: Withdrawn + tombstone: Tombstone + [*] --> draft + draft --> await + await --> await + await --> approve + await --> withdrawn + withdrawn --> await + approve --> withdrawn + draft --> withdrawn + withdrawn --> tombstone +``` \ No newline at end of file