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

feat(pictograms): replaced watson--avatar with ibm--watson, and added ibm--cloud #6294

Conversation

dudley-ibm
Copy link
Contributor

Closes #

{{closes enterprise issue #46}}

Changelog

New

  • {{ibm--cloud}}

Changed

  • {{ibm--watson is new artwork that replaces watson--avatar}}

Removed

  • {{watson--avatar}}

@dudley-ibm dudley-ibm requested a review from a team as a code owner June 16, 2020 17:01
@ghost ghost requested review from aledavila and joshblack June 16, 2020 17:01
@netlify
Copy link

netlify bot commented Jun 16, 2020

Deploy preview for carbon-elements ready!

Built with commit d0be1aa

https://deploy-preview-6294--carbon-elements.netlify.app

@netlify
Copy link

netlify bot commented Jun 16, 2020

Deploy preview for carbon-components-react ready!

Built without sensitive environment variables with commit d0be1aa

https://deploy-preview-6294--carbon-components-react.netlify.app

@dudley-ibm dudley-ibm requested a review from a team as a code owner June 17, 2020 21:07
@aledavila aledavila changed the title replaced watson--avatar with ibm--watson, and added ibm--cloud feat(pictograms): replaced watson--avatar with ibm--watson, and added ibm--cloud Jun 17, 2020
Copy link
Contributor

@joshblack joshblack 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 contribution @dudley-ibm! One quick note, unfortunate we can't remove things from the package without it being a breaking change. For the Watson Avatar, we'll need to keep the existing asset in place and then add it the deprecated.yml so that folks know what to use instead and then we can remove it in the next major version

@dudley-ibm
Copy link
Contributor Author

@joshblack please clarify what steps I need to take.
There will be many instances where an existing SVG will need to be removed when it is either replaced by updated artwork or replaced by a newly named piece of artwork. Are you guys moving it to this depracated.yml or is that something I'm supposed to be doing?

@joshblack
Copy link
Contributor

Hey @dudley-ibm! For a quick overview of deprecation, you can check out: https://github.com/carbon-design-system/carbon/blob/master/packages/pictograms/docs/contributing.md#deprecatedyml

Basically the flow can be summarized as:

  • You all decide that an asset should be renamed or removed
  • If renamed, add the newly named version but do not remove the existing asset
  • Add the name of the icon to deprecated.yml

The most important thing is that we don't remove any assets that are already being used in code as it would break teams depending on that icon. Instead, with the deprecation flow, we warn teams that the asset is deprecated and suggest alternatives to be used. The icons are then removed in the next major release of the library.

So on your end, when handling renames it will be following that process above. Similar for removals. The last step will be for you to add the name to deprecated.yml and then write out any replacements. As an example, you can check out deprecated.yml for icons here: https://github.com/carbon-design-system/carbon/blob/master/packages/icons/deprecated.yml

@tw15egan tw15egan force-pushed the new-ibm-cloud-updated-ibm-watson branch from 33a004c to cf6d0be Compare July 20, 2020 20:10
@tw15egan
Copy link
Collaborator

tw15egan commented Jul 20, 2020

Fixed merge conflicts, re-added the deprecated pictogram and added watson--avatar to deprecated.yml

@tw15egan tw15egan requested a review from joshblack July 20, 2020 20:42
@kodiakhq kodiakhq bot merged commit eebf8aa into carbon-design-system:master Jul 23, 2020
@dudley-ibm
Copy link
Contributor Author

@joshblack the Cloud logo is still not showing up nor is the updated file for the Watson logo. Please let me know what else I need to do on my end to make that happen.

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

Successfully merging this pull request may close these issues.

4 participants