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

638 update the guides index page #3825

Merged
merged 16 commits into from Apr 19, 2024
Merged

Conversation

dluetger
Copy link
Contributor

@dluetger dluetger commented Apr 12, 2024

Pull request summary

Updates the design and content of the guides index page.

Reminder - please do the following before assigning reviewer

  • Update readme
  • For frontend changes, ensure design review
  • For content changes beyond typos, add Ron Bronson as a reviewer

And make sure that automated checks are ok

  • fix houndci feedback
  • ensure tests pass
  • federalist builds
  • no new SNYK vulnerabilities are introdcued

to be creating unnecessary border
- Added description and "read link name" for each
guide in the yaml file so they can be displayed
on the new guides index
- Created `card-with-image-guides` to better
accomodate the content needs of the new
guides index
- Changed background color of main content section
for guides index
- Added the hero image SVGs
- Fixed some style and layout bugs, things are
  about 90% of where they should be to match
  the mockup
  for because there was overflow at tablet widths
  for non-important guides now becomes 2x at
  tablet widths to solve for some overflow but
  not becoming to wide/stacked too soon
  links in the card to prevent orphaned words
  at narrower widths; though it doesn't seem to
  be respecting it; might have to do with there
  being dynamically generated text right in the
  middle?
  because calling one guide more important
  than another seemed rude
  arguments for card-with-image-guides and
  how the "promoted" flag should be used in
  guide.yml
  card-with-image-guides.html and it's use
  and behaviors
  min-height and the link sticks to the bottom
- Adds null alt text to hero images
- Changes the guide card titles to just be
  headings instead of links
@dluetger dluetger requested a review from a team as a code owner April 12, 2024 17:48
@dluetger
Copy link
Contributor Author

dluetger commented Apr 12, 2024

I added a few comments in the code throughout but here are a few notes and follow-up items for this ticket.

Overall

  • Could use engineering eyes on this to make sure I did things mostly correctly from a best practices and "how we do it at 18F" perspective. It's my first time making front-end changes at this scale.

Implementation details

  • This change creates a new partial and a new class, card-with-image-guides. I spun it off from the card-with-image partial to accommodate the unique needs of the guides index page. For now it was too much to change the existing class and make it all work, but if someone is feeling ambitious with their if/thens and for loops this could probably be elegantly combined back down into a single partial/class.
  • Per the design, the whole card is no longer a clickable link.
  • I did end up including only one link per card. The heading of each card is just a heading, not a link. That way we don't have two links going to the same place with different labels, which creates an accessibility issue. We should revisit this and maybe even make the whole card clickable again maybe
  • There is an a11y alert where we skip from an h1 to h3s for the guide titles. This is how it was in the design, though in future we'll probably want to bump those back up to h2s and resize them to match the design visuals while remaining semantically correct

Follow-ups and things I didn't get to (I'll file another ticket for this)

  • The icons in the design don't match what's in the current implementation, but for time's sake it didn't seem like a critical issue. The design contains one or two new glyphs, and the icons are blue instead of dark grey as they are in the previous design and this update
  • Figure out the "should the entire card area be clickable?" and "can we have two links per card going to the same place?" questions mentioned above
  • Make the h3 card titles be h2s so they are semantically correct
  • I mentioned this in the main ticket for this issue, but the design has a big blue section at the bottom where more call to action content could live, but I didn't include it for now since there was no content for it. If we ever write that it should be fairly simple to add it in.

Copy link
Member

@neilmb neilmb left a comment

Choose a reason for hiding this comment

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

Preview looks great. Some tiny comments on comments.

_includes/footer.html Outdated Show resolved Hide resolved
pages/guides.md Outdated Show resolved Hide resolved
pages/guides.md Outdated Show resolved Hide resolved
pages/guides.md Outdated Show resolved Hide resolved
_layouts/guides.html Outdated Show resolved Hide resolved
@juliaklindpaintner
Copy link
Member

@dluetger Once you've had a chance to review the suggestions here, I think this can be merged!

dluetger and others added 5 commits April 18, 2024 16:24
Simplifying the booleans

Co-authored-by: Matt Cloyd <matt.cloyd@gsa.gov>
Simplifying the booleans, pt. 2

Co-authored-by: Matt Cloyd <matt.cloyd@gsa.gov>
Simplifying the booleans, pt. 3

Co-authored-by: Matt Cloyd <matt.cloyd@gsa.gov>
  `unless` block with `endunless`
@dluetger dluetger merged commit 851aa06 into main Apr 19, 2024
5 checks passed
@dluetger dluetger deleted the 638-update-the-guides-index-page branch April 19, 2024 00:02
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.

None yet

5 participants