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 character count accessibility tests page #2607

Merged
merged 26 commits into from
May 15, 2024

Conversation

amyleadem
Copy link
Contributor

@amyleadem amyleadem commented Apr 8, 2024

Summary

  • Added character count accessibility tests page.
  • Added a bottom margin to the WCAG compliance tag. This allowed for more visual separation from the known issues alert. It should not have any affect on the spacing for pages without the known issues alert.
  • Updated the component name assignment in a11y-note.html and test-results-summary.html. Before, the includes pulled the page.component.name, which at times is the component slug and includes dashes. Now, they pull the page title.
  • Added the word "component" to the bolded copy in a11y-note.html. This changed the text "Test the character count in your own project." to "Test the character count component in your own project."

Important

We need to confirm the changelog dates before merge.

Important

This PR is based off the changes from USWDS-Site - Accessibility tests: Rename accessibility.md files (#2581). We should wait to merge this until #2581 is merged into main.

Resources

Related issue

Closes #2532

Preview link

Testing and review

  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 bottom margin looks good on the compliance tag.
  3. Confirm that the main component page links to the accessibility tests page in the side navigation.
  4. Check that accessibility tests page provides the correct counts for each test status type.
  5. Confirm the test checklist summaries and data are accurate.
  6. Confirm no visual issues.
  7. Confirm there is an appropriate changelog entry on both the main component page and the accessibility tests page.
  8. Confirm the note in the accessibility guidance section of the main component page uses the correct component name ("character count" and not "character-count")

@amyleadem amyleadem changed the title Al a11y tests character count USWDS-Site: Add character count accessibility tests page Apr 8, 2024
@amyleadem amyleadem changed the base branch from main to al-a11y-tests-rename-files April 8, 2024 20:28
@amyleadem amyleadem marked this pull request as ready for review April 8, 2024 20:45
Copy link
Contributor Author

@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.

@sarah-sch @finekatie @amycole501 @alex-hull
This is ready for your review. From my perspective, we'll only need review from one person in each discipline, but welcome everyone's feedback if more folks want to review.

I had a some open questions below. Can you take a look and let me know what you think?

Thanks for prepping these summaries in the spreadsheet! Building the page was much quicker and easier this time 😎.

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

I approve. I did comment on the two spots where you tagged me and/or Sarah. I'm not approving yet because I don't know if you need more feedback from me, but will when you're ready!

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.

Took a look through your changes and made a few notes. Let me know if you need any more clarification on any comments made! @amyleadem

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.

@amyleadem - One important note: In several places, we are plugging in "character count accessibility tests" where it should read just "character count." (E.g., see the first three H2s on the page ... there are other places as well.) I'm assuming this just needs to be switched in one place that's getting plugged in throughout the page.

Leaving a few comments, too. I will bo OOO tomorrow, so if you are trying to publish before that I trust you and the team to address the feedback without me needing to review again.

_data/accessibility-tests/character-count.yml Outdated Show resolved Hide resolved
_includes/accessibility-tests/a11y-note.html Outdated Show resolved Hide resolved
_data/accessibility-tests/character-count.yml Outdated Show resolved Hide resolved
_data/accessibility-tests/character-count.yml Show resolved Hide resolved
@amyleadem
Copy link
Contributor Author

@amycole501 @alex-hull @sarah-sch @finekatie

This is ready for your re-review. Please let me know if you have any questions or comments.

Copy link

@amycole501 amycole501 left a comment

Choose a reason for hiding this comment

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

The page reads well, I have one suggestion to add a success criteria check but can do that after the page is posted.

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.

Added changes look good

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.

Just noting that we are still repeating "character count accessibility tests" programmatically where we should be using something along the lines of "character count" of "character count component. Other than this issue, which I assume will be fixed programmatically, the pages look good.

@@ -2,6 +2,11 @@ title: Character count
type: component
changelogURL:
items:
- date: 2024-04-18
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Important

We should confirm the changelog dates before merge

@amyleadem
Copy link
Contributor Author

Just noting that we are still repeating "character count accessibility tests" programmatically where we should be using something along the lines of "character count" of "character count component. Other than this issue, which I assume will be fixed programmatically, the pages look good.

@sarah-sch Thanks for flagging this. I updated the component name in b1bbca8. This should resolve the issue you are seeing.

@sarah-sch
Copy link
Contributor

Just noting that we are still repeating "character count accessibility tests" programmatically where we should be using something along the lines of "character count" of "character count component. Other than this issue, which I assume will be fixed programmatically, the pages look good.

@sarah-sch Thanks for flagging this. I updated the component name in b1bbca8. This should resolve the issue you are seeing.

Looks great now, @amyleadem!

@amyleadem amyleadem requested a review from mejiaj April 18, 2024 14:20
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.

Component page and new page looks good. Small requests for indentation fixes.

Also questions on the use of snake case vs camel case, but this isn't a blocker for getting page published.

_components/character-count/character-count.md Outdated Show resolved Hide resolved
_includes/accessibility-tests/a11y-note.html Show resolved Hide resolved
_includes/accessibility-tests/a11y-note.html Show resolved Hide resolved
Co-authored-by: James Mejia <james.mejia@gsa.gov>
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.

Approving, but there seem to be new HTMLProofer errors.

For the Links > External check, the following failures were found:

* At ./_site/next/introduction/index.html:429:

  External link https://www.pewresearch.org/politics/2020/09/14/americans-views-of-government-low-trust-but-some-positive-performance-ratings/ failed (status code 404)

* At ./_site/patterns/create-a-user-profile/race-and-ethnicity/index.html:3150:

  External link https://www.pewresearch.org/fact-tank/2022/09/15/who-is-hispanic/ failed (status code 404)


HTML-Proofer found 2 failures!

Exited with code exit status 1

Source →

@amyleadem
Copy link
Contributor Author

amyleadem commented Apr 18, 2024

@mejiaj

Thanks for flagging that error. Based on some quick googling, it looks like the site flagged in HTML-proofer should probably be live. The Pew Research center just tweeted a link to the now-broken site an hour ago. I'm guessing it is an unexpected outage.

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.

PR and site looks great! Just two questions about potentially updating the process doc and checklist spreadsheet 👍

name: character count
title: Character count accessibility tests
category: Components
lead: Any USWDS character count component should pass these manual accessibility tests.
Copy link
Contributor

Choose a reason for hiding this comment

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

I like the addition of "component here" as well. I went ahead and added it to the process doc for this section.

It looks like other accessibility test pages just say the component name here. Should we include this change in #2581 since all of the accessibility test pages are changed there?

ex:

lead: Any USWDS button should pass these manual accessibility tests.

_data/accessibility-tests/character-count.yml Show resolved Hide resolved
@amyleadem amyleadem changed the base branch from al-a11y-tests-rename-files to main April 18, 2024 15:32
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...

@thisisdano
Copy link
Member

Merging over pa11y crash

@thisisdano thisisdano merged commit 98cfff2 into main May 15, 2024
8 of 11 checks passed
@thisisdano thisisdano deleted the al-a11y-tests-character-count branch May 15, 2024 21:36
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.

CC a11y: publish Character Count checklist - create PR
8 participants