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.

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

DRAFT: Assign updates to existing published frozen archives to integrate errata and related work #116

Draft
wants to merge 1 commit into
base: edge
Choose a base branch
from

Conversation

jonasbardino
Copy link
Contributor

@jonasbardino jonasbardino commented Aug 29, 2024

Initial rough outline of the components and parts needed to support the requested feature of letting users assign a sort of updates to their already finalized/frozen published archives.
The fundamental issue is that the original MUST remain in place due to any DOI and code-of-conduct policies. So any updates e.g. to replace or supplement existing archives must leave the original intact and only e.g. add informational pointers between the involved archives. In that way people finding the original e.g. through a DOI will get informed about later errata and people landing at the errata archive can trace the history.
Another important note is that the original archive may already be backed up to long-term storage like tape and cannot easily be modified. So changes to the published archive should be minimal and to the extent possible also self-healing in case of disaster recovery from long-term storage.

In practice users will get a new Assign Update button on the show archive page for finalized archives similar to the existing Register DOI button there. When using that update button they should be presented with a dialog to mark the current archive as a replacement for another existing (selected) archive of theirs.
The registration of that relation involves writing the information to disk and specifically generate a published-updates.json file inside the published archive folders that the landing pages will then AJAX-query and use to display Archive replacement information and links. That is, both involved archives should get that information into their published-updates.json in the process in order to make the linking bilateral.

The same method can potentially be extended to cover similar functionality for users to assign a published archive to supplement another existing published frozen one.

requested feature of letting users assign a sort of updates to their already
finalized/frozen published archives. The fundamental issue is that the original
MUST remain in place due to any DOI and code-of-conduct policies. So any
updates e.g. to replace or supplement existing archives must leave the original
intact and only e.g. add informational pointers between involved archives. In
that way people finding the original e.g. through a DOI get informed about later
errata and people landing at the errata archive can trace the history.
@jonasbardino jonasbardino added enhancement New feature or request help wanted Extra attention is needed follow-up pending Pending tasks to follow-up on after close labels Aug 29, 2024
@jonasbardino jonasbardino requested review from a team August 29, 2024 14:20
@jonasbardino jonasbardino self-assigned this Aug 29, 2024
@jonasbardino
Copy link
Contributor Author

This work is related to ERDA support ticket 33213 so I have included both developers and supporters on reviewers. Some of that work involves actual testing and feedback once deployed on dev/test envs.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request follow-up pending Pending tasks to follow-up on after close help wanted Extra attention is needed
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant