carbon-website icon indicating copy to clipboard operation
carbon-website copied to clipboard

[Status indicators] Updating the naming convention of the status icons and shapes

Open thyhmdo opened this issue 4 years ago • 8 comments

Lots of Status indicators icons have not been updated on our Icons page. Status indicators: https://www.carbondesignsystem.com/patterns/status-indicator-pattern/#shape-indicators


Missing icons:

High attention

  • [x] Failure
  • [x] Warning alt
  • [x] Caution major
  • [x] Caution minor

Medium attention

  • [x] Normal
  • [x] Normal-alt
  • [x] Success
  • [x] Not started

Low attention

  • [x] Warning alt
  • [x] Information alt

Status indicators

  • [x] High severity
  • [ ] Medium severity (This looks like the name of the asset is diamond-fill on the icons page)
  • [ ] Undefined (This looks like the name of the asset is diamond-fill on the icons page)
  • [x] Stable
  • [x] New
  • [x] Information
  • [ ] Incomplete (Still not on the icons page)
  • [ ] Draft (This looks like the name of the asset is circle-stroke on the icons page)

### Tasks
- [ ] Consider proposing new icon asset names to match pattern guidance (design) (*Note in issue: Make sure there is no overlap of new names for these icons that already exist for other icons in the system, if so we need to change those names as well.)
- [ ] Consider adding a column for the icon token names (svgs in the icon library)

thyhmdo avatar Aug 24 '21 15:08 thyhmdo

Seems like part of the issue with incomplete is that we have both a 32 variant and a glyph variant, but they are completely different icons, causing issues

tw15egan avatar Aug 24 '21 16:08 tw15egan

https://github.com/carbon-design-system/carbon-website/issues/3310 Undefined icon needs to be updated

thyhmdo avatar Nov 16 '21 21:11 thyhmdo

turned out that we have most of status icons on the Icons page, but they're named differently. People may have difficulty finding icons due to naming. We also have extra icons, wondering if we need to clean them up or leave them as they are.

image

thyhmdo avatar Nov 19 '21 16:11 thyhmdo

image

thyhmdo avatar Nov 19 '21 17:11 thyhmdo

Icons that should be considered to be renamed / kept

Status icons

  • [ ] Failure (currently error)
  • [ ] Warning alt (currently warning hex)
  • [ ] Caution major (currently warning-alt-inverted)
  • [ ] Caution minor (currently warning-alt)
  • [ ] Normal (currently checkmark filled/outlined)
  • [ ] Normal alt (currently checkmark)
  • [ ] Success (currently checkmark filled / outlined)
  • [ ] Information alt (currently information square)

Shape icons

  • [ ] Failure (currently critical)
  • [ ] Critical severity (currently critical severity)
  • [ ] High severity (currently caution)
  • [ ] Stable (currently circle fill)
  • [ ] New (currently circle fill)
  • [ ] Information (currently low severity, square fill)
  • [ ] Draft (currently circle stroke)

thyhmdo avatar Dec 13 '21 21:12 thyhmdo

Jeannie and I discussed this issue with Conrad. Here is what he said:

It’s not impossible to rename assets, it’s just that Github considers renamed assets net new so the old icon would effectively be “removed” and would have to be deprecated in favor of the renamed version even though there’s actually only a single file all along. So it’s totally doable to do a pass on certain icons and rename them. (edited) Someone on the Carbon team could make the changes in the Carbon repo easily enough without having to remove/add any of the files the only thing you’d have to be careful about is the fallout of products using the old name of icons especially since the status icons are so widely used (edited)

So the next step for us is to audit and strategically rename these icons again. However, we don't have the bandwidth to do this work. @sstrubberg Can you help us icebox this issue at the moment?

Meanwhile, I and Jeannie are going to create other issues related to Status indicators regarding the correct status colors and v11 tokens.

thyhmdo avatar Jan 10 '23 21:01 thyhmdo

@thyhmdo Will look at this issue to see if it has been resolved since it was created, or if there are still some action items to tackle.

laurenmrice avatar Jun 27 '24 14:06 laurenmrice

If there are icons that need to be renamed, we can only do that through a breaking change.

Also in some cases we may already have an icon with that name. For instance from above, warning hex would be renamed to warning alt, but we already have a warning alt

The only thing we've done without a breaking change is swap out the artwork under the same name.

tay1orjones avatar Jun 27 '24 14:06 tay1orjones