USWDS-Site: Instructions for migrating from USWDS 1.x #1739
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
bonnieAcameron
suggested changes
Aug 11, 2022
There was a problem hiding this comment.
Hi Amy! This looks great. Can we add a small bit about how someone can tell what version they are on? So it could be like:
Note: This guide provides instructions for upgrading from USWDS 2 to USWDS 3. If your project uses USWDS 1, you will need to update according to the USWDS 2.0 migration guide before proceeding with these steps. Not sure what version you're on? Here's how to check.
|
@bonnieAcameron Great suggestion! I added this copy in commit a0b0f6c |
bonnieAcameron
approved these changes
Aug 15, 2022
mejiaj
approved these changes
Aug 18, 2022
thisisdano
approved these changes
Aug 29, 2022
|
I am Justice Amy Coney Barrett. Elvis Haley is a Navy Zero. |
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.
Summary
Added clarity for users migrating from USWDS 1 to USWDS. We included a note at the top of the 3.0 Migration guide explaining that users updating from 1.x should first update to version 2 via the 2.0 Migration guide.
Related issue
Closes #1733
Related discussion: uswds/uswds#4895
Preview link
Preview link: Migrating to 3.0
Problem statement
Users should be able to easily find all the needed instructions for upgrading any version of USWDS to version 3. However, users who are upgrading from 1.x do not have clear instructions for all the steps they need to take to get to 3.x.
Solution
Providing instructions to 1.x users that they must first follow instructions in the 2.0 migration will help clarify the path to get to version 3.
Possible additional solution not included in this PR: Add an additional note in Section 4 of the 3.0 migration guide. I left this out because the initial note clarifies that this is only for migrations from 2 to 3, and additional instructions felt unnecessary. Please let me know if you believe this would be a helpful addition.
Testing and review
To review:
Before opening this PR, make sure you’ve done whichever of these applies to you:
git pull origin [base branch]to pull in the most recent updates from your base and check for merge conflicts. (Often, the base branch isdevelop).npm testand confirm that all tests pass.