-
Notifications
You must be signed in to change notification settings - Fork 142
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 3.0 - Migration page: format optimization section and copy edits #1558
Conversation
@@ -178,7 +176,7 @@ Add this load path to your compiler settings, or update any old paths if your co | |||
</h4> | |||
<div id="m-a6" class="usa-accordion__content site-prose"> | |||
<ol> | |||
<li>How do you know you're using USWDS Gulp? Search for a line like <code>const uswds = require("./node_modules/uswds-gulp/config/uswds");</code> or <code>const uswds = "node_modules/uswds/dist"</code> in your Gulp setup. This indicates that you're using the Gulp setup we distributed as USWDS Gulp.</li> |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Gulp
is not capitalized on the gulp website https://gulpjs.com/. Made all references lowercase except for references to USWDS Gulp
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Agreed
<h4 class="usa-accordion__heading"> | ||
<button class="usa-accordion__button" aria-controls="m-a9"> | ||
If you're using Webpack |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
webpack
is not capitalized on the webpack website https://webpack.js.org/
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
agreed
@@ -115,7 +115,6 @@ Your `package.json` file will display the version of USWDS in a line like `"uswd | |||
|
|||
Your theme files will have a version number at the top, under the image of the American flag. Note these versions so we can make the proper updates in [Step 4: Integrate any recent USWDS changes](#4-integrate-any-recent-uswds-changes), below. | |||
|
|||
{:.site-terminal} |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Removed site-terminal
styles throughout for consistency in appearance
``` | ||
|
||
Now your project is using its theme settings in the proper USWDS 3.0 format! Now you can remove the old theme files from your project. | ||
Now your project is using its theme settings in the proper USWDS 3.0 format! You can safely remove the old theme files from your project. | ||
|
||
#### Use "uswds-core" for any custom USWDS Sass |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Reformatted the USWDS-core section and Optimization sections to include and highlight steps for accomplishing the task
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Agreed
- text: 6. Optimize your installation with component packages | ||
href: '#6-optimize-your-installation-with-component-packages' | ||
- text: 6. Optimize your installation | ||
href: '#6-optimize-your-installation' |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I renamed this section because its content included instruction for more than just component packages.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Nice one!
Fine with me. I didn't weigh in on the removing the terminal style, since I'm not sure of the implications of that. Is it in the content or the stylesheet? |
@bonnieAcameron This is just the class that changed the style from a gray box with smaller text to a black box with bigger text. Hope that explanation helps! |
Preview link
Migration guide 3.0
Description
Updates to USWDS 3.0 migration guide
I included some small changes like typo-correction and general style formatting, as well as larger changes like restructuring the "USE “USWDS-CORE” FOR ANY CUSTOM USWDS SASS" and "Optimize your installation with component packages" sections to include clear steps for accomplishing the task.