USWDS-Compile - README: Add staying up-to-date note. #92
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
mejiaj
commented
Mar 22, 2024
| @@ -28,7 +28,7 @@ npm install @uswds/compile --save-dev | |||
|
|
|||
| ### Gulpfile setup | |||
|
|
|||
| Create a file called `gulpfile.js` at the root of your project (or use an existing Gulpfile if one already exists). It needs to do the following | |||
| Create a file called `gulpfile.js` at the root of your project (or use an existing Gulpfile if one already exists). It needs to do the following: | |||
There was a problem hiding this comment.
This was added for consistency with other lists.
mejiaj
commented
Mar 22, 2024
| @@ -129,7 +129,7 @@ For example, if you have the following `gulpfile.js`: | |||
| exports.compile = uswds.compile; | |||
| exports.watch = uswds.watch; | |||
| exports.init = uswds.init; | |||
| exports.update = uswds.updateUswds; | |||
| exports.updateUswds = uswds.updateUswds; | |||
There was a problem hiding this comment.
Updated to improve clarity and reduce confusion when testing.
mejiaj
commented
Mar 22, 2024
README.md
Outdated
|
|
||
| ### Usage tips | ||
|
|
||
| - **Use `init` only once.** The `init` task is meant for initializing the design system on a project. Since it will overwrite project files (like settings files and the Sass entry point), use it sparingly and don't use it for updating the design system on a project, or at any point after you've customized your settings files. | ||
| - **Update USWDS assets with `copyAssets`.** Don't update assets with `init`, use the `copyAssets` task. This task updates static assets (like images, fonts, and compiled JavaScript) only and you don't risk clobbering your customizations. | ||
| - **Staying up-to-date with USWDS.** When updating your project's version of USWDS; code won't be copied over until you run the `npx gulp updateUswds` command. You can see all of the required changes available on the [USWDS releases](https://github.com/uswds/uswds/releases) page. Alternatively, you can run the `copyAssets` task. This task updates static assets (like images, fonts, and compiled JavaScript) only and you don't risk clobbering your customizations. |
There was a problem hiding this comment.
Combined my previous note with the old copyAssets note to avoid duplicate guidance. As well as point users to the actual update task.
amyleadem
requested changes
Mar 22, 2024
Co-authored-by: Amy Leadem <93996430+amyleadem@users.noreply.github.com>
|
Thanks for the reviews. I've also scanned the website and didn't find any references to the old task: exports.update = uswds.updateUswds; |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Adds basic information for staying up to date with USWDS.
Changed our example gulpfile.js to be more specific on update task:
README.md
Sample gulpfile example:
Major changes
updatetask in sample gulpfile example for clarity.copyAssetstip to preferupdateUswdsand the copy task as an additional note.Closes #90.