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

Surface fixes for link validation errors #10024

Draft
wants to merge 3 commits into
base: main
Choose a base branch
from

Conversation

minhngocd
Copy link
Contributor

@minhngocd minhngocd commented Mar 5, 2025

Currently fixes for any link validation errors that prevents publishing and scheduling are silent. The user only sees a high level message that there was something wrong with the links and not how to go about fixing it. If we surface the fixes we may receive less support tasks to manage.

https://trello.com/c/zuRPc1sS/3504-unable-to-publish-whitehall-drafts-unclear-broken-links-state

The fixes are rendered as bullet points when surfaced to the user, and the URL seems a bit too long for the sidebar..

Screenshot 2025-03-06 at 12 05 55 Screenshot 2025-03-06 at 14 27 01

⚠️ This repo is Continuously Deployed: make sure you follow the guidance ⚠️

Follow these steps if you are doing a Rails upgrade.

@minhngocd minhngocd force-pushed the surface-link-check-error branch 3 times, most recently from 455c08f to c63bea4 Compare March 5, 2025 21:51
Copy link
Contributor

@lauraghiorghisor-tw lauraghiorghisor-tw left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM - unsure if it needs to run past a content person.

@minhngocd
Copy link
Contributor Author

Hmmmm good point. Adding some screen shots. It currently looks like so, which isn't very readable:

Screenshot 2025-03-06 at 11 59 48

Making them an array / bullet point is slightly better but stlil have loads of room for improvement. We need some content / frontend guidance here

Screenshot 2025-03-06 at 12 05 55

@minhngocd
Copy link
Contributor Author

Awaiting Content Guidance

@minhngocd minhngocd marked this pull request as draft March 6, 2025 12:14
Currently fixes for any link validation errors that prevents publishing and scheduling are silent. The user only sees a high level message that there was something wrong with the links and not how to go about fixing it. If we surface the fixes we may receive less support tasks to manage.
… points

Returning the fixes as a separate array item to be rendered as bullet points for readability in the sidebar
To mirror what is happening with Edition Publisher. Edition Publisher is publishing the errors as bullet points, whereas the Edition Scheduler is only returning one error message. With the introduction of fixes required for link validation, bullet points might help with readibility
@minhngocd minhngocd force-pushed the surface-link-check-error branch from c63bea4 to c1bd845 Compare March 6, 2025 14:19
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants