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 - Accessibility tests: Publish Prose checklist page #2613

Merged
merged 18 commits into from
May 15, 2024

Conversation

mahoneycm
Copy link
Contributor

@mahoneycm mahoneycm commented Apr 12, 2024

Summary

Created Prose accessibility checklist following the provided guidance (🔒)

Important

We should update the changelog dates before merge.

Note

We don't currently provide guidance on how to adjust text spacing. Until we do, we've opted to remove item 1.4.12 from the site testing checklist and rely on 1.4.4 to cover this test.
Additional information can be found in this comment thread

Related issue

Closes #2531

Preview link

Prose component page →

Prose accessibility checklist →

Major changes

  • Prose accessibility page published.
  • Prose sidenav updated.
  • Accessibility section added to Prose component page add testing alert.
  • WCAG details created for 3.1.5 AAA criterion

Accessibility guidance section

I added a comment to the usa-prose/guidance/accessibility.md file so that it doesn’t render as null and it properly adds the testing alert.

Is this a pattern we want to follow for pages without other accessibility guidance?

image

Testing and review

  1. Confirm links to testing page work and follow the correct path pattern
  2. Confirm content in checklist matches critical checklist spreadsheet
    • The item for text-spacing had content as it's test type. Confirm using general is appropriate here
  3. Confirm WCAG links take users to correct WCAG criterion
  4. Confirm accessibility checklist markdown follows existing pattern
  5. Confirm we want the newly generated accessibility guidance section on the component page without any additional accessibility guidance

@mahoneycm mahoneycm marked this pull request as ready for review April 12, 2024 18:59
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.

Looking good! I had some questions and comments below. Let me know if you have an questions.

_data/accessibility-tests/prose.yml Outdated Show resolved Hide resolved
_data/accessibility-tests/prose.yml Outdated Show resolved Hide resolved
_data/accessibility-tests/prose.yml Outdated Show resolved Hide resolved
_includes/accessibility-tests/wcag-details.html Outdated Show resolved Hide resolved
_data/accessibility-tests/prose.yml Outdated Show resolved Hide resolved
_components/prose/guidance/accessibility.md Outdated Show resolved Hide resolved
_components/prose/guidance/accessibility.md Outdated Show resolved Hide resolved
_data/accessibility-tests/prose.yml Outdated Show resolved Hide resolved
@amyleadem amyleadem changed the title USWDS - Accessibility tests: Publish Prose checklist page USWDS-Site - Accessibility tests: Publish Prose checklist page Apr 15, 2024
mahoneycm and others added 6 commits April 15, 2024 17:02
Co-authored-by: Amy Leadem <93996430+amyleadem@users.noreply.github.com>
Co-authored-by: Amy Leadem <93996430+amyleadem@users.noreply.github.com>
Co-authored-by: Amy Leadem <93996430+amyleadem@users.noreply.github.com>
Co-authored-by: Amy Leadem <93996430+amyleadem@users.noreply.github.com>
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.

The page looks good to me.

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 didn't find any errors or issues. Looks good!

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 to me! I confirmed the following:

  • Confirm that both the main component page and the accessibility tests page have the correct compliance tag at the top.
  • Confirm that the main component page links to the accessibility tests page in the side navigation.
  • Check that accessibility tests page provides the correct counts for each test status type.
  • Confirm the test checklist summaries and data are accurate.
  • Confirm there is an appropriate changelog entry on both the main component page and the accessibility tests page.
  • Confirm the note in the accessibility guidance section of the main component page uses the correct component name

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.

Pages good, aside from changelog dates.

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-prose.yml Outdated Show resolved Hide resolved
@thisisdano
Copy link
Member

Merging over pa11y crashes

@thisisdano thisisdano merged commit 8acb3cd into main May 15, 2024
8 of 11 checks passed
@thisisdano thisisdano deleted the cm-a11y-checklist-prose branch May 15, 2024 21:57
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 Prose checklist - create PR
6 participants