Skip to content

Commit

Permalink
Adding a mermaid diagram of the wizard flow (#1809)
Browse files Browse the repository at this point in the history
Shows the different controllers and how they connect together

Co-authored-by: Hector Correa <[email protected]>
  • Loading branch information
carolyncole and hectorcorrea authored May 10, 2024
1 parent f2b37ab commit f92aab2
Showing 1 changed file with 45 additions and 0 deletions.
45 changes: 45 additions & 0 deletions docs/wizard_flow.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
```mermaid
flowchart TD
subgraph UsersController
user_show[show]
end
subgraph WizardPolicyController
show -- user accepts policy --> update
show -- User cancels --> user_show
end
update --> new_submission
subgraph WizardNewSubmissionController
new_submission -- user submits form --> new_submission_save
new_submission -- User cancels --> user_show
end
new_submission --> edit_wizard
subgraph WorksWizardController
edit_wizard -- user submits metadata --> update_wizard
edit_wizard -- User cancels --> user_show
edit_wizard -- User saves --> edit_wizard
update_wizard --> update_additional
readme_select -- User uploads Readme --> readme_uploaded
readme_select -- User cancels --> user_show
readme_select -- User saves --> readme_select
readme_uploaded --> attachment_select
attachment_select --> attachment_selected{Large Files?}
attachment_selected -->|Yes| file_other
attachment_selected -->|No| file_upload
file_other -- User notes file location --> review
file_other -- User cancels --> user_show
file_other -- User saves --> file_other
file_upload -- User uploads Attachments --> review
file_upload -- User cancels --> user_show
file_upload -- User saves --> file_upload
review -- User Submits work as complete --> validate
review -- User cancels --> user_show
review -- User saves --> review
end
subgraph WorksUpdateAdditionalController
update_additional-- user submits form --> update_additional_save
update_additional_save -- User cancels --> user_show
update_additional_save -- User saves --> update_additional_save
update_additional_save --> readme_select
end
```

0 comments on commit f92aab2

Please sign in to comment.