Add additional context to a note about pending publication
#1310
Conversation
jazairi
left a comment
jazairi
left a comment
There was a problem hiding this comment.
Could you include information about the consequences of publishing the same thesis multiple times? I assume the issue is duplicate DSpace records and/or multiple handles, but it may be useful to explicitly document what the risk is.
README.md
Outdated
| ``` | ||
|
|
||
| Note: `Pending publication` is allowed here, but not expected to be a normal occurence, to handle the edge case of the app thinking data was sent to SQS but the data not arriving for any reason. | ||
| Warning: `Pending publication` is allowed here, but not expected to be a normal occurence, to handle the edge case of the app thinking data was sent to SQS but the data not arriving for any reason. It is possible to send multiple copies of a single thesis to the publishing queue with this feature. Please be sure the SQS queues are fully processed and that you are absolutely confident that sending a `Pending publication` status thesis back into the publishing queue is appropriate. Failure to use care could lead to a single thesis being published more than once, which is bad. This is only a concern specifically for the `Pending publication` and `Publication review` statuses as no other statuses can be sent to the queue with this method. |
There was a problem hiding this comment.
What are the implications of double-publishing? Multiple DSpace records?
There was a problem hiding this comment.
Ha. Great question and I agree it should be added here for context. I'm not actually even sure what would happen in our app in this situation, but it would definitely involve having the thesis team clean up the extra record. I'll leave this open until I can figure out how best to word the important context here.
There was a problem hiding this comment.
Fwiw, I think it would provide sufficient context to say something like, "which may result in duplicated theses being published and other unexpected consequences." (I don't think we necessarily need to document everything that could go wrong.)
|
@JPrevost I noticed this PR while doing some maintenance and tried to do a bit more wordsmithing. Let me know what you think! |
JPrevost
left a comment
JPrevost
left a comment
There was a problem hiding this comment.
That seems very clear. Thanks for taking the time to explain the situation better!
There is no code, only a docs update to provide additional context to an edge case we are now supporting.