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

Add a category to the icons yml file for each icon #2672

Closed
chrisconnors-ibm opened this issue May 10, 2019 · 15 comments
Closed

Add a category to the icons yml file for each icon #2672

chrisconnors-ibm opened this issue May 10, 2019 · 15 comments
Assignees
Labels
package: elements @carbon/elements package: sketch @carbon/sketch
Milestone

Comments

@chrisconnors-ibm
Copy link
Contributor

chrisconnors-ibm commented May 10, 2019

edit https://github.com/carbon-design-system/carbon/blob/master/packages/icons/metadata.yml#L5

to add the categories reflected here: https://www.ibm.com/design/language/elements/icon-library/

Action
Controls
Data
File
Formatting
Image
Navigation
Social
Status
Toggle
User

For each icon

@chrisconnors-ibm
Copy link
Contributor Author

@jeanservaas @aagonzales @shixiedesign @conradennis @designertyler @laurenmrice this is the issue to add category values to the yaml file. @joshblack 's plugin will depend on this value to organize them into 11 menus.

@joshblack
Copy link
Contributor

Here's a quick how-to from @shixiedesign that she wrote up for editing the file: https://github.com/carbon-design-system/carbon/blob/master/docs/icons.md#updating-icon-metadata

Should we be updating categories from a list to just category? https://github.com/carbon-design-system/carbon/blob/master/packages/icons/metadata.yml#L5

@joshblack joshblack added package: sketch @carbon/sketch package: elements @carbon/elements and removed type: enhancement 💡 labels May 22, 2019
@shixiedesign
Copy link
Contributor

shixiedesign commented May 22, 2019

I think categories list still make sense. @joshblack An edit pencil may be in the Image category and also Tools. A few potential issue with categories listed above:

  • a lot of icons currently not in sketch kit are not given a category yet
  • image category has over 100~ icons while everything else have only 10-20. Image is currently synonymous to "misc"
  • this is erica's 1 quick pass and she has always intended to re-do it with better categorization

So I believe we should make this a work item like this:

  1. identifying the best categories
  2. do a team activity to sort the icons.

@chrisconnors-ibm
Copy link
Contributor Author

chrisconnors-ibm commented May 22, 2019

We need a category value for display categorization (single value), and synonyms to broaden search results (multiple values).

Categories are going to drive the menu structure in the Sketch library, so we can’t have icons in multiple “categories”.

@joshblack
Copy link
Contributor

Yeah, could get tricky with multiple categories. It seems like it'd be nice to be able to have different ways to find icons though, especially on the website. If we want to, we could generate each asset per category. I feel like the consequence of that will be if people use the same icon from multiple categories it could get confusing in a single sketch file 🤔

@shixiedesign
Copy link
Contributor

That make sense @chrisconnors-ibm. I take it back! Think it's a good idea to roll with 1 category for each icon, at least for now since we are restricted by Sketch's folder system.

@chrisconnors-ibm
Copy link
Contributor Author

We’re already set up in the .yml for a single unique category value and multiple alias values, so it should be fine.

@jeanservaas
Copy link
Collaborator

Is someone doing this work, or are we gonna break it up like last time?

@shixiedesign
Copy link
Contributor

@chrisconnors-ibm No actually. the .yml is set up for multiple category entries. You should look at
https://github.com/carbon-design-system/carbon/blob/master/packages/icons/metadata.yml

categories:
      - example cateogry

@joshblack does this mean you will have to do a pass on the file to batch change the format of this field?

@joshblack
Copy link
Contributor

@shixiedesign if we want we can keep the list format but say we only keep one entry in it? That way we have the option in the future of having multiple ones

@chrisconnors-ibm chrisconnors-ibm self-assigned this May 24, 2019
@chrisconnors-ibm
Copy link
Contributor Author

chrisconnors-ibm commented May 24, 2019

I added categories up to L1394 warning and committed to my branch

@chrisconnors-ibm
Copy link
Contributor Author

    friendly_name: Zoom
    usage: This is a description for usage
    categories:
      - Navigation
    aliases:
      - expand
      - inspect
      - size
      - enlarge
      - detail
    variants:
      - name: zoom--in
        friendly_name: Zoom in
        usage: This is a description for usage
        sizes:
          - 16
          - 32
      - name: zoom--out
        friendly_name: Zoom out
        usage: This is a description for usage
        sizes:
          - 16
          - 32

It may only be by convention, but I have't any with more than one category, and many with multiple aliases. I'm up to L1455

@chrisconnors-ibm
Copy link
Contributor Author

chrisconnors-ibm commented May 28, 2019

@jeanservaas I've been doing them since Friday but could certainly use some help. I'd say we split it into thirds, so
L1-L2280 - me
L2281-L4558 - Available
L4559-L6838 - Available

I'm using the categories here: https://www.ibm.com/design/language/elements/icon-library/

(even though I know they are going to change - @conradennis is developing a new schema

@chrisconnors-ibm
Copy link
Contributor Author

I replaced every instance of "example Category" with "TBD" so that if we build kits before all the categories are settled, there will be some under a "TBD" menu rather than Example Category.

@joshblack
Copy link
Contributor

Closed by #2934

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
package: elements @carbon/elements package: sketch @carbon/sketch
Projects
None yet
Development

No branches or pull requests

4 participants