department-of-veterans-affairs / va.gov-cms

Editor-centered management for Veteran-centered content.
https://prod.cms.va.gov
GNU General Public License v2.0
99 stars 69 forks source link

Surface broken links in a way that helps editors find and repair them #8230

Open rachel-kauff opened 2 years ago

rachel-kauff commented 2 years ago

Background

Currently the only way editors know about broken links is the link checkers on individual nodes. Problems with this:

User Story or Problem Statement

<As a , I need so I can _____.>

or

<Problem description. How might we _____ ?>

Affected users and stakeholders

Hypothesis (TBD)

Ideas

We believe that _thissolution will achieve _thisoutcome. We'll know that to be true when this measurable outcome occurs.

Assumptions

(How will these assumptions be validated?)

Acceptance Criteria

Change management triage

The change represented by this user story will:

swirtSJW commented 2 years ago

We now have machine readable broken link data that could be used to surface broken links either through a dashboard or notifications. https://s3-us-gov-west-1.amazonaws.com/vetsgov-website-builds-s3-upload/broken-link-reports/vagovprod-broken-links.json

ContentBrewmaster commented 2 years ago

Added epic sections including change management section with suggested value.

ContentBrewmaster commented 2 years ago

@EWashb wanted to confirm the status for this work for Q3?

EWashb commented 1 year ago

We need to refine this epic for the current state.

How might we put in the appropriate limits in real-time for editors so that they can fix broken links as they happen and prevent one editor from breaking content build with a broken link.

EWashb commented 1 year ago

How might we provide real-time error messaging so that folks can fix their broken links BEFORE save (real-time validation). Also, how do we allow folks who may need to link to a page that does exist quite yet but will undoubtedly show a broken link until they do? For example, someone is making multiple pages at once that cross reference, but they would only be live pages publishing on the same day. One might show a broken link since the page doesn't exist yet.

EWashb commented 1 year ago

Related to #6008