search

carbon-design-system / carbon-platform

The "next" version of the Carbon Design System website, as a platform.
https://next.carbondesignsystem.com
Apache License 2.0
21 stars 5 forks source link

Index Carbon Gatsby Theme #729

Open mattrosno opened 2 years ago

mattrosno commented 2 years ago

Repo: https://github.com/carbon-design-system/gatsby-theme-carbon

External docs: https://gatsby-theme-carbon.vercel.app

No Storybook? (No demo links?)

List of components to index: https://github.com/carbon-design-system/gatsby-theme-carbon/blob/main/packages/gatsby-theme-carbon/index.js

(Compare list with docs site side nav.)

mattrosno commented 2 years ago

@ljcarot

https://github.com/carbon-design-system/gatsby-theme-carbon

The Carbon Gatsby Theme has 329 stars.

https://github.com/carbon-design-system/gatsby-theme-carbon/network/dependents

314 repositories depend on it.

https://www.npmtrends.com/gatsby-theme-carbon

Averages around 1,200 weekly downloads.

The Carbon Gatsby Theme is a library that's installed in a Gatsby site that includes default configurations and functionality. That functionality includes React components that are built using the Carbon React components (component extensions).

The Carbon Gatsby Theme is an extension of Carbon React, just like other PALs extend Carbon React.

The Carbon Gatsby Theme is part of our ecosystem. As long as it's part of our ecosystem, we can prevent confusion by properly indexing the library and its assets so our users know the difference between the two.

If it's too confusing, then we have bigger issues to address in the catalogs when viewing assets that initially appear to be similar. E.g.:

image
ljcarot commented 2 years ago

@mattrosno The reasons that I have for not including it is 1) it's no longer maintained and 2) if used within IBM, it does not follow the IBM standards for websites so it exacerbates a problem with proliferation of micro sites. In the past DPO maintained it, but Vince is on a different project now and we don't have resources to maintain it. While it may persist as a community supported library beyond IBM, I just don't want to dial up the volume on Gatsby within Platform.

mattrosno commented 2 years ago

@mattrosno to schedule a call with squad and Carbon leads to determine indexing go/no-go.

mattrosno commented 2 years ago

No rush to index this for v1. Let's index this library and its components once we can show the status note on asset detail pages (v1.x design effort), and once we know what messaging we'd want to put in those status notes.

Also, this will be marked as "community maintained", although the Carbon core team will still be minimally involved given our dependency on the Gatsby theme for the sites that we maintain.

Also, we should consider stronger messaging for "maintenance mode", "looking for maintainers", etc., as another design effort.