NCEAS / metacatui

MetacatUI: A client-side web interface for DataONE data repositories
https://nceas.github.io/metacatui
Apache License 2.0
42 stars 26 forks source link

Clarify the publication workflow #2205

Open robyngit opened 10 months ago

robyngit commented 10 months ago

We need to refine and make the publication workflow more intuitive for MetacatUI users. Along with making the publication process more explicit and user-friendly, we should also allow each repository to customize their own workflow to reflect their publishing process and suit the needs of their community.

For example, as @mbjones suggested, the ADC's publication workflow would involve the following steps:

graph LR
    A[Start submission] --> B[Save drafts]
    B --> C[MetaDIG checks]
    C --> D[Submit for review]
    D --> E[Curator/PI save revisions]
    E --> F[Approval]
    F --> G[Publish with DOI]

Clarifying the publication workflow will likely comprise multiple smaller tasks and issues. This overarching issue serves as the initial platform to kickstart the discussion on the necessary changes and improvements. Some points to consider include: How can we visually represent the workflow in the UI in a way that is intuitive to users? How will the workflow differ between repos? How can they customize and extend the workflow?

Any and all feedback welcome!

Related issues

Some of these should be tackled in the course of this work.

robyngit commented 10 months ago

From https://github.com/NCEAS/metacatui/issues/1380#issuecomment-1767194626

Some quick thoughts on lifecycle representation in the app for discussion...

stateDiagram-v2
    [*] --> Draft: New
    Draft --> Draft: Save
    Draft --> [*]: Delete
    review : In review
    rev_request: Review requested
    Draft --> rev_request: Review
    rev_request --> review: StartReview
    review --> Draft: RequestRevision
    review --> Approved: Approve
    Approved --> Published: Publish
    Published --> Draft: Edit
    Published --> [*]
mbjones commented 7 months ago

Comment from an Arctic Data Center user today, which highlight the need to clarify "Save" versus "Submit" conceptually:

I was in the process of uploading a data set and didn't realize that the save dataset button was to submit the dataset rather than save my progress. Is there a way to edit or take down my dataset that was submitted? Or do I just wait for it to not be approved and resubmit it?