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

Create guides landing page #7550

Open
wants to merge 23 commits into
base: main
Choose a base branch
from
Open

Create guides landing page #7550

wants to merge 23 commits into from

Conversation

nick-mon1
Copy link
Contributor

@nick-mon1 nick-mon1 commented May 6, 2024

Summary

Adds the landing page for the guides section.

Screenshot

Guides _ Digital_gov · 2 35pm · 05-21

Preview

Link to Preview

Solution

  • adds a landing page for all top level guides (does not display HCD sub-guides)
  • adds dg-guides and dg-guides-card component classes for displaying each guide
  • adds front matter field guide_weight to each guide to display ASC order (lowest to highest)

How To Test

  1. Visit /guides
  2. Should see guides listed in card list
  3. Click on each card title (h2) will link to the guide

Content

@bonnieAcameron Here are some outstanding content related items:

  • update the guide_weight to change order, 1 will display first
  • update title to remove "Guide to..."
  • update summary for each guide?

Dev Checklist

  • PR has correct labels
  • A11y testing (voice over testing, meets WCAG, run axe tools)
  • Code is formatted properly

Copy link

github-actions bot commented May 6, 2024

🔍 Preview in Federalist

@nick-mon1 nick-mon1 self-assigned this May 6, 2024
@nick-mon1 nick-mon1 added Content: Guide Dev: Template Logic Fixes and improvements associated with our static site generator labels May 9, 2024
@nick-mon1 nick-mon1 requested a review from mejiaj May 9, 2024 18:59
@nick-mon1 nick-mon1 marked this pull request as ready for review May 10, 2024 17:36
@clmedders
Copy link
Contributor

@nick-mon1 overall looks good... the cards do seem a bit big i wonder if reducing the size is helpful? im happy to talk it through it but also is a personal thing and dont think it should hold up the work.

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 look good. I didn't find any a11y issues when running AXE extension.

Posted some comments/questions below.

@bonnieAcameron
Copy link
Contributor

I noticed that all of the words in the guide cards begin with capital letters. I tried to find where/why this is happening, since the guides themselves aren't formatted this way. The red slashed letters should be lowercase:

Image 5-15-24 at 10 44 PM

@nick-mon1
Copy link
Contributor Author

@bonnieAcameron I've updated the casing for the guide titles in the original markdown files which means that each of the guide landing pages will now reflect the above changes.

Screenshot 2024-05-20 at 2 43 55 PM

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.

Can we also adjust the padding on the dg-guides.usa.section to .5rem padding on the top? The space there is a little large.

content/guides/_index.md Outdated Show resolved Hide resolved
content/guides/hcd/introduction/_index.md Show resolved Hide resolved
content/guides/accessibility-for-teams/_index.md Outdated Show resolved Hide resolved
content/guides/dap/_index.md Outdated Show resolved Hide resolved
content/guides/rpa/_index.md Outdated Show resolved Hide resolved
content/guides/public-participation/_index.md Outdated Show resolved Hide resolved
@sarah-sch
Copy link
Contributor

sarah-sch commented May 21, 2024

@bonnieAcameron I've updated the casing for the guide titles in the original markdown files which means that each of the guide landing pages will now reflect the above changes.

Screenshot 2024-05-20 at 2 43 55 PM

@bonnieAcameron should "human-centered design" also be lowercase in the title for that guide? I would also recommend: "Accessibility for teams"

Also, just a personal peference, but i would recommend replacing the second "to" with "and in the "Understanding robotic process automation" blurb:
Configure bots to execute repetitive tasks and save users from performing mundane tasks repeatedly for the same process.

cc @nick-mon1

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.

I have a capitalization question that we should run by @bonnieAcameron : Should "human-centered design" also be lowercase in the title for that guide? I would also recommend: "Accessibility for teams"

Also, just a personal peference, but i would recommend replacing the second "to" with "and in the "Understanding robotic process automation" blurb:
Configure bots to execute repetitive tasks and save users from performing mundane tasks repeatedly for the same process.

cc @bonnieAcameron

Fixing capitalization
fixed capitalization
adjusting wording to avoid repetition of "to"
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.

Committed a few small text changes for capitalization and to polish intro blurbs.

@@ -1,7 +1,7 @@
---
date: 2023-07-24 09:00:00 -0500
kicker: HCD Guide Series
title: "Introduction to human-centered design"
title: "Introduction to Human-Centered Design"
Copy link
Contributor

Choose a reason for hiding this comment

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

"Human-Centered Design" should remain lowercase: "human-centered design"

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Content: Guide Dev: Template Logic Fixes and improvements associated with our static site generator
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

6 participants