Skip to content

Commit 8824161

Browse files
authored
fix(pictograms): deprecate icons, document replacement process (#11973)
1 parent 082eb5a commit 8824161

File tree

2 files changed

+17
-1
lines changed

2 files changed

+17
-1
lines changed

docs/developer-handbook.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -682,6 +682,14 @@ original name and add it to the corresponding `deprecated.yml` file. They can
682682
still contribute the newly named asset, and it is recommended that they specify
683683
the replacement for the icon in `deprecated.yml` under the `reason` field.
684684

685+
In the event that a change needs to be reflected immediately due to a change in
686+
business relationship or other matter, the asset must still be deprecated and
687+
not removed to avoid a breaking change.
688+
689+
To reflect the change immediately, both the Carbon website and the IDL website
690+
should be updated to no longer show the file in the icon or pictogram library.
691+
[Here's an example PR](https://github.com/carbon-design-system/carbon-website/pull/2781)
692+
685693
### Code Patterns
686694

687695
#### Deprecating a component

packages/pictograms/deprecated.yml

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,9 @@
1-
deprecated: []
1+
deprecated:
2+
- name: ibm--z-and-linuxone-multi-frame
3+
reason: This icon has been replaced by ibm--z16--multi-frame
4+
- name: ibm--z-and-linuxone-single-frame
5+
reason: This icon has been replaced by ibm--z16--single-frame
6+
- name: ibm--z
7+
reason: This icon should no longer be used
8+
- name: ibm--z--partition
9+
reason: This icon should no longer be used

0 commit comments

Comments
 (0)