USWDS-Site: Add documentation updates for uswds compile 1.2.0 #2750

amyleadem · 2024-07-15T19:45:44Z

Summary

Updated documentation to match the changes in uswds-compile release 1.2.0.

Updated gulp 4 references to gulp 5
Added documentation for new settings.compile.sassSourcemaps setting and settings.compile.browserslist
Added changelogs where needed

Important

We should update the changelog dates before merge.

Related issue

Closes #2749

Preview link

Getting started for developers: Phase 2

Testing and review

Confirm all doc changes related to uswds compile 1.2.0 have been accounted for
1. All references to "Gulp 4" have been updated
2. New compile settings are added to the path settings table
Confirm the changes in this PR are accurate and make sense
Confirm appropriate changelogs are present and accurate

…rslist

amyleadem · 2024-07-15T19:50:34Z

pages/documentation/getting-started-developers/phase-two.md

 `paths.dist.js` | `"./assets/uswds/js"` | `"./assets/uswds/js"` | Project destination for compiled JavaScript
 `paths.dist.css` | `"./assets/uswds/css"` | `"./assets/uswds/css"` | Project destination for compiled CSS
 `sprite.projectIconsOnly` | `false` | `false` | Include _only_ the icons in `paths.src.projectIcons` in the icon sprite
+`settings.compile.browserslist` | `["> 2%", "last 2 versions", "IE 11", "not dead"]` | `["> 2%", "last 2 versions", "IE 11", "not dead"]` | Define the [browserslist query](https://github.com/browserslist/browserslist?tab=readme-ov-file#queries) for CSS prefixes generated by [autoprefixer](https://github.com/postcss/autoprefixer).


Note
This setting was included in the README but not on the site. I added it here to fill the gap, even though it isn't related to 1.2.0. Please flag if this omission was intentional and should not be included in our site documentation.

Praise: Great catch! Thanks for adding this

amyleadem · 2024-07-17T17:02:19Z

pages/documentation/getting-started-developers/phase-two.md

+`settings.compile.browserslist` | `["> 2%", "last 2 versions", "IE 11", "not dead"]` | `["> 2%", "last 2 versions", "IE 11", "not dead"]` | Define the [browserslist query](https://github.com/browserslist/browserslist?tab=readme-ov-file#queries) for CSS prefixes generated by [autoprefixer](https://github.com/postcss/autoprefixer).
+`settings.compile.sassSourcemaps` | `true` | `true` | Include sourcemap when compiling SASS to CSS.


question: Now that we have multiple non-path settings available, should we create a separate table for them? Or rename the "Path settings" table and tweak the intro?

I'd keep it together for now. There aren't enough issues to warrant a completely separate table yet.

pages/documentation/getting-started-developers/phase-two.md

mejiaj

Thanks for updating this!

mejiaj · 2024-07-17T18:02:56Z

CI test failing due to snyk errors. Fixed by #2751.

mahoneycm

Looking good! Once you remove the gulp version number this will be good to go in my eyes 👍

_data/changelogs/docs-getting-started-devs-phase-2.yml

mahoneycm · 2024-07-19T13:37:15Z

pages/documentation/getting-started-developers/phase-two.md

 `paths.dist.js` | `"./assets/uswds/js"` | `"./assets/uswds/js"` | Project destination for compiled JavaScript
 `paths.dist.css` | `"./assets/uswds/css"` | `"./assets/uswds/css"` | Project destination for compiled CSS
 `sprite.projectIconsOnly` | `false` | `false` | Include _only_ the icons in `paths.src.projectIcons` in the icon sprite
+`settings.compile.browserslist` | `["> 2%", "last 2 versions", "IE 11", "not dead"]` | `["> 2%", "last 2 versions", "IE 11", "not dead"]` | Define the [browserslist query](https://github.com/browserslist/browserslist?tab=readme-ov-file#queries) for CSS prefixes generated by [autoprefixer](https://github.com/postcss/autoprefixer).


Praise: Great catch! Thanks for adding this

…mpile-1.2.0

mejiaj

Thanks @amyleadem! Didn't find any visual regressions in preview.

…mpile-1.2.0

thisisdano

Updating the changelog date

_data/changelogs/docs-getting-started-devs-phase-2.yml

amyleadem added 2 commits July 15, 2024 12:35

Update gulp 4 reference -> gulp 5

5477ebb

Add docs for settings.compile.sassSourcemaps, settings.compile.browse…

36b7123

…rslist

amyleadem commented Jul 15, 2024

View reviewed changes

amyleadem commented Jul 17, 2024

View reviewed changes

amyleadem marked this pull request as ready for review July 17, 2024 17:03

amyleadem requested review from mahoneycm and mejiaj July 17, 2024 17:04

amyleadem commented Jul 17, 2024

View reviewed changes

pages/documentation/getting-started-developers/phase-two.md Outdated Show resolved Hide resolved

mejiaj approved these changes Jul 17, 2024

View reviewed changes

mahoneycm reviewed Jul 19, 2024

View reviewed changes

amyleadem added 2 commits August 5, 2024 08:30

Replace "Gulp 5" with "Gulp"

4426600

Merge branch 'main' of https://github.com/uswds/uswds-site into al-co…

e9d0ca0

…mpile-1.2.0

mahoneycm approved these changes Aug 29, 2024

View reviewed changes

amyleadem requested a review from thisisdano August 30, 2024 16:41

Update @uswds/compile to 1.2.0

9f2e966

mejiaj approved these changes Sep 4, 2024

View reviewed changes

Merge branch 'main' of https://github.com/uswds/uswds-site into al-co…

55c7cd9

…mpile-1.2.0

thisisdano reviewed Sep 4, 2024

View reviewed changes

_data/changelogs/docs-getting-started-devs-phase-2.yml Outdated Show resolved Hide resolved

Update changelog date

8a43d54

thisisdano reviewed Sep 5, 2024

View reviewed changes

_data/changelogs/docs-getting-started-devs-phase-2.yml Outdated Show resolved Hide resolved

Update changelog date

c195662

thisisdano reviewed Sep 5, 2024

View reviewed changes

_data/changelogs/docs-getting-started-devs-phase-2.yml Outdated Show resolved Hide resolved

Update changelog date

2570093

thisisdano approved these changes Sep 5, 2024

View reviewed changes

thisisdano merged commit 9934695 into main Sep 5, 2024

thisisdano deleted the al-compile-1.2.0 branch September 5, 2024 18:25

This was referenced Sep 26, 2024

Update to @uswds/compile@1.2.0 #2807

Closed

Bump elliptic from 6.5.6 to 6.5.7 #2785

Closed

		`settings.compile.browserslist` \| `["> 2%", "last 2 versions", "IE 11", "not dead"]` \| `["> 2%", "last 2 versions", "IE 11", "not dead"]` \| Define the [browserslist query](https://github.com/browserslist/browserslist?tab=readme-ov-file#queries) for CSS prefixes generated by [autoprefixer](https://github.com/postcss/autoprefixer).
		`settings.compile.sassSourcemaps` \| `true` \| `true` \| Include sourcemap when compiling SASS to CSS.

USWDS-Site: Add documentation updates for uswds compile 1.2.0 #2750

USWDS-Site: Add documentation updates for uswds compile 1.2.0 #2750

Uh oh!

Conversation

amyleadem commented Jul 15, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary

Related issue

Preview link

Testing and review

Uh oh!

amyleadem Jul 15, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

mahoneycm Jul 19, 2024

Choose a reason for hiding this comment

Uh oh!

amyleadem Jul 17, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

mejiaj Jul 17, 2024

Choose a reason for hiding this comment

Uh oh!

Uh oh!

mejiaj left a comment

Choose a reason for hiding this comment

Uh oh!

mejiaj commented Jul 17, 2024

Uh oh!

mahoneycm left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

mahoneycm Jul 19, 2024

Choose a reason for hiding this comment

Uh oh!

mejiaj left a comment

Choose a reason for hiding this comment

Uh oh!

thisisdano left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

amyleadem commented Jul 15, 2024 •

edited

Loading

amyleadem Jul 15, 2024 •

edited

Loading

amyleadem Jul 17, 2024 •

edited

Loading