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 - Documentation: Remove redundant nunjucks reference #2809

Closed
mejiaj opened this issue Sep 5, 2024 · 1 comment · Fixed by #2831
Closed

USWDS-Site - Documentation: Remove redundant nunjucks reference #2809

mejiaj opened this issue Sep 5, 2024 · 1 comment · Fixed by #2831
Assignees
Labels
Added during Sprint Affects: Content Relates to content Affects: Guidance Relates to guidance Good First Issue A good issue for those new to USWDS Package: Pagination

Comments

@mejiaj
Copy link
Contributor

mejiaj commented Sep 5, 2024

Nunjucks is mentioned in pagination guidance and we no longer use it. We should replace with more general guidance or remove it completely.

Unlike many USWDS components, Pagination includes behaviors we cannot build into the HTML, CSS, and JavaScript we ship with the design system. Developers will need to build these behaviors into their Pagination templates. We've outlined these behaviors below, and included them in the Nunjucks templates for Pagination in our source code.

Preview

Using the pagination component

@github-actions github-actions bot added the Status: Triage We're triaging this issue and grooming if necessary label Sep 5, 2024
@mejiaj mejiaj added Affects: Guidance Relates to guidance Package: Pagination Affects: Content Relates to content Good First Issue A good issue for those new to USWDS labels Sep 5, 2024
@amyleadem
Copy link
Contributor

amyleadem commented Sep 5, 2024

I see a few possible options to address this:

  1. Wondering if we can remove the entire section intro highlighted in the attached screenshot. (It feels like the information is implied, but maybe it is good to still be explicit):

    Unlike many USWDS components, Pagination includes behaviors we cannot build into the HTML, CSS, and JavaScript we ship with the design system. Developers will need to build these behaviors into their Pagination templates. We’ve outlined these behaviors below, and included them in the Nunjucks templates for Pagination in our source code.

  2. Alternatively, maybe we can just remove the sentence about Nunjucks?

    We’ve outlined these behaviors below, and included them in the Nunjucks templates for Pagination in our source code.

  3. OR if we think the twig template has valuable info, we replace the Nunjucks reference with Twig:

    We’ve outlined these behaviors below, and included them in the Twig template for Pagination in our source code.

Option 3 might be the cleanest, easiest option, but I'd be curious to hear what others think.

More info

Related Slack thread

@brunerae brunerae added Added during Sprint and removed Status: Triage We're triaging this issue and grooming if necessary labels Sep 12, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Added during Sprint Affects: Content Relates to content Affects: Guidance Relates to guidance Good First Issue A good issue for those new to USWDS Package: Pagination
Projects
Status: Done
Development

Successfully merging a pull request may close this issue.

3 participants