USWDS-Site: Add known issues to component pages by amyleadem · Pull Request #2402 · uswds/uswds-site

amyleadem · 2023-12-19T16:51:35Z

Summary

Added known issues to component pages.
Updated the data keys to use snake case instead of camel case

The known issues were listed in the Moving from usability test findings to issues/actions document. (Google doc 🔒)

Note

Build issues fixed in 0d4cbe5.

Related issue

Closes #2375

Preview link

Problem statement

Add the known issues listed in the Moving from usability test findings to issues/actions document. (Google doc 🔒)

Testing and review

All issues in the Moving from usability test findings to issues/actions doc are included in the known issues section of component pages.
Alert appears as expected on the top of each page that has known issues.
The link in the alert works.
In the "All known issues for [component name] are tracked in GitHub." copy:
1. Confirm that the GitHub link points to a list of issues tagged with the appropriate "package" label.
2. Confirm that the "[component name]" is correct for the page.
Issue summaries are accurate, easy to understand, and follow consistent format.
Issue links work as expected.
Changelogs exist and are free from error.

Testing checklist

All components have changelog entries
Known issues are appearing in Character count, Combo box, Date picker, File input, Input mask, and Validation

…own-issues

amyleadem

@jaclinec I have added the known issues to the component pages listed in the preview links in the PR description. I had a few questions for you. Can you take a look when you get a chance and let me know what you think?

_data/issues/date-picker.yml

_data/issues/validation.yml

_data/issues/input-mask.yml

_data/issues/date-picker.yml

amyleadem · 2024-01-25T16:12:16Z

_components/combo-box/combo-box.md

-alert: true
-alert-class: info
-alert-heading: Current accessibility issues
-alert-content: In late 2022, we found some combo box <a href="#accessibility-combo-box">usability issues</a> when we were testing with people who use screen readers and alternative input devices. For more information, see <a href="https://github.com/uswds/uswds-site/issues/1898">the issue on GitHub</a>.


Note
Replaced this alert with the standard "known issues" alert

- Determined that it is a doc update and should not be included

amyleadem · 2024-01-29T18:58:39Z

@jaclinec I have responded to your comments. Please let me know if you need any other changes!

@sarah-sch and/or @finekatie, can you proof the copy for the known issues entries on the pages listed above and let me know if you need any changes?

@mejiaj and/or @mahoneycm, can you confirm that the code updates look good?

finekatie · 2024-01-29T22:49:56Z

Hi @amyleadem , I took a cursory look at the pages and everything looks good to me.
One question about a description of an issue on the date picker page:
"The focus indicator is not visible around the calendar icon in high contrast mode. "

I was wondering if there was a plainer way to say it, but if "focus indicator" is a common phrase or term we use, we should leave it.
@sarah-sch do you have any other input?

_data/issues/date-picker.yml

finekatie

I commented before I added review. Apologize for doing backwards!

…own-issues

amyleadem · 2024-03-04T21:44:21Z

_data/issues/date-picker.yml

- date: 2023-09-29
-  summary: The focus indicator is not visible around the calendar icon in high contrast mode.
-  summaryAdditional:
-  affectsKeyboard: true
-  affectsHighContrast: true
-  githubRepo: uswds
-  githubNumber: 5535


Note
Removed this because this issue will be resolved with 3.8.0

sarah-sch

In addition to change I left in line, please change the contribute/join GitHub language in the known issues sections to read as follows:

Help fix these issues or add details on GitHub. Don’t have an account? Please join our community to share feedback and contribute to USWDS.

sarah-sch · 2024-03-05T15:18:45Z

_data/issues/validation.yml

+  issue_number: 5642
+- date: 2023-10-25
+  summary: Users are confused about the purpose of the validation component.
+  summary_additional: The component does not match user expectations for how their information should be validated in a form input.


Suggest changing "expectations for" to "expectations of"

I made this update in 3deeefa

amyleadem · 2024-03-05T19:42:02Z

@sarah-sch I've made the requested updates. Please let me know if you need any changes!

sarah-sch

Thanks for making those changes, @amyleadem - looks good!

css/custom-styles/_graphic-list.scss

mejiaj

LGTM, just need to update date fields before merge.

mejiaj · 2024-03-12T17:50:14Z

_data/issues/README.md

Tip
Renamed to README.md in d299fc3. Simpler, follows GitHub guidance, and (unverified) is supposed to improve display when viewing online.

mejiaj · 2024-03-12T18:28:10Z

Build issues

Locally, I've run npm start and separately npm run test. Zero issues found.

annepetersen

Date picker doesn't seem to have the known issues addition in its latest updates section

Validation: shouldn't the second known issue start with "Some users" rather than just "Users"?

mejiaj · 2024-03-13T13:58:33Z

@annepetersen, good catch!

Added Date picker latest updates in 2084a0d
Added Some to Validation known issue in d54f846

Double-checked other component changelogs as well.

annepetersen

LGTM: thanks James!

mejiaj · 2024-03-13T14:12:09Z

Updated changelog date in 10fd817 to get ready to merge.

mejiaj · 2024-03-13T16:04:04Z

This is ready to merge. I've run npm run test locally and found zero issues.

thisisdano · 2024-03-18T16:12:09Z

Merging over pa11y crashes

amyleadem added 9 commits December 19, 2023 09:06

Change githubRepo, githubNumber --> issueRepo, issueNumber

29a8f12

Change githubRepo, githubNumber --> issueRepo, issueNumber

573d17c

