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

Conduct Visual Reviews of Methods site #236

Closed
14 of 21 tasks
Tracked by #224
echappen opened this issue Dec 5, 2023 · 1 comment
Closed
14 of 21 tasks
Tracked by #224

Conduct Visual Reviews of Methods site #236

echappen opened this issue Dec 5, 2023 · 1 comment
Assignees
Labels
Guides Initiative 2 Tracks work for "Improving the Maintainability of the 18F Guides and Methods"

Comments

@echappen
Copy link
Contributor

echappen commented Dec 5, 2023

A description of the work

Conduct a visual review of new site that ensures visual parity with the original methods site.

Since we have automated tests to check for broken links, manual checking for broken links is not necessary.

Use these builds for comparison:
New site
Old site

Accessibility review will be done separately, but if any a11y issues affect design, note them.

Page assignment

Known issues

  1. The new site uses USWDS v3, and old site uses v2, so there will be some slight adjustments in font size and spacing. The whole repo uses the same USWDS version, so let's keep to the v3 defaults as much as possible. If there's something egregiously off, then we'll consider a USWDS override.
  2. Link icons don't show up for some headers because they're not created from Markdown. This is a known issue described in [Bug]: link icons do not render for data-based content #274
  3. There are some redundant pages with the UX guide, described in Methods and UX guide both have an interview checklist, debrief, etc #356
  4. Markdown checkboxes don't render by default in 11ty, described in Recreate interview checklist for methods #294

How to submit an issue

If you want to submit an issue, first check if there's an existing issue for it. If there's an existing issue, make sure it has the "methods design review" label.

If there's no issue, create a new issue using this issue template which should give it the label "methods design review" automatically.

Part of of Epic #224

Point of contact on this issue

Eleni Chappen

Reproduction steps (if necessary)

No response

Skills Needed

  • Any Human
  • Design
  • Content
  • Engineering
  • Acquisition
  • Product
  • Other

Does this need to happen in the next 2 weeks?

  • Yes
  • No

How much time do you anticipate this work taking?

1-2 days

Acceptance Criteria

  • Ensure all items are prioritized for migration (fix before migration / fix after / won't fix)
@echappen echappen added Initiative 2 Tracks work for "Improving the Maintainability of the 18F Guides and Methods" Guides labels Dec 5, 2023
@echappen echappen changed the title Conduct Visual and Accessibility Reviews of Methods site Conduct Visual Reviews of Methods site Dec 21, 2023
@echappen
Copy link
Contributor Author

Done: all issues are accounted for, labeled "methods design review"

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Guides Initiative 2 Tracks work for "Improving the Maintainability of the 18F Guides and Methods"
Projects
None yet
Development

No branches or pull requests

3 participants