Contribute a chart
Anyone can add assets to the community chart index. Maintainers can submit a short pull request in GitHub to add a chart to the index.
In the index folder of the carbon-website GitHub repo, open your team folder. Create a folder if your team doesn’t have one yet.
Add file(top right), then
Create new file.
Name your file
chart-name.yml, where chart-name is the name of your chart.
Copy and paste the following template into the
Edit new filesection of the page and fill out the correct information for your component.name: chart namewebsite_url: >-url of documentation / guidance page (if any)code_url: >-url of component code on GitHub (if any)maintainer: name of maintainer teamdescription: >-short description of purpose and usage of chartchart_type: choose one of Comparisons | Trends | Part-to-whole | Correlations | Connections | Geospatial | Other
Once done, click the green
Commit new filebutton at the bottom.
After submitting the PR for the data, you should upload a thumbnail image.
- Go back to your team folder in the index.
- Inside your team folder, open the
- In the top right, click
Upload filesto upload your image to that page then submit the PR. Note: name your image file with the same name as the chart (e.g.
component-name.yml). Your image should be 320px x 240px.
And you’re done! The Carbon team will review and merge the PR.
If you’re unsure about how to make a PR through GitHub, create an issue in the repo instead and we’ll help you out. Be sure to include all the necessary component information and images.