USWDS-Site - About: Move release notes section to What’s New #2318

mahoneycm · 2023-10-25T14:59:50Z

Summary

Moved release notes section into the what’s new page and adds a note about subscribing to releases on GitHub. This PR also removes the two column layout from the What’s New page to accommodate for the new section.

Related issue

Closes #2136

Preview link

What’s new →

Problem statement

The current Release Notes page improperly displays release notes that are pulled in from GitHub.

Solution

Since this is a low traffic page, we’ve opted to move release notes information to the What’s New page and directly link out to GitHub release notes.

From our Office Hours meeting notes (Google Docs 🔒):

Conclusion: Remove release notes page. Forward the release notes url to “what’s new” page. Add a release notes section to the what’s new page. In that section, add link to release notes in github and info about subscribing to releases.

Testing and review

Visit What’s New page.
Confirm content appropriately informs users of where to find release notes as well as how to subscribe to releases.
Check grammar, punctuation, and spelling.
Approve of page layout.
Inspect community page.
Confirm external link buttons have launch icon and appropriate margins.
Confirm “Release notes” page is removed from site navigation.
Confirm there are no links to the release notes page.

Testing checklist

Information on release notes is properly conveyed.
Information on how to subscribe to releases is clear and easy to follow.
What’s New page is well presented.
Prose descendant external links styled as buttons have external link icon.
Standard external links unaffected by this change.
Internal links styled as buttons unaffected by this change.
No grammatical or spelling errors.
Expected redirects are present and working properly.
HTMLProofer runs without error.

…GH releases page

amyleadem

Confirmed that the releases page was removed from the site
Confirmed that redirects have been set up and links to the releases page have been updated
- There is still a reference to the whats-new/releases page on the implementations page and crawl.js
Confirmed that the new content makes sense and is free from error
- I added some notes for possible improvements. I think it would also be good if @finekatie or @sarah-sch could take a look to see if this is the right copy for the page. I've tagged you both as reviewers in case you are able to take a look!

pages/whats-new/overview.md

_security_updates/2021-10-27-santized-combo-box-content.md

_security_updates/2021-11-1-automatic-sanitizing-for-all-javascript-components.md

pages/whats-new/overview.md

pages/documentation/implementations.md

pages/whats-new/overview.md

mahoneycm

Resolved remaining references to whats-new/releases, corrected release notes links, and updated copy for new Releases section.

Thanks for the recommendations @amyleadem @finekatie

mahoneycm · 2023-11-06T16:08:19Z

External link button

I realized that since the button is an external link, it should include the external link class and launch icon.

The icon is not displaying currently and I'm working to resolve it now.

Current:

Expected behavior:

mahoneycm · 2023-11-06T16:34:53Z

External link button cont.

It looks like we're overriding the external link styles for buttons on site:

uswds-site/css/_uswds-theme-custom-styles.scss

Lines 1218 to 1224 in b5eabb1

    
           .usa-button, 
        
           .link-download, 
        
           .media__link { 
        
             &#{$external-href}::after { 
        
               display: none; 
        
             } 
        
           }

If we remove usa-button from that style definition it displays properly.

Can you think of a reason we wouldn't want the external link icon on external links styled as buttons?

@amyleadem @mejiaj

…iscrepency

amyleadem · 2023-11-07T19:17:55Z

@mahoneycm I like the idea of including the external link icon when usa-button points to an href outside our domain. I did a quick trial of just removing the .usa-button from that style rule (line 1218) and immediately noticed that the github icon in the nav header received an external link icon. I'm wondering if we should either narrow the "display:none" rule to just where it is needed or do an override just for something like usa-buttons inside of usa-prose.

cc: @mejiaj

mahoneycm · 2023-11-08T16:12:40Z

External link buttons styles

Ok I added some styles specific to external links styled as buttons which are descendants of usa-prose (Thanks for the idea @amyleadem !)

Additionally, I skimmed through parts of the site for other external links styled as buttons and noticed some visual discrepancies brought on by utility classes. With these additional styles I was able to safely remove the utility classes 👍

I also added the site-button class to match other site buttons.

Screenshots

Community page before:

Community page after:

amyleadem

Looking good! Just a couple of small things for your consideration.

pages/about/community.md

css/_uswds-theme-custom-styles.scss

…ate external link button styles to match

…tes-update

amyleadem · 2023-11-21T14:42:11Z

Realized that this PR does not have a changelog. Will work on adding one now.

amyleadem · 2023-11-21T14:51:15Z

Update: Added a changelog. Also re-instated the in-page nav on the page now that the content is longer and laid out in a more vertical format.

mejiaj

Minor comment on external links check. Also found this quirk when clicking on Sidenav What's new:

How to reproduce

Visit Preview →
In sidenav, confirm two missing sections Latest Updates and Empty link.

sarah-sch

Suggesting updated language for first paragraph under "Release notes."

sarah-sch · 2023-11-21T15:13:56Z

pages/whats-new/overview.md

-{% capture blog %}
+## Release notes
+
+You can find summaries of bug fixes, new features, and other updates introduced in each release on our [GitHub releases page](https://github.com/uswds/uswds/releases).


New suggestion for first paragraph, but interested to know if @finekatie has any tweaks:

Find summaries of each USWDS update on our GitHub releases page. Release notes explain bug fixes, new features, and other changes.

Updated in 11a0ab7

finekatie · 2023-11-21T15:19:10Z

Information on release notes is properly conveyed.
Information on how to subscribe to releases is clear and easy to follow.
No grammatical or spelling errors.

I do notice that the first CTA goes to live link. The other two go to federalist links. Is that because the changes/updates are being made to the Release Notes section only?

mahoneycm · 2023-11-27T16:53:51Z

Minor comment on external links check. Also found this quirk when clicking on Sidenav What's new:
**How to reproduce**

Visit Preview →

In sidenav, confirm two missing sections Latest Updates and Empty link.

@mejiaj this seems to have been resolved with Amy's fix in cffa8d3

mahoneycm · 2023-11-29T19:14:06Z

@finekatie @sarah-sch Ready for re-review!

And to answer your question Katie

I do notice that the first CTA goes to live link. The other two go to federalist links. Is that because the changes/updates are being made to the Release Notes section only?

The two Federalist links are due to them being internal links. Since the new CTA is to GitHub, it'll actually take you to the live site 👍

finekatie

Charlie answered my question about CTA links, so I have no other input. Ok from here.

sarah-sch

Approving changes--looks good.

…tes-update

thisisdano

A nice improvement

_data/changelogs/about-whats-new.yml

mahoneycm added 6 commits October 24, 2023 12:54

Remove release note markdown and subnav links. Replaced with link to …

a21cf14

…GH releases page

Remove release note page and create section on whats new page

9d04532

Remove two column layout

d712e7c

Update release subscription instructions

a6ecb84

Use markdown links

c5d814e

Replace release note links with GH links

08d40c9

mahoneycm requested review from mejiaj and amyleadem October 25, 2023 14:59

Update package-lock

5c929be

amyleadem requested changes Oct 31, 2023

View reviewed changes

amyleadem requested review from sarah-sch and finekatie October 31, 2023 20:53

mahoneycm added 3 commits November 6, 2023 10:08

Remove references to whats-new/releases

5e21d58

Update What's new page release notes section

34e5698

Correct 2.12.2 links

e000bc2

mahoneycm commented Nov 6, 2023

View reviewed changes

pages/whats-new/overview.md Show resolved Hide resolved

pages/documentation/implementations.md Show resolved Hide resolved

pages/whats-new/overview.md Outdated Show resolved Hide resolved

mahoneycm commented Nov 6, 2023

View reviewed changes

mahoneycm requested a review from amyleadem November 6, 2023 15:41

Resolve visual discrepency

3600d87

Add external link class to GH release notes button, resolve display d…

2d72b36

…iscrepency

mahoneycm added 2 commits November 8, 2023 10:56

Create external link as button style definitions

ef07bdd

Normalize external link button classes

f2b3c58

amyleadem requested changes Nov 13, 2023

View reviewed changes

pages/about/community.md Outdated Show resolved Hide resolved

css/_uswds-theme-custom-styles.scss Outdated Show resolved Hide resolved

mahoneycm added 3 commits November 14, 2023 13:18

Remove site-button class from outline button

024d4d1

Expand external-href to include touchpoints and federalist links; upd…

b705372

…ate external link button styles to match

Merge branch 'main' of github.com:uswds/uswds-site into cm-release-no…

14af9c8

…tes-update

amyleadem added 2 commits November 21, 2023 07:47

Add changelog

7e44eed

Re-instate in-page nav

5beb064

mejiaj requested changes Nov 21, 2023

View reviewed changes

sarah-sch requested changes Nov 21, 2023

View reviewed changes

Fix front matter formatting

cffa8d3

finekatie mentioned this pull request Nov 21, 2023

Add OCC.gov, helpwithmybank.gov and careers.occ.gov to Showcase #2115

Closed

mahoneycm added 2 commits November 27, 2023 11:10

Update Release notes section first paragraph

11a0ab7

Update federalist href targets

e0ffd5c

mahoneycm requested a review from sarah-sch November 27, 2023 16:53

mahoneycm requested a review from mejiaj November 27, 2023 16:54

mejiaj approved these changes Nov 29, 2023

View reviewed changes

finekatie approved these changes Dec 4, 2023

View reviewed changes

sarah-sch approved these changes Dec 4, 2023

View reviewed changes

mahoneycm requested a review from thisisdano December 5, 2023 21:25

mahoneycm added 4 commits December 12, 2023 11:37

Merge branch 'main' of github.com:uswds/uswds-site into cm-release-no…

5e21478

…tes-update

Generate package-lock

79869d3

Merge branch 'main' of github.com:uswds/uswds-site into cm-release-no…

8199b10

…tes-update

Generate package-lock.json

4be167d

thisisdano approved these changes Feb 26, 2024

View reviewed changes

thisisdano reviewed Feb 26, 2024

View reviewed changes

_data/changelogs/about-whats-new.yml Outdated Show resolved Hide resolved

thisisdano and others added 3 commits February 26, 2024 15:42

Use current date

6e51bf4

Merge branch 'main' into cm-release-notes-update

56a67df

Remove link since this URL is no longer active

1075395

thisisdano merged commit ddd921b into main Feb 27, 2024
11 checks passed

thisisdano deleted the cm-release-notes-update branch February 27, 2024 00:23

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

USWDS-Site - About: Move release notes section to What’s New #2318

USWDS-Site - About: Move release notes section to What’s New #2318

mahoneycm commented Oct 25, 2023 •

edited

Loading

amyleadem left a comment

mahoneycm left a comment

mahoneycm commented Nov 6, 2023

mahoneycm commented Nov 6, 2023

amyleadem commented Nov 7, 2023 •

edited

Loading

mahoneycm commented Nov 8, 2023

amyleadem left a comment

amyleadem commented Nov 21, 2023

amyleadem commented Nov 21, 2023

mejiaj left a comment •

edited

Loading

sarah-sch left a comment

sarah-sch Nov 21, 2023

mahoneycm Nov 27, 2023

finekatie commented Nov 21, 2023

mahoneycm commented Nov 27, 2023

mahoneycm commented Nov 29, 2023

finekatie left a comment

sarah-sch left a comment

thisisdano left a comment

USWDS-Site - About: Move release notes section to What’s New #2318

USWDS-Site - About: Move release notes section to What’s New #2318

Conversation

mahoneycm commented Oct 25, 2023 • edited Loading

Summary

Related issue

Preview link

Problem statement

Solution

Testing and review

Testing checklist

amyleadem left a comment

Choose a reason for hiding this comment

mahoneycm left a comment

Choose a reason for hiding this comment

mahoneycm commented Nov 6, 2023

External link button

mahoneycm commented Nov 6, 2023

External link button cont.

amyleadem commented Nov 7, 2023 • edited Loading

mahoneycm commented Nov 8, 2023

External link buttons styles

amyleadem left a comment

Choose a reason for hiding this comment

amyleadem commented Nov 21, 2023

amyleadem commented Nov 21, 2023

mejiaj left a comment • edited Loading

Choose a reason for hiding this comment

sarah-sch left a comment

Choose a reason for hiding this comment

sarah-sch Nov 21, 2023

Choose a reason for hiding this comment

mahoneycm Nov 27, 2023

Choose a reason for hiding this comment

finekatie commented Nov 21, 2023

mahoneycm commented Nov 27, 2023

mahoneycm commented Nov 29, 2023

finekatie left a comment

Choose a reason for hiding this comment

sarah-sch left a comment

Choose a reason for hiding this comment

thisisdano left a comment

Choose a reason for hiding this comment

mahoneycm commented Oct 25, 2023 •

edited

Loading

amyleadem commented Nov 7, 2023 •

edited

Loading

mejiaj left a comment •

edited

Loading