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

Add Figma Changelog entry for 4.15.0 #2622

Merged
merged 12 commits into from
Jan 9, 2025

Conversation

andgen404
Copy link
Contributor

@andgen404 andgen404 commented Dec 20, 2024

📌 Summary

If merged, this PR will add a Figma Changelog entry for 4.15.0.

🔗 External links

Jira ticket: HDS-4303


Copy link

vercel bot commented Dec 20, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Updated (UTC)
hds-showcase ✅ Ready (Inspect) Visit Preview Jan 6, 2025 5:02pm
hds-website ✅ Ready (Inspect) Visit Preview Jan 6, 2025 5:02pm

Copy link
Contributor

@jorytindall jorytindall left a comment

Choose a reason for hiding this comment

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

I'd recommend nailing down a more concise/streamlined format for the deprecation/release lines about the libraries, and use that format consistently across each line item. Left a few other small comments on language for conciseness.

Copy link
Contributor

@heatherlarsen heatherlarsen left a comment

Choose a reason for hiding this comment

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

Left a few comments. Mostly about how these are organized and formatted.

Comment on lines 6 to 16
`[Figma Library v1.0](https://www.figma.com/design/noyY6dUMDYjmySpHcMjhkN/HDS-Components?m=auto&node-id=2-7&t=CPG3tlUvMHeQdEos-1)` - **Deprecated**. It will no longer receive updates or support. Instead, use the `[Figma Library v2.0](https://www.figma.com/design/iweq3r2Pi8xiJfD9e6lOhF/HDS-Components-v2.0?m=auto&node-id=2-7&t=9BNZJMDOrABsgaJQ-1)`

`Figma Library 2.0` - Released. Figma Library link

`Foundations Library 1.0` - **Deprecated**. It will no longer receive updates or support.

`Foundations Library 2.0` - Released.

`Product Patterns 1.0` - **Deprecated**. It will no longer receive updates or support.

`Product Patterns 2.0` - Released. Figma Library link
Copy link
Contributor

@heatherlarsen heatherlarsen Dec 23, 2024

Choose a reason for hiding this comment

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

  1. Let's use the official name of the files.
  2. Components and Foundations have separate sections in the release notes. Foundation updates should be moved to the Foundations section.
  3. We'll need to add a new Patterns section.
  4. There was no Patterns 1.0 to deprecate.
  5. Let's keep the same formatting throughout.
  6. Figma library link is above, so don't think it needs to be duplicated here.
Suggested change
`[Figma Library v1.0](https://www.figma.com/design/noyY6dUMDYjmySpHcMjhkN/HDS-Components?m=auto&node-id=2-7&t=CPG3tlUvMHeQdEos-1)` - **Deprecated**. It will no longer receive updates or support. Instead, use the `[Figma Library v2.0](https://www.figma.com/design/iweq3r2Pi8xiJfD9e6lOhF/HDS-Components-v2.0?m=auto&node-id=2-7&t=9BNZJMDOrABsgaJQ-1)`
`Figma Library 2.0` - Released. Figma Library link
`Foundations Library 1.0` - **Deprecated**. It will no longer receive updates or support.
`Foundations Library 2.0` - Released.
`Product Patterns 1.0` - **Deprecated**. It will no longer receive updates or support.
`Product Patterns 2.0` - Released. Figma Library link
**Deprecated** HDS Components UI Kit v1.0. It will no longer receive updates or support.
Released HDS Components UI Kit v2.0.

Copy link
Contributor

Choose a reason for hiding this comment

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

@andgen404 it looks like a few of these were missed.

  • Foundation updates should be moved to the Foundations section.
  • We'll need to add a new Patterns section.

Do you know what needs to be done, or would you like to pair?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Yes, I think pairing on this would be helpful. Thank you!


`Product Patterns 2.0` - Released. Figma Library link

`HDS Wireframes` - Released. Figma Library link
Copy link
Contributor

Choose a reason for hiding this comment

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

Let's also create a new section for other HDS UI Kits (HDS Wireframes, HDS Utilities, HDS A11y Helper Annotations, etc) and include this line there.

Suggested change
`HDS Wireframes` - Released. Figma Library link

Copy link
Contributor

@heatherlarsen heatherlarsen Jan 2, 2025

Choose a reason for hiding this comment

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

This appears to have been missed, so I've reopened it.


`HDS Wireframes` - Released. Figma Library link

`SideNav` - No longer deprecated due to adjustments in prioritization.
Copy link
Contributor

Choose a reason for hiding this comment

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

Curious what others think, but should we just remove the old line about the component being deprecated from the earlier entry?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Majed, Jory, and I discussed this on Friday (Dec 20th) and agreed that it makes sense to keep this for historical records. However, we should include information about this deprecation in the new releases.

Copy link
Contributor

Choose a reason for hiding this comment

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

What new releases?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Oh, I meant to add this snippet of information to the Changelog update.

@KristinLBradley
Copy link
Contributor

Merging in the latest main should fix the Percy visual diffs btw.

@jorytindall
Copy link
Contributor

Merging in the latest main should fix the Percy visual diffs btw.

@andgen404 let me know if you want to pair on getting this fixed and passing

shleewhite
shleewhite previously approved these changes Jan 2, 2025
</p>

### December 20th, 2024

`IconTile` - Removed the border and updated the colors for improved contrast and to create a cohesive look that aligns better with the surrounding elements.
Copy link
Contributor

Choose a reason for hiding this comment

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

Were the changes to create cohesion or distinction?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

The changes were to create cohesion

Copy link
Contributor

Choose a reason for hiding this comment

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

I'd argue the change was made to better distinguish the IconTile from other elements, so distinction would probably be more correct.

Copy link
Contributor

Choose a reason for hiding this comment

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

+1 to what Jory has outlined.

Co-authored-by: Kristin Bradley <kristin.bradley@hashicorp.com>
Co-authored-by: Heather Larsen <hlarsen@hashicorp.com>
Copy link
Contributor

@heatherlarsen heatherlarsen left a comment

Choose a reason for hiding this comment

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

:shipit:

Copy link
Contributor

@jorytindall jorytindall left a comment

Choose a reason for hiding this comment

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

Thanks for the work responding to this feedback, @andgen404 !

@andgen404 andgen404 merged commit 827692c into main Jan 9, 2025
14 checks passed
@andgen404 andgen404 deleted the Add-Figma-Changelog-entry-for-4.15.0 branch January 9, 2025 17:34
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs-website Content updates to the documentation website packages/components
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants