-
-
Notifications
You must be signed in to change notification settings - Fork 222
clarification on integration with vega-editor #692
Description
@domoritz With the release of v3 and the new species.csv dataset in #684 here, I realize I'm a bit fuzzy about the workflow for propagating vega-datasets updates to vega-editor and then into vega.github.io. Would it be worth documenting this in CONTRIBUTORS.md here?
Context
I've found these references which partially explain the process, but I haven't been able to piece it all together.
-
The vega-editor uses vega-datasets as a dependency:
- In package.json:
"vega-datasets": "^2.11.0" - In package-lock.json:
"vega-datasets": "^2.11.0"
- In package.json:
-
The vendor.sh script seems to copy the datasets during build:
#!/usr/bin/env bash set -e DATA=public/data SPEC=public/spec echo "Copying data to '$DATA'." rm -rf "$DATA" cp -R node_modules/vega-datasets/data/ "$DATA" echo "Copy examples to '$SPEC'."
-
There was a previous PR in vega-editor with a commit that updated vega-datasets from v2.5.1 to v2.5.3 and updated
package.jsonandyarn.lock. I believe we've since migrated fromyarn.locktopackage-lock.json.
What I'm seeing
- This works: https://vega.github.io/vega-datasets/data/cars.json
- This doesn't (as of 2025-03-23): https://vega.github.io/vega-datasets/data/species.csv (even though it's in the repo)
This isn't urgent - I understand there might be a lag time between our v3 release and when everything catches up. I'm just trying to fill in my knowledge gaps about how these projects interconnect and see if it would be worth adding or linking to the right resources for the benefit of future contributors.
Thanks for your help!