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

improve messaging for ingest failures, file upload #8096 #8271

Merged
merged 11 commits into from
Jan 5, 2022

Conversation

pdurbin
Copy link
Member

@pdurbin pdurbin commented Dec 2, 2021

What this PR does / why we need it:

We are trying to soften the messaging around ingest to prevent support tickets. This pull request also improves the messaging on file upload, especially with regard to limits and providing links to information in the guides about tabular ingest.

Which issue(s) this PR closes:

Special notes for your reviewer:

None.

Suggestions on how to test this:

See release note.

Does this PR introduce a user interface change? If mockups are available, please link/include them here:

Add files on create

Screen Shot 2021-12-14 at 3 31 09 PM

Add files on edit

Screen Shot 2022-01-04 at 2 00 24 PM

Improved "failed ingest" messaging (dataset page)

Screen Shot 2021-12-02 at 3 58 55 PM

Tooltip behavior (greyed out, dark on hover, popup on click)

Screen Shot 2021-12-02 at 3 59 49 PM
Screen Shot 2021-12-02 at 3 59 57 PM
Screen Shot 2021-12-02 at 3 59 39 PM

Improved "failed ingest" messaging (file page)

Screen Shot 2021-12-03 at 8 18 43 AM

Email: success only

Screen Shot 2021-12-16 at 12 24 55 PM

Email: failure only

Screen Shot 2021-12-16 at 12 25 51 PM

Email: mix of failure and success (as of 55d5ac0 looks same as "failure only")

Screen Shot 2021-12-16 at 12 27 16 PM

In-app notification: success

Screen Shot 2021-12-13 at 2 11 30 PM

In-app notification: failure only or mix of failure and success

Screen Shot 2021-12-13 at 2 11 49 PM

Add files on edit (dual mode and public only install)

This screenshot is last but relates to the "add files on edit" screenshot above. As part of this pull request, the "Multiple file upload/download methods are available for this dataset" message has been moved to under the "Files" tab (and is now plain text rather than being in a blue info box). The yellow info message "Files are stored on a publicly accessible storage server. – " has not been changed.

Screen Shot 2022-01-04 at 2 02 48 PM

Is there a release notes update needed for this change?:

Included.

Additional documentation:

Included.

@pdurbin pdurbin self-assigned this Dec 2, 2021
@pdurbin pdurbin removed their assignment Dec 6, 2021
@pdurbin pdurbin force-pushed the 8096-8205-ingest-messaging branch from a3d99bd to 94c834d Compare December 13, 2021 20:01
Note that when you upload a mix of files that go through ingest
and some succeed and some fail, the failure message is sent.
- Only list files that failed ingest.
- Remove "(Error)" from next to file name.
- Change "file(s)" to "files".
- Remove "Dataverse" to avoid having to say "Dataverse Software".
@pdurbin pdurbin force-pushed the 8096-8205-ingest-messaging branch from 55d5ac0 to 3b1e71b Compare December 14, 2021 19:50
@coveralls
Copy link

coveralls commented Dec 14, 2021

Coverage Status

Coverage decreased (-0.007%) to 18.918% when pulling 5d9a0dd on 8096-8205-ingest-messaging into b38ecf0 on develop.

@pdurbin pdurbin marked this pull request as ready for review December 14, 2021 21:00
@pdurbin pdurbin changed the title improve messaging for ingest failures #8096 improve messaging for ingest failures, file upload #8096 Dec 14, 2021
@pdurbin pdurbin self-assigned this Dec 15, 2021
We decided the "dataset management" page has more context.

Previously, the standard guides server base URL and "latest" was hard coded.
@pdurbin pdurbin removed their assignment Dec 15, 2021
- rewrite sentence for .tab
- link to "the guides" not "see the guides"
- only have the last link (to "the guides")
@pdurbin
Copy link
Member Author

pdurbin commented Dec 16, 2021

@TaniaSchlatter @jggautier and I met this morning and in 5d9a0dd I just made the changes we talked about. I also updated the screenshots above.

This pull request is ready for review so I moved it over.

@TaniaSchlatter
Copy link
Member

Thanks for the screenshots @pdurbin. All looks good, and I wonder if we can have the text that appears in the top of page in the info alert message on the edit page can appear as text in the File upload page instead. If we are not providing new or contextual info in the top of page message, there is not a reason to have it appear as an info alert.

@pdurbin pdurbin assigned pdurbin and unassigned sekmiller Jan 3, 2022
@pdurbin
Copy link
Member Author

pdurbin commented Jan 4, 2022

@TaniaSchlatter and I just talked through moving text from the blue info alert to inline text. Implemented in a2be27b and I updated the screenshot above. I'm moving this back into review.

@pdurbin pdurbin removed their assignment Jan 4, 2022
@TaniaSchlatter
Copy link
Member

Looks good! Thanks @pdurbin.

@sekmiller sekmiller self-assigned this Jan 4, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment