Skip to content

Conversation

@mahoneycm
Copy link
Contributor

@mahoneycm mahoneycm commented Apr 5, 2024

Summary

Updated treasury.gov and digital.gov links. Now, links no longer redirect or cause htmlproofer errors.

Important

We should confirm the changelog date in _data/changelogs/docs-sample-contract-language.yml before merge.

Related issue

Closes #2603

Preview link

Showcase page →

Note

Not a user facing change due to redirect already bringing users here. Opted to not create a changelog for showcase.

Sample contract language page →

Problem statement

HTMLProofer flagged two new issues caused by the target pages updating. The treasury.gov error was caused by a redirect to home.treasure.gov while the digital.gov link was caused by the hash target no longer existing.

Solution

Update links to reflect the current state of their target pages.

Old link new link
https://treasury.gov https://home.treasury.gov/
https://digital.gov/resources/federal-web-council/#current-council-members https://digital.gov/resources/an-introduction-to-the-digital-experience-council/#who-makes-up-the-digital-experience-council

Testing and review

  1. Confirm links work.
  2. Confirm there are no additional redirects.
  3. Confirm digital.gov hash link takes you to the appropriate heading.
  4. Running npm run proof does not flag any errors.
  5. Changelog is meaningful and accurate.

Copy link
Contributor

@finekatie finekatie left a comment

Choose a reason for hiding this comment

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

Links look good!

Would love to have convo about change log. I did an audit of the page months ago. We have another PR out there for this page for three other link fixes, so this is good timing.

Copy link
Contributor

@amyleadem amyleadem left a comment

Choose a reason for hiding this comment

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

LGTM! Confirmed the updated links and ran npm run proof without error

@amyleadem
Copy link
Contributor

amyleadem commented Apr 5, 2024

Also, it would be helpful to include "HTML proofer" in the title of the issue - it should help with understanding the importance of the issue at a glance.

@mahoneycm mahoneycm changed the title USWDS-Site - Links: Update link to target redirects USWDS-Site - HTMLProofer: Update link to target redirects Apr 5, 2024
@mahoneycm mahoneycm changed the title USWDS-Site - HTMLProofer: Update link to target redirects USWDS-Site - HTMLProofer: Update links to target redirects Apr 5, 2024
Copy link
Contributor

@mejiaj mejiaj left a comment

Choose a reason for hiding this comment

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

Looks good, new links work as expected.

changelogURL:
items:
- date: NNNN-NN-NN
- date: 2024-03-29
Copy link
Contributor

@amyleadem amyleadem Apr 9, 2024

Choose a reason for hiding this comment

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

Note

We neglected to update this date when we merged USWDS-Site - Accessibility page: Replace content #2561. It should not be updated to match the merge date of this PR.

@mejiaj mejiaj merged commit d6243c1 into main Apr 10, 2024
@mejiaj mejiaj deleted the cm-update-links-april-2024 branch April 10, 2024 19:38
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.

USWDS-Site - Bug: HTML-Proofer errors April '24

5 participants