Skip to content

Commit

Permalink
YDA-5842: update documentation of research space after removal of sec…
Browse files Browse the repository at this point in the history
…ured folder status
  • Loading branch information
kaur16 committed Jul 30, 2024
1 parent c10be9c commit d8f34f8
Show file tree
Hide file tree
Showing 7 changed files with 6 additions and 419 deletions.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
198 changes: 1 addition & 197 deletions docs/design/overview/img/research/research-space-sequence-diagram.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,6 @@ datamanager -> yoda : Accept for vault
yoda --> researcher : Accepted notification
note over yoda : ACCEPTED
yoda -> yoda : Secure in vault
note over yoda : SECURED
yoda --> researcher : Secured notification
yoda --> datamanager : Secured notification
== Rejected folder ==
Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
214 changes: 1 addition & 213 deletions docs/design/overview/img/research/research-space-state-diagram.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Original file line number Diff line number Diff line change
Expand Up @@ -7,9 +7,8 @@ state ResearchSpace as "Research Space" {
SUBMITTED : Submitted for vault
ACCEPTED : Accepted for vault
REJECTED : Rejected for vault
SECURED : Secured in vault

[*] --> FOLDER : Create folder (WebDAV)
[*] --> FOLDER : Create folder
FOLDER --> LOCKED : Lock
FOLDER --> SUBMITTED : Submit
LOCKED --> FOLDER : Unlock
Expand All @@ -19,10 +18,7 @@ state ResearchSpace as "Research Space" {
SUBMITTED --> REJECTED : Reject
REJECTED --> LOCKED : Lock
REJECTED --> SUBMITTED : Submit
ACCEPTED --> SECURED : Secure
SECURED --> LOCKED : Lock
SECURED --> SUBMITTED : Submit
SECURED --> [*] : Delete folder (WebDAV)
ACCEPTED --> FOLDER : Secure
}

@enduml
4 changes: 2 additions & 2 deletions docs/design/processes/vault-process.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ IIFOLDERTRANSITIONS = list((FOLDER, LOCKED),
(REJECTED, LOCKED),
(REJECTED, FOLDER),
(REJECTED, SUBMITTED),
(ACCEPTED, SECURED),
(ACCEPTED, FOLDER),
(SECURED, LOCKED),
(SECURED, FOLDER),
(SECURED, SUBMITTED))
Expand All @@ -56,7 +56,7 @@ A research group without a datamanager can submit packages to the vault directly
submission.

## Copy to vault
The **retry-copy-to-vault.r** cronjob in the tools directory of the research ruleset will copy any folder with a 'PENDING' or 'RETRY' cronjob copy state to the vault and set it to 'SECURED' state when successful. In Yoda versions 1.9 or lower this is only done with folders with a 'RETRY' state. The copy uses `irsync` in versions 1.10 and higher. The metadata is copied as well. Folders with 'RETRY' status have previously failed to copy.
The **retry-copy-to-vault.r** cronjob in the tools directory of the research ruleset will copy any folder with a 'PENDING' or 'RETRY' cronjob copy state to the vault and set it to 'SECURED' state when successful. For Yoda version 1.10 or higher, the state will be set to 'FOLDER' upon success. In Yoda versions 1.9 or lower this is only done with folders with a 'RETRY' state. The copy uses `irsync` in versions 1.10 and higher. The metadata is copied as well. Folders with 'RETRY' status have previously failed to copy.

See [Copy to vault diagrams](copy-to-vault-diagrams.md) for diagrams of the copy to vault process.

Expand Down

0 comments on commit d8f34f8

Please sign in to comment.