Add new issues yaml files

4880bdd

Remove previous combo box alert

2263edb

Create issue_readme file

651409d

Update entry for 5647

f2e56d0

Add changelogs for #2402

9f5c6ae

Tweak copy on known issues entries

a2e60a4

Merge branch 'main' of https://github.com/uswds/uswds-site into al-kn…

92743f9

…own-issues

amyleadem mentioned this pull request Jan 25, 2024

USWDS - Date Picker: Add high contrast focus styling to calendar button uswds/uswds#5701

Merged

amyleadem added 4 commits January 25, 2024 08:27

Small copy edits on known issues

dd43d01

Merge branch 'main' of https://github.com/uswds/uswds-site into al-kn…

708e396

…own-issues

Update camel case to underscore

fb9e863

Fix typo

315da0e

amyleadem commented Jan 25, 2024

View reviewed changes

_data/issues/date-picker.yml Outdated Show resolved Hide resolved

_data/issues/validation.yml Outdated Show resolved Hide resolved

_data/issues/input-mask.yml Outdated Show resolved Hide resolved

amyleadem commented Jan 25, 2024

View reviewed changes

_data/issues/date-picker.yml Show resolved Hide resolved

amyleadem commented Jan 25, 2024

View reviewed changes

amyleadem marked this pull request as ready for review January 25, 2024 16:12

amyleadem requested a review from jaclinec January 25, 2024 16:12

amyleadem added 2 commits January 29, 2024 11:32

Remove #2294 from date picker issues

d1e9a12

- Determined that it is a doc update and should not be included

Replace input mask issue 5525 with 5481

99b1c55

amyleadem requested review from finekatie, mahoneycm, mejiaj and sarah-sch January 29, 2024 18:55

Update validation issue #2320 to 5750

ed22720

finekatie reviewed Jan 29, 2024

View reviewed changes

_data/issues/date-picker.yml Outdated Show resolved Hide resolved

finekatie reviewed Jan 29, 2024

View reviewed changes

amyleadem added 2 commits February 21, 2024 11:21

Merge branch 'main' of https://github.com/uswds/uswds-site into al-kn…

1f91a02

…own-issues

Remove entry for #5534: will be addressed in 3.8.0

e366dee

amyleadem commented Mar 4, 2024

View reviewed changes

sarah-sch suggested changes Mar 5, 2024

View reviewed changes

amyleadem added 3 commits March 5, 2024 12:32

Update "fix these issues" text in known-issues.html

087df70

Change "expectations for" to "expectations of"

3deeefa

Run prettier

9cc3790

amyleadem requested a review from sarah-sch March 5, 2024 19:42

sarah-sch approved these changes Mar 5, 2024

View reviewed changes

amyleadem commented Mar 5, 2024

View reviewed changes

css/custom-styles/_graphic-list.scss Show resolved Hide resolved

James Mejia added 2 commits March 12, 2024 11:48

Merge branch 'main' of github.com:uswds/uswds-site into al-known-issues

0d4cbe5

Rename known issues README file

d299fc3

mejiaj approved these changes Mar 12, 2024

View reviewed changes

mejiaj reviewed Mar 12, 2024

View reviewed changes

mejiaj requested review from annepetersen and thisisdano March 12, 2024 18:28

annepetersen requested changes Mar 12, 2024

View reviewed changes

James Mejia added 2 commits March 13, 2024 08:51

Add changelog note to Date picker

2084a0d

Modify validation known issue language Users → Some users

d54f846

mejiaj requested a review from annepetersen March 13, 2024 13:58

annepetersen approved these changes Mar 13, 2024

View reviewed changes

Update Known Issues changelog date

10fd817

thisisdano merged commit c8055da into main Mar 18, 2024

thisisdano deleted the al-known-issues branch March 18, 2024 16:12

Conversation

amyleadem commented Dec 19, 2023 • edited by mejiaj Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary

Related issue

Preview link

Problem statement

Testing and review

Testing checklist

Uh oh!

amyleadem left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

amyleadem Jan 25, 2024

Choose a reason for hiding this comment

Uh oh!

amyleadem commented Jan 29, 2024

Uh oh!

finekatie commented Jan 29, 2024

Uh oh!

Uh oh!

finekatie left a comment

Choose a reason for hiding this comment

Uh oh!

amyleadem Mar 4, 2024

Choose a reason for hiding this comment

Uh oh!

sarah-sch left a comment

Choose a reason for hiding this comment

Uh oh!

sarah-sch Mar 5, 2024

Choose a reason for hiding this comment

Uh oh!

amyleadem Mar 5, 2024

Choose a reason for hiding this comment

Uh oh!

amyleadem commented Mar 5, 2024

Uh oh!

sarah-sch left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

mejiaj left a comment

Choose a reason for hiding this comment

Uh oh!

mejiaj Mar 12, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

mejiaj commented Mar 12, 2024

Build issues

Uh oh!

annepetersen left a comment

Choose a reason for hiding this comment

Uh oh!

mejiaj commented Mar 13, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

annepetersen left a comment

Choose a reason for hiding this comment

Uh oh!

mejiaj commented Mar 13, 2024

Uh oh!

mejiaj commented Mar 13, 2024

Uh oh!

thisisdano commented Mar 18, 2024

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

8 participants

amyleadem commented Dec 19, 2023 •

edited by mejiaj

Loading

mejiaj Mar 12, 2024 •

edited

Loading

mejiaj commented Mar 13, 2024 •

edited

Loading