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

USWDS-Site - Add list accessibility tests page #2746

Merged
merged 15 commits into from
Aug 13, 2024

Conversation

RachelCorsino
Copy link
Contributor

@RachelCorsino RachelCorsino commented Jul 9, 2024

Summary

Added accessibility tests page for the list component.

Related issue

Closes #2727

Preview link

Preview link - [/components/list/accessibility-tests]

Testing and review

Follow these steps:

  1. Confirm that both the main component page and the accessibility tests page have the correct compliance tag at the top.
  2. Confirm that the main component page links to the accessibility tests page in the side navigation.
  3. Confirm that the main component page links to the accessibility tests page from the accessibility guidance section.
  4. Confirm that the main component page shows the accessibility tests summary.
  5. Check that accessibility tests page provides the correct counts for each test status type.
  6. Confirm the test checklist summaries and data are accurate.
  7. Confirm no visual issues.
  8. Confirm there is an appropriate changelog entry on both the main component page and the accessibility tests page.

@RachelCorsino RachelCorsino changed the title USWDS-Site - Page: Updated usa-list checklist items USWDS-Site - Add list accessibility tests page Jul 10, 2024
@RachelCorsino RachelCorsino marked this pull request as ready for review July 10, 2024 21:40
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.

@RachelCorsino thanks for creating this! I can confirm the page works and looks as expected. I updated the PR description preview link so it goes to the new page.

Add a minor comment about updating the date before final review/merge, otherwise LGTM.

_data/changelogs/component-list.yml Outdated Show resolved Hide resolved
_data/changelogs/component-list-accessibility.yml Outdated Show resolved Hide resolved
@mejiaj mejiaj requested a review from amyleadem July 15, 2024 16:11
Copy link
Contributor

@mahoneycm mahoneycm left a comment

Choose a reason for hiding this comment

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

Great work on this @RachelCorsino ! It's looking great. Kudos on the changelogs as well! I left a note to update those once this is approved to be merged but you won't have to worry about that right now.

Requesting two small changes to resolve some visual discrepancies.

title: List accessibility tests
type: component
items:
- date: 2024-07-08
Copy link
Contributor

Choose a reason for hiding this comment

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

todo: We'll want to update this date to the date that the PR will be merged once it's approved.

_data/accessibility-tests/list.yml Outdated Show resolved Hide resolved
@@ -2,6 +2,11 @@ title: List
type: component
changelogURL:
items:
- date: 2024-07-08
Copy link
Contributor

Choose a reason for hiding this comment

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

todo: We'll want to update this date to the date that the PR will be merged once it's approved.

_data/accessibility-tests/link.yml Outdated Show resolved Hide resolved
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.

@RachelCorsino Looks really good! Thanks for taking this on.

I've added some small notes and questions below (Some of them will need to be answered by @alex-hull and @amycole501). Let me know if you have any questions.

_data/accessibility-tests/list.yml Outdated Show resolved Hide resolved
_data/accessibility-tests/list.yml Outdated Show resolved Hide resolved
_data/accessibility-tests/list.yml Outdated Show resolved Hide resolved
_data/accessibility-tests/list.yml Outdated Show resolved Hide resolved
_data/accessibility-tests/list.yml Outdated Show resolved Hide resolved
@RachelCorsino
Copy link
Contributor Author

All fixes have been made and PR should be ready to go now!

This PR is not passing all test due to Snyk alert issue, which as been fixed in the following PR: USWDS-Site: Updates Snyk Alerts #2751

mahoneycm

This comment was marked as outdated.

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.

Thanks for the quick fixes, @RachelCorsino. I found one more reference to 3.6.1 that should be updated. I've added a suggestion in the comment below.

Other than that, just waiting to hear back from the accessibility team about the 2.4.6 checklist item.

Looking good!

_data/accessibility-tests/list.yml Outdated Show resolved Hide resolved
@mahoneycm
Copy link
Contributor

List "Accessibility Guidance" section

After re-reviewing, I remembered that we added the "accessibility guidance" section to the Prose component page in order to display the accessibility page callout section.

image

For consistency, it's probably a good idea to add it here too.

I was able to do this by creating a _components/prose/guidance/accessibility.md file with just a comment to auto-generate the section. (Commit for reference)

<!-- Comment to avoid null content so the accessibility test section populates -->

@mahoneycm mahoneycm self-requested a review July 15, 2024 21:07
@RachelCorsino
Copy link
Contributor Author

Resolved in 25bc6e4

List "Accessibility Guidance" section

After re-reviewing, I remembered that we added the "accessibility guidance" section to the Prose component page in order to display the accessibility page callout section.

image

For consistency, it's probably a good idea to add it here too.

I was able to do this by creating a _components/prose/guidance/accessibility.md file with just a comment to auto-generate the section. (Commit for reference)

<!-- Comment to avoid null content so the accessibility test section populates -->

Copy link
Contributor

@mahoneycm mahoneycm left a comment

Choose a reason for hiding this comment

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

Looks great! Thanks Rachel 🎉

@mejiaj mejiaj requested a review from amyleadem July 17, 2024 17:12
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.

Looks good! Thanks for your work on this @RachelCorsino.

Copy link

@alex-hull alex-hull 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! Approved on my end.

Copy link
Member

@thisisdano thisisdano left a comment

Choose a reason for hiding this comment

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

Updating changelog dates

_data/changelogs/component-list-accessibility.yml Outdated Show resolved Hide resolved
_data/changelogs/component-list.yml Outdated Show resolved Hide resolved
@thisisdano thisisdano merged commit 9cd6373 into main Aug 13, 2024
11 checks passed
@thisisdano thisisdano deleted the rc-publish-list-checklist-items branch August 13, 2024 17:05
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 - CC a11y: publish usa-list checklist items
7 participants