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: Validation - Add clarity to guidance #1851

Merged
merged 13 commits into from
Mar 1, 2023
Merged

Conversation

amyleadem
Copy link
Contributor

@amyleadem amyleadem commented Oct 21, 2022

Summary

Updated the guidance on the validation page to:

  1. Removed the # from the data-validation-element value.
  2. Made implementation instructions more explicit and clear.
  3. Fixed the text-indent issue on external links found inside nested ordered lists.

Related issue

Closes #1846

Preview link

Preview link: Validation guidance

Problem statement

  • The implementation guidance for the validation component has outdated guidance for the value of data-validation-element. (Related PR: #5001).
  • Some items in the guidance are confusing and could be rewritten so that they are easier to understand.
  • There is a styling issue with the regular expression external link on this page.

image

Solution

  1. Changed data-validation-element="#validate-code" to data-validation-element="validate-code"
  2. Simplified item 2 by separating out the benefit statement and moving it to when-to-use.md
  3. Added active summaries at the top of each item to add clarity.
  4. Made minor copy edits to the step-by-step instructions to add clarity.
  5. Reset the text-indent on external links nested inside .usa-content-list ol li to resolve style issue.

Testing and review

To review:

  • Proofread copy for error and accuracy
  • Confirm that the guidance is comprehensive and produces the desired results.

Before opening this PR, make sure you’ve done whichever of these applies to you:

  • Confirm that this code follows the 18F Front End Coding Style Guide and Accessibility Guide.
  • Run git pull origin [base branch] to pull in the most recent updates from your base and check for merge conflicts. (Often, the base branch is develop).
  • Run npm test and confirm that all tests pass.
  • Run your code through HTML_CodeSniffer and make sure it’s error free.

@amyleadem amyleadem changed the title USWDS-Site: Validation - Add clarity to USWDS-Site: Validation - Add clarity to guidance Oct 21, 2022
@amyleadem amyleadem marked this pull request as ready for review October 24, 2022 16:23
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.

This PR looks good! Added a suggestion for improving external-link mixin in USWDS.

Comment on lines +2539 to +2541
a {
text-indent: initial;
}
Copy link
Contributor

Choose a reason for hiding this comment

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

I see this section uses usa-content-list. The external-link mixin could benefit from this change too

https://github.com/uswds/uswds/blob/69cf6929585b5c95ed9700a4502830f84e497e95/packages/uswds-core/src/styles/mixins/general/external-link.scss#L14

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Copy link
Contributor

@bonnieAcameron bonnieAcameron left a comment

Choose a reason for hiding this comment

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

Hi @amyleadem! I added a few clarifying questions and 1 copy edit. For the clarifying questions, take them with a grain of salt, since I'm a 099 level newbie to validation, and I'm assuming anyone reading this will at least have a 101 level understanding. I just flagged places where I felt there could be a bit more explanation.

@amyleadem
Copy link
Contributor Author

@bonnieAcameron Thanks for the feedback. I added some slight tweaks and some responses to your comments. Let me know if you see anything that needs changing.

Copy link
Contributor

@bonnieAcameron bonnieAcameron left a comment

Choose a reason for hiding this comment

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

Just a quick reference to the code block, and it looks great!

@amyleadem
Copy link
Contributor Author

@bonnieAcameron Added a reference note in 9ec48cb. Let me know if you want any changes!

Copy link
Contributor

@bonnieAcameron bonnieAcameron left a comment

Choose a reason for hiding this comment

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

the "have yet to be completed" phrasing might be confusing for ESL readers. Kick it on back to me if you agree and we'll get this wrapped for ya!

Co-authored-by: Bonnie Cameron <96838068+bonnieAcameron@users.noreply.github.com>
Copy link
Contributor

@bonnieAcameron bonnieAcameron 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!

@thisisdano thisisdano merged commit 745259d into main Mar 1, 2023
@thisisdano thisisdano deleted the al-validation-hash branch March 1, 2023 05:12
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: Update validation page to remove hash on data-validation-element
4 participants