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

Recreate interview checklist for methods #294

Closed
3 of 9 tasks
jduss4 opened this issue Dec 19, 2023 · 5 comments · Fixed by #436
Closed
3 of 9 tasks

Recreate interview checklist for methods #294

jduss4 opened this issue Dec 19, 2023 · 5 comments · Fixed by #436
Assignees
Labels
Guides Initiative 2 Tracks work for "Improving the Maintainability of the 18F Guides and Methods"

Comments

@jduss4
Copy link
Contributor

jduss4 commented Dec 19, 2023

A description of the work

On the current methods website, there is an interview checklist with actual checkboxes. However, 11ty doesn't render these by default, so they come out looking like - [ ]

Off the top of my head I can think of a couple options:

  1. Use HTML for the checkboxes
  2. Extend the markdown parser
  3. Change the checkboxes to bullet points (requires design input)

Point of contact on this issue

jduss4

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?

4 hours

Acceptance Criteria

The new methods guide page for the interview checklist either has checkboxes or an approved alternative

@jduss4 jduss4 added Initiative 2 Tracks work for "Improving the Maintainability of the 18F Guides and Methods" Guides labels Dec 19, 2023
@echappen echappen self-assigned this Dec 21, 2023
@echappen
Copy link
Contributor

Noting that I tried installing the markdownIt extension package that issue links to, but its dependencies require conflicting Node versions, so I was hesitant to use it.

@echappen
Copy link
Contributor

I also noticed that the UX guide has a very similar interview checklist with un-styled markdown checkboxes.

@echappen
Copy link
Contributor

Given that the released ux guide has the same issue, I'm going to consider this out-of-scope for the methods migration epic: #224

@igorkorenfeld
Copy link
Contributor

Came across this and thought I'd note that the derisking guide has some checklists, and the way I resolved it there was with styling the bulleted list by adding a class to the preceding text using the markdown-it-attrs plugin

@echappen
Copy link
Contributor

echappen commented Jan 3, 2024

Here's a PR that demonstrates what Igor's suggestion looks like: #436

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

Successfully merging a pull request may close this issue.

3 participants