Add additional context to a note about pending publication
#1310
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
jazairi
requested changes
May 1, 2024
| @@ -390,7 +390,7 @@ task: | |||
| heroku run -s standard-2x rails dss:publish_thesis_by_id[THESIS_ID] --app TARGET-HEROKU-APP | |||
| ``` | |||
|
|
|||
| 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.)
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.
There is no code, only a docs update to provide additional context to an edge case we are now supporting.