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.

Sign up for GitHub

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

Jump to bottom

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

Merged
merged 9 commits into from
Sep 5, 2024
Merged

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

merged 9 commits into from
Sep 5, 2024

Conversation

amyleadem
Copy link
Contributor

@amyleadem amyleadem commented Jul 15, 2024 •
edited
Loading

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

  1. 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
  2. Confirm the changes in this PR are accurate and make sense
  3. Confirm appropriate changelogs are present and accurate

amyleadem
amyleadem commented Jul 15, 2024
View reviewed changes
pages/documentation/getting-started-developers/phase-two.md
@@ -196,6 +196,8 @@ Setting | Default values - Version 2.x | Default values - Version 3.0 | Descript
`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).
Copy link
Contributor Author

@amyleadem amyleadem Jul 15, 2024 •
edited
Loading

Choose a reason for hiding this comment

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

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.

Copy link
Contributor

Choose a reason for hiding this comment

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

Praise: Great catch! Thanks for adding this

amyleadem
amyleadem commented Jul 17, 2024
View reviewed changes
pages/documentation/getting-started-developers/phase-two.md
Comment on lines +199 to +200
`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.
Copy link
Contributor Author

@amyleadem amyleadem Jul 17, 2024 •
edited
Loading

Choose a reason for hiding this comment

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

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?

Copy link
Contributor

Choose a reason for hiding this comment

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

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

@amyleadem amyleadem marked this pull request as ready for review July 17, 2024 17:03
mejiaj
mejiaj approved these changes Jul 17, 2024
View reviewed changes
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.

Thanks for updating this!

@mejiaj
Copy link
Contributor

mejiaj commented Jul 17, 2024

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

mahoneycm
mahoneycm reviewed Jul 19, 2024
View reviewed changes
Copy link
Contributor

@mahoneycm mahoneycm left a comment

Choose a reason for hiding this comment

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

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 Outdated Show resolved Hide resolved
pages/documentation/getting-started-developers/phase-two.md
@@ -196,6 +196,8 @@ Setting | Default values - Version 2.x | Default values - Version 3.0 | Descript
`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).
Copy link
Contributor

Choose a reason for hiding this comment

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

Praise: Great catch! Thanks for adding this

mejiaj
mejiaj approved these changes Sep 4, 2024
View reviewed changes
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.

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

thisisdano
thisisdano reviewed Sep 4, 2024
View reviewed changes
Copy link
Member

@thisisdano thisisdano left a comment

Choose a reason for hiding this comment

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

Updating the changelog date

_data/changelogs/docs-getting-started-devs-phase-2.yml Outdated Show resolved Hide resolved
@thisisdano thisisdano merged commit 9934695 into main Sep 5, 2024
11 checks passed
@thisisdano thisisdano deleted the al-compile-1.2.0 branch September 5, 2024 18:25
This was referenced Sep 26, 2024
Closed
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@mahoneycm mahoneycm mahoneycm approved these changes

@thisisdano thisisdano thisisdano approved these changes

@mejiaj mejiaj mejiaj approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

USWDS-Site: Add documentation updates for uswds-compile 1.2.0
4 participants
@amyleadem @mejiaj @thisisdano @mahoneycm