repurposing component index code for charts index #1746
Conversation
|
This pull request is being automatically deployed with Vercel (learn more). 🔍 Inspect: https://vercel.com/carbon-design-system/carbondesignsystem/3gi1lx3gg |
|
If it builds this time (!), also interested in a sanity check from @joshblack / @andreancardona. At this point it really is primarily a near-complete duplicate of all the component index code and schema. I think that should work as a foundation for any other type of index (as we'll end up doing likewise for patterns at some point)...although also feels like maybe longer term there's a better way than just rebuilding three different indices with three different (but basically identical) schemas. :D |
|
Definitely could try and repurpose the index plugin too to work for both types, would be great if we could do: {
resolve: 'gatsby-plugin-index',
options: {
sources: [
{
name: 'community',
directory: '...',
},
{
name: 'charts',
directory: '...',
},
],
},
}And it would just work. In the future might even make sense for this data just to be coming from an API and editable through a UI (which could be do-able with our service that we're doing right now since we'll have component data there) |
|
That makes sense. Presumably then we could just add all the chart .yml files in the interim, even if they're initially being referenced by This is, I think, definitely the correct approach. Because then we'll end up with (as a final result)... {
resolve: 'gatsby-plugin-index',
options: {
sources: [
{
name: 'components',
directory: '...',
},
{
name: 'charts',
directory: '...',
},
{
name: 'patterns',
directory: '...',
},
],
},
}...where we can present the different types on different pages (so a "component index", "chart index" etc), but also in theory a single, filterable, "catalog of everything". |
|
@andreancardona / @joshblack - this works ok, but it breaks completely if you filter to a point of "no results". Do you have any thoughts? |
|
@shinytoyrobots took a quick look, I think the fix is that suggestion above 👀 let me know if it works! |
|
Now that this has some population with data - I think it's important that we get some design feedback. @aagonzales, I'll set up a brief chat with you, @aledavila and I about any considerations we should take into account. Let me know if there's anyone else I need to add to that meeting. |
|
Images automagically compressed by Calibre's image-actions ✨ Compression reduced images by 24.1%, saving 80.39 KB.
1127 images did not require optimisation. |
|
Looking at the AI Apps charts I think these need to probably not be included in the index. Only 5–6 new ones and they are incredibly weak with no guidance, specs, or refined designs, Sketch files zero. Just a static image with missing details and misleading. We have current design efforts on following charts: Bullet |
|
This PR currently has a merge conflict. Please resolve this and then re-add the |
|
Part of the point of the index is to highlight duplicates though - to provide a greater impetus to consolidate and refine. So would we be better keeping the AI Apps charts in (for a soft launch at least) and using that as a basis to reach out to Craig to discuss effective next steps? |
|
Is there a reason we are duplicating the code from the component index and not reusing the same component for both? Would we want to just have one component for both so its easier to update in the future and keep them in sync? |
|
Images automagically compressed by Calibre's image-actions ✨ Compression reduced images by 20.1%, saving 47.27 KB.
1140 images did not require optimisation. |
|
@alisonjoseph so that will actually be a next step. To repurpose the component plug-in to allow for us to reuse it and be able to add the charts and patterns. |
|
Images automagically compressed by Calibre's image-actions ✨ Compression reduced images by 5.7%, saving 20.73 KB.
1141 images did not require optimisation. |
|
@shinytoyrobots you can't have two properties on an object with the same name. This PR broke all the component index images.
|
|
Thanks for the spot. And a good reminder that just testing the thing being built can mean missing knock-on effects (from clumsy coding on my part). |
…em#1746) * repurposing component index code for charts index * dummy data causing build prob? * dummy data * does it build with parameter absent, not incorrect * tweaks made during our call * added ai-apps basic charts * feat(chart-index): add carbon charts files to index * chore(chart-index): fix duplicate titles * updated filters and test thumbnails * Optimised images with calibre/image-actions * added 'Other' as a valid option for chart type * added a 'complexity' filter * Optimised images with calibre/image-actions * Added advanced charts from carbon and ai-apps * images for all carbon-charts, fix capitalization * cleanup and page title change * remove cognos as maintainer until they have content * add contribution note to no result text * fix misspelt chart name * Optimised images with calibre/image-actions * resolve image conflict * Optimised images with calibre/image-actions * Optimised images with calibre/image-actions Co-authored-by: Alessandra Davila <aledavila@ibm.com> Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com> Co-authored-by: kodiakhq[bot] <49736102+kodiakhq[bot]@users.noreply.github.com>
…em#1746) * repurposing component index code for charts index * dummy data causing build prob? * dummy data * does it build with parameter absent, not incorrect * tweaks made during our call * added ai-apps basic charts * feat(chart-index): add carbon charts files to index * chore(chart-index): fix duplicate titles * updated filters and test thumbnails * Optimised images with calibre/image-actions * added 'Other' as a valid option for chart type * added a 'complexity' filter * Optimised images with calibre/image-actions * Added advanced charts from carbon and ai-apps * images for all carbon-charts, fix capitalization * cleanup and page title change * remove cognos as maintainer until they have content * add contribution note to no result text * fix misspelt chart name * Optimised images with calibre/image-actions * resolve image conflict * Optimised images with calibre/image-actions * Optimised images with calibre/image-actions Co-authored-by: Alessandra Davila <aledavila@ibm.com> Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com> Co-authored-by: kodiakhq[bot] <49736102+kodiakhq[bot]@users.noreply.github.com>
Addressing #1647
At this point primarily duplicated the community component index into a "Charts" component, and relevant GraphQL schema.
Very much WIP.
Need to refine from a code / functionality perspective.
Need design feedback on possible changes to layout for a chart index vs a component index.