From 8824161979f51e1422bea994f477bad24af5a9c5 Mon Sep 17 00:00:00 2001 From: Taylor Jones Date: Wed, 17 Aug 2022 13:59:21 -0500 Subject: [PATCH] fix(pictograms): deprecate icons, document replacement process (#11973) --- docs/developer-handbook.md | 8 ++++++++ packages/pictograms/deprecated.yml | 10 +++++++++- 2 files changed, 17 insertions(+), 1 deletion(-) diff --git a/docs/developer-handbook.md b/docs/developer-handbook.md index 982822290dfe..143582f8ba51 100644 --- a/docs/developer-handbook.md +++ b/docs/developer-handbook.md @@ -682,6 +682,14 @@ original name and add it to the corresponding `deprecated.yml` file. They can still contribute the newly named asset, and it is recommended that they specify the replacement for the icon in `deprecated.yml` under the `reason` field. +In the event that a change needs to be reflected immediately due to a change in +business relationship or other matter, the asset must still be deprecated and +not removed to avoid a breaking change. + +To reflect the change immediately, both the Carbon website and the IDL website +should be updated to no longer show the file in the icon or pictogram library. +[Here's an example PR](https://github.com/carbon-design-system/carbon-website/pull/2781) + ### Code Patterns #### Deprecating a component diff --git a/packages/pictograms/deprecated.yml b/packages/pictograms/deprecated.yml index 07a23b08390a..71eb7f938967 100644 --- a/packages/pictograms/deprecated.yml +++ b/packages/pictograms/deprecated.yml @@ -1 +1,9 @@ -deprecated: [] +deprecated: + - name: ibm--z-and-linuxone-multi-frame + reason: This icon has been replaced by ibm--z16--multi-frame + - name: ibm--z-and-linuxone-single-frame + reason: This icon has been replaced by ibm--z16--single-frame + - name: ibm--z + reason: This icon should no longer be used + - name: ibm--z--partition + reason: This icon should no longer be used