Skip to content

Commit

Permalink
fix(pictograms): deprecate icons, document replacement process (#11973)
Browse files Browse the repository at this point in the history
  • Loading branch information
tay1orjones authored Aug 17, 2022
1 parent 082eb5a commit 8824161
Show file tree
Hide file tree
Showing 2 changed files with 17 additions and 1 deletion.
8 changes: 8 additions & 0 deletions docs/developer-handbook.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
10 changes: 9 additions & 1 deletion packages/pictograms/deprecated.yml
Original file line number Diff line number Diff line change
@@ -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

0 comments on commit 8824161

Please sign in to comment.