Draft new library descriptions

[mattrosno]

Here are the library descriptions that will show up on library detail pages once #558 is complete. This issue is to specify library description changes.

• https://github.com/carbon-design-system/carbon-charts/blob/master/packages/angular/carbon.yml#L5
• https://github.com/carbon-design-system/carbon-charts/blob/master/packages/core/carbon.yml#L5
• https://github.com/carbon-design-system/carbon-charts/blob/master/packages/react/carbon.yml#L5
• https://github.com/carbon-design-system/carbon-charts/blob/master/packages/svelte/carbon.yml#L5
• https://github.com/carbon-design-system/carbon-charts/blob/master/packages/vue/carbon.yml#L5
• https://github.com/carbon-design-system/carbon-for-ibm-dotcom/blob/main/packages/react/carbon.yml#L5
• https://github.com/carbon-design-system/carbon-for-ibm-dotcom/blob/main/packages/web-components/carbon.yml#L5
• https://github.com/carbon-design-system/carbon/blob/e5d1cad837798223958d166a4f0ccfba975d3b03/packages/react/carbon.yml#L4

[mattrosno]

@aubrey-oneal the library descriptions also show up in the libraries page. Do you think we can come up with fitting library descriptions that show up both here and in the library detail page? It would be nice to have one description and not separate short-form and long-form descriptions.

Here's the guidance we have in the schema:

https://github.com/carbon-design-system/carbon-platform/blob/main/docs/resource-schemas.md#library-keys

Library description ideally between 50-160 characters in length. Use sentence-case capitalization.

[mattrosno]

@kingtraceyj is this part of the current sprint 17? Or is it queued up for sprint 18? Or should it be in the design backlog?

[aubrey-oneal]

Working airtable: https://airtable.com/appyxEkZZl7YQRGDF/tblE2Y75BfY0Z0T2O/viwiUj1cNATMWrkSy?blocks=hide

View only for those not in the DPO: https://airtable.com/shrdwElZNyJdGtZkS/tblE2Y75BfY0Z0T2O

Description guidelines:

• About 10 words in length, max 15
• Focused on what the user can do with the library (Tell stories, create editorial experiences, build user interfaces)
• If possible, explain the different 'flavor' of the library (data, editorial, product)
• Avoid repeating the maintainer or framework if possible.
• Avoid restricting who this is for (i.e. for IBM Cloud).
• Repeat the same description for each framework unless there is something special to call out (i.e. primary library)

[aubrey-oneal]

Reviewers: could you please look at the airtable?

If you like my draft, copy it into 'Final' and mark it as 'approved'. Or check out my guidelines (above) and edit your own version.

@ljcarot @mattrosno @jeanservaas @Morgana @alisonjoseph

[yumeforever]

@aubrey-oneal I followed up with David and Laura, just to make sure, but I think it looks great so far. I will get back to you once I hear from them (probably today).

[Levinson1]

@aubrey-oneal @yumeforever Can you please add a representative from IBM Products to this and any other workstreams that require IBM Products input? Laura Marshall and/or Carrie Lloyd would be best. Thanks.

As for the description, as this is for the code library, I have asked our FED Manager, Elysia Hwang for her input.

[aubrey-oneal]

Absolutely @Levinson1!

[aubrey-oneal]

The current IBM product library description I have in our airtable is: Find solutions designed for IBM's product portfolio.

(copying here because I don't think everyone can access that airtable)

[Levinson1]

From Elysia: React-based solutions for IBM’s product portfolio

[aubrey-oneal]

Ok I'll chat with her. I'd like to find something that follows of the content guidelines (above) so that we can have a cohesive set of descriptions across all libraries.

[alisonjoseph]

The core library description all look good to me 👍

[mattrosno]

@aubrey-oneal drafts look great here!

[mattrosno]

@aubrey-oneal here are additional indexed libraries that don't show up in the core system, but could become visible in local systems.

https://next.carbondesignsystem.com/libraries/carbon-styles

https://next.carbondesignsystem.com/libraries/ibmdotcom-styles

https://next.carbondesignsystem.com/libraries/ibmdotcom-utilities

https://next.carbondesignsystem.com/libraries/ibmdotcom-services

You can always direct link to these. The styles libraries may never become visible in the libraries catalog, but I definitely expect Carbon for IBM.com local system to show those utilities and services libraries in its libraries catalog.