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

Remove broken links from Showcase page and correct spelling #2586

Merged
merged 7 commits into from
Apr 26, 2024

Conversation

finekatie
Copy link
Contributor

@finekatie finekatie commented Mar 29, 2024

Summary

Remove broken links that have no alternate for redirects. Correct misspelling that Siteimprove noted. Will improve QA on site.

Related issue #2567

Also related to: #2346 and #2407

Closes #2567

Preview link

Showcase page

Problem statement

Broken links and misspelling on this page contributes to drop in QA.

Solution

Removing old broken links and correcting spelling will improve content relevancy and QA.

Changes

https://datacenters.cio.gov/ remove
https://feedback.usa.gov/ remove
https://itmodernization.cio.gov/ remove
https://www.move.mil/ remove
http://vsfs.state.gov/ remove

Testing and review

Will need to have someone review to make sure links and copy are gone and that spelling is correct.

Check that changelog is implemented correctly and the content is correct.

Remove broken links that have no alternate for redirects. Will improve QA on site.
Removed another link
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.

@finekatie only found references for move.mil on a blog post. The rest don't appear anywhere.

@@ -93,7 +91,6 @@ If your project is currently using USWDS and you would like to see it included i
- [Manufacturing USA](https://www.manufacturing.gov/)
- [Medicaid](https://www.medicaid.gov/)
- [Method Cards - 18F](https://methods.18f.gov/)
- [Move.mil — Official DOD Moving Portal](https://www.move.mil/)
Copy link
Contributor

Choose a reason for hiding this comment

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

This URL appears in _posts/2018-03-22-dds-case-study.md.

Live preview
How the Defense Digital Service uses USWDS for a Ruby app | U.S. Web Design System (USWDS).

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Thank you James. We'll address that page and work to be done in another issue and PR when we go to clean up old blog pages.

@@ -93,7 +91,6 @@ If your project is currently using USWDS and you would like to see it included i
- [Manufacturing USA](https://www.manufacturing.gov/)
- [Medicaid](https://www.medicaid.gov/)
- [Method Cards - 18F](https://methods.18f.gov/)
- [Move.mil — Official DOD Moving Portal](https://www.move.mil/)
- [MyMedicare](https://www.mymedicare.gov/)
- [NASA General Coordinates Network (GCN)](https://gcn.nasa.gov)
- [NASA Glenn Research Center](https://www1.grc.nasa.gov)
Copy link
Contributor

Choose a reason for hiding this comment

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

@finekatie - while we're updating the page can we also correct the spelling of "Satellite" in "National Environmental Sattelite Data and Information Service (NOAA)" (This issue was also flagged in the Siteimprove report.)

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Hey there, @sarah-sch , I can, but since this isn't a broken link, do I need to update the Issue, etc.?

Copy link
Contributor

Choose a reason for hiding this comment

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

Discussed with @finekatie on 4/2 and updated issue

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Corrected the misspelling. This is ready for review and approval.

Copy link
Contributor

Choose a reason for hiding this comment

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

Confirming this is fixed in 64f6c0c.

@sarah-sch sarah-sch changed the title Remove broken links from Showcase page Remove broken links from Showcase page and correct spelling Apr 2, 2024
Corrected spelling on one of the site names.
Copy link
Contributor

@sarah-sch sarah-sch 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!

@mejiaj
Copy link
Contributor

mejiaj commented Apr 2, 2024

@finekatie I've updated the labels in the original issue. Also confirming there aren't any test errors.

@mahoneycm
Copy link
Contributor

mahoneycm commented Apr 5, 2024

It looks like we've added changelogs for removed links before. Should we add a changelog to the showcase page? There currently isn't a changelog section for this page. Happy to create if we decide we want one!

Example: About research page

@finekatie
Copy link
Contributor Author

It looks like we've added changelogs for removed links before. Should we add a changelog to the showcase page? There currently isn't a changelog section for this page. Happy to create if we decide we want one!

Example: About research page

Hi Charlie! We are talking about this as I write this. In favor of a changelog. Thank you!

Comment on lines 1 to 10
title: Showcase
type: documentation
changelogURL:
items:
- date: NNNN-NN-NN
summary: Remove broken links that have no alternate for redirects.
summaryAdditional: Correct misspelling that Siteimprove noted.
affectsGuidance: true
githubPr: 2586
githubRepo: uswds-site
Copy link
Contributor

Choose a reason for hiding this comment

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

Created changelog

After discussing with the team, we decided to add a changelog and keep track of larger changes such as addition and removal of links.

@finekatie
Copy link
Contributor Author

Hey @mahoneycm , are you able to take a look at this? Looks like checks are failing even though Dan approved.

@finekatie finekatie requested a review from mahoneycm April 26, 2024 18:08
Let's now link to the newer Digital Experience Council
@thisisdano
Copy link
Member

@finekatie I'm on it. We needed to update another broken link

@thisisdano
Copy link
Member

Merging over unrelated pa11y crash

@thisisdano thisisdano merged commit 64a2ce7 into main Apr 26, 2024
9 of 11 checks passed
@thisisdano thisisdano deleted the kf-showcase-linkremoval branch April 26, 2024 20:08
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.

Showcase Links: Update/Remove Broken Links
5 participants