Add check-external-links command

owenatgov commented 1 month ago

Change

Adds a check-external-links npm script as an offshoot of check-links, creates a manual workflow for it and attempts to fix some initially reported broken links.

This is a reimplementation of https://github.com/alphagov/govuk-design-system/pull/3174 as a separate command. It's inadvisable to include this as a default part of our testing suite because:

it takes a long long time to run, roughly 7 minutes
it reports on things that aren't actually failues such as links that aren't redirecting or broken but maybe just return unclean responses or some assets that are intentionally not proper links
it could raise test failures for PRs that have nothing to do with that PR's change

However a separate comamnd we can run mean we have this tool that we can interpret whenever we want.

An early draft of this PR included the script in our default test suite in order to capture our current broken links. See the original test output of check-external-links here.

The check additionally flagged broken links in our component docs which I've actioned in https://github.com/alphagov/govuk-frontend/pull/5428

Controversial content updates

A few of the content changes I've chosen to make probably need further discussion. I'll note the tricky ones or lingering problems here:

In the accessibility statement, we originally linked to the tec docs gem and its accessibility statement, however the website for the library has been taken down. I've instead linked to the github repo and the file in the repo for the statement since its not listed anywhere online.
In the code of conduct pages, we link to what was a community policy for Practical Service Design's slack space. However, it looks like Practical are shutting down and have started removing pages, including this one. I've tried to remedy this by removing the link to them entirely.
In the footer component, we originally link to a service manual page on publishing info about your services accessibility to help users with adding an accessibility statement. However that page now redirects to info on wcag 2.2. I've tried to remedy this by instead linking to the sample accessibility statement.
On the create accounts and national insurance numbers patterns, we had a duplicate section on not using NI numbers as credentials, linking to a section in a service manual page as evidence. That section has now gone from that page. I couldn't find alternative content to fill the gap so I've removed both those sections.
On the password input component in the section on not using the spellcheck attribute we mentioned 'spell-jacking'. The page we link to for this is a 404. In fact, it looks like Otto js has completely removed their news section. I tried looking for an alternative but wasn't confident in my choices. I've aleviated this by removing the link entirely.

netlify[bot] commented 1 month ago

You can preview this change here:

Name	Link
Latest commit	a66ac71f6dfde7989b5c6926ab285a6b165852bc
Latest deploy log	https://app.netlify.com/sites/govuk-design-system-preview/deploys/6718b51820300f0008242386
Deploy Preview	https://deploy-preview-4235--govuk-design-system-preview.netlify.app
Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

netlify[bot] commented 1 month ago

You can preview this change here:

Name	Link
Latest commit	d346675c34c48f08d63d012e28210dd689d778be
Latest deploy log	https://app.netlify.com/sites/govuk-design-system-preview/deploys/673da6f567da480009f77bf9
Deploy Preview	https://deploy-preview-4235--govuk-design-system-preview.netlify.app
Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

alphagov / govuk-design-system