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: Add consolidated changelog to what's new page #3118

Draft
wants to merge 41 commits into
base: al-whats-new-updates-feature-branch
Choose a base branch
from

Conversation

amyleadem
Copy link
Contributor

@amyleadem amyleadem commented Feb 19, 2025

Summary

Added a consolidated changelog to the What's new page. This allows design system users know what's changed across the design system.

Note

This PR updates the solution created in PR #3091. This PR:

Related issue

Closes #1829

Preview link

Problem statement

It's important that design system users know how the design system is changing. We have changelogs on individual pages, but there's currently no way to see all the changes in a single view.

There've been many changes to the design system in the last couple weeks, and we've recently added content change alerts to content affected by recent executive orders and policy guidance.

Solution

Add a view to the What's New page so design system users know what's changed across the design system.

This PR adds a consolidated changelog to our What's New page so design system users can better keep up to date with these changes. This new view will show the last 250 changes to the design system.

Major changes

  • Created a new consolidated changelog feed that pulls in data from all changelog files and sorts them in reverse chronological order
  • Added new "affects" tags: isAddition, isRemoval, affectsPageContent, affectsLinks and added these tags to appropriate changelog entries
  • Added "page" data for the consolidated changelog

Testing and review

  • Confirm the entries in the consolidated changelog are displaying the expected data
    • Confirm all changelog entries display the appropriate "page" name
  • Confirm the consolidated changelog is readable at all screen widths on both the what's new page and the USWDS changelog page
  • Confirm the new "affects" tags make sense, display appropriately, and have been added to the appropriate changelog entries
  • Confirm no regressions in the changelogs on other pages
  • Confirm that there is not a better alternative for setting the page title in each changelog entry
  • Confirm the updated README content is accurate

@amyleadem amyleadem changed the base branch from al-whats-new-updates-feature-branch to dw-whats-new-newsfeed February 19, 2025 16:09
@amyleadem amyleadem changed the base branch from dw-whats-new-newsfeed to al-whats-new-updates-feature-branch February 21, 2025 22:33
@amyleadem amyleadem linked an issue Feb 24, 2025 that may be closed by this pull request
summary: Removed pronouns pattern.
summaryAdditional: Removed content related to the January 20, 2025 Executive Order, \"Defending Women from Gender Ideology Extremism And Restoring Biological Truth To The Federal Government\".
affectsGuidance: true
isBresaking: true
isBreaking: true
Copy link
Contributor Author

Choose a reason for hiding this comment

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

suggestion: It seems like this page should receive isRemoval

Suggested change
isBreaking: true
isBreaking: true
isRemoval: true

Latest code, guidance, and content updates across the design system.

<div class="margin-top-2">
{% include consolidated-changelog-table.html hideTagsTablet=true %}
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Note

Added hideTagsTablet here because the in-page nav on the what's new page makes the table too narrow to be readable at tablet widths. This hides all the "Affects" column at tablet widths but still shows the breaking tag in the description column. This matches the existing behavior in changelog-table.html.

On the changelog page, there is more room so the tags remain visible at all widths.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

USWDS-Site - What's new: Prototype collected changelogs
3 participants