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

USWDS-Site - Feature: Improve gulp updateUswds guidance on site #2952

Open
2 tasks done
mahoneycm opened this issue Nov 7, 2024 · 1 comment
Open
2 tasks done

USWDS-Site - Feature: Improve gulp updateUswds guidance on site #2952

mahoneycm opened this issue Nov 7, 2024 · 1 comment
Labels
Affects: Guidance Relates to guidance Is: New Guidance A feature request for new guidance Needs: Discussion We need to discuss an approach to this issue Status: Triage We're triaging this issue and grooming if necessary Type: Feature Request New functionality

Comments

@mahoneycm
Copy link
Contributor

mahoneycm commented Nov 7, 2024

Is your feature request related to a problem? Please describe.

Guidance for updating USWDS on site may be limited. We received a ticket in ZenDesk from a user who requested guidance when updating to a new minor version of USWDS.

Describe the solution you'd like

1. Improve on site guidance of updateUswds

We include this guidance in the USWDS-Compile readme. For added visibility, we should consider adding this to the website. Potentially on the Phase 2: Compile guidance page.

Stay up-to-date with USWDS with updateUswds. When updating your project's version of USWDS, run the npx gulp updateUswds command to copy any updated USWDS assets into your project. Alternatively, you can run the copyAssets task. These tasks update USWDS static assets (like images, fonts, and compiled JavaScript) and will not override any of your project customizations. These actions might introduce breaking changes, so be sure to check out the related USWDS releases notes for any additional tasks that must be completed when updating to a new version of USWDS.

2. Add steps to check for updates and breaking changes

Currently we have the Release notes section of the What's New page that points users to our GH release notes. We could consider adding additional guidance to outline the steps to update USWDS

Ex:

  1. Check the GitHub releases page for updates
  2. Compare to your version of USWDS
  3. Install the latest using npm
  4. Follow release notes guidance for potentially breaking changes and updates
  5. run updateUswds script.

Describe alternatives you've considered

No response

Additional context

Related ZenDesk ticket 🔒

Code of Conduct

@mahoneycm mahoneycm added Affects: Guidance Relates to guidance Is: New Guidance A feature request for new guidance Needs: Confirmation We need to confirm that this is an issue Needs: Discussion We need to discuss an approach to this issue Type: Feature Request New functionality labels Nov 7, 2024
@github-actions github-actions bot added the Status: Triage We're triaging this issue and grooming if necessary label Nov 7, 2024
@amyleadem amyleadem removed the Needs: Confirmation We need to confirm that this is an issue label Nov 14, 2024
@mahoneycm
Copy link
Contributor Author

From Dev sync: The newly added pencil icons in the USWDS Release Notes aim to signal when changes require manual updates from users. This will help amplify when asset changes are made / when the updateUswds scripts are needed.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Affects: Guidance Relates to guidance Is: New Guidance A feature request for new guidance Needs: Discussion We need to discuss an approach to this issue Status: Triage We're triaging this issue and grooming if necessary Type: Feature Request New functionality
Projects
Status: No status
Development

No branches or pull requests

2 participants