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

Dev guide updates uswds compile #1424

Merged
merged 28 commits into from Mar 10, 2022
Merged

Dev guide updates uswds compile #1424

merged 28 commits into from Mar 10, 2022

Conversation

mikki-stacey
Copy link
Contributor

@mikki-stacey mikki-stacey commented Feb 4, 2022

Description

Updated uswds-gulp info with uswds-compile guidance

Preview

Getting started for devs →

Removed unnecessary hyphens.
Addressed capitalization errors in the lead text. 
Added end punctuation for consistency.
Replaced instances of "USWDS" with "Design System" for consistency and 18f compliance.
Revised "lead" text for consistent capitalization and punctuation.
Removed out-of-date code box (which noted the wrong version of node).
For consistency and 18f compliance, updated "USWDS" to "Design System" except when the term is used to describe a package called "USWDS."
Revised "lead" text for consistency.
For consistency and 18f compliance, revised "USWDS" to "Design System" except when the term is used in reference to the package called "USWDS."
Per usability testing, moved note from step 1 to the intro.
Per usability testing, removed distracting links from the intro text.
Replaced uswds-gulp instructions with uswds-compile instructions
Updated "lead" text for consistency.
Replaced gulp with compile
@mikki-stacey
Copy link
Contributor Author

@mejiaj , Thanks for your help with these updates. Please read through phases 2 and 3 carefully to make sure I didn't delete or forget to add something important.

@amyleadem amyleadem self-requested a review February 17, 2022 15:27
revised "look read" to "look like."
@amyleadem
Copy link
Contributor

@mejiaj Can I get your eyes on phase 2 and 3 to confirm content?

A couple thoughts on phase 2:

  • Should we include a link to the uswds-compile github and/or include the full readme content? I think the terminal commands section here is particularly helpful
  • In Step 6, I think it would make sense to replace npx gulp build-sass with npx gulp compile, since that is the function in our example.

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.

When importing SCSS/SASS files we should use @import not @include. Can we please update that?

@mejiaj
Copy link
Contributor

mejiaj commented Mar 9, 2022

Requires #1469 to be merged to fix build issues.

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.

Good choice to replace uswds-gulp with compile. I've made a few changes, mainly updating the old path references. Also as added some suggestions via comments.

@mejiaj mejiaj added this to Development review in USWDS Sprint Board via automation Mar 9, 2022
@mejiaj mejiaj moved this from Development review to Fed final review in USWDS Sprint Board Mar 9, 2022
mejiaj and others added 3 commits March 9, 2022 09:36
Added a comma.
Moved note and deleted "below" for inclusive/accessible language.
@amyleadem
Copy link
Contributor

I have updated the Phase 2 side navigation and set the paths table to be scrollable. It's looking good!

Copy link
Contributor

@amyleadem amyleadem left a comment

Choose a reason for hiding this comment

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

All tests should be passing now. Looks good!

@mejiaj mejiaj merged commit 58e4bb4 into main Mar 10, 2022
USWDS Sprint Board automation moved this from Fed final review to Done Mar 10, 2022
@mejiaj mejiaj deleted the dev-guide-updates_uswds-compile branch March 10, 2022 19:06
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Development

Successfully merging this pull request may close these issues.

None yet

4 participants