Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update docs for vega_datasets v2 #2213

Open
eitanlees opened this issue Jun 19, 2020 · 7 comments
Open

Update docs for vega_datasets v2 #2213

eitanlees opened this issue Jun 19, 2020 · 7 comments

Comments

@eitanlees
Copy link
Contributor

The vega/vega-datasets repository recently released a major update. We are working on updating altair-viz/vega_datasets to reflect v2. As a result many examples throughout the docs will need to be updated.

After altair-viz/vega_datasets#39 is closed we can begin the process of cleaning up the docs.

For now I just wanted to make note of the transition.

@jakevdp
Copy link
Collaborator

jakevdp commented Jun 19, 2020

Related: #2210, #2212

@jakevdp
Copy link
Collaborator

jakevdp commented Jun 19, 2020

Note that some docs are currently broken due to the changes in vega/vega-datasets, due to using URL data that has changed or been removed in vega-datasets.

@eitanlees
Copy link
Contributor Author

eitanlees commented Jun 29, 2020

I have compiled a big list of everything that needs to be changed once altair-viz/vega_datasets#40 is merged.

From the Example Gallery

Broken

Needs Update

From the docs

Broken

Needs Update

@joelostblom
Copy link
Contributor

@eitanlees @jakevdp Is there anything I can do to assist with this that is not already covered by #2231, #2241, and #2310 (I just opened this for the weather data)? It seems like altair-viz/vega_datasets#40 is ready also. I am teaching a course with Altair next week and want to make sure students have a good experience reading the documentation, so let me know if I can help out.

@joelostblom
Copy link
Contributor

Response to my question above here #2310 (comment)

@cdeil
Copy link
Contributor

cdeil commented Nov 24, 2020

@jakevdp @ellisonbg - any chance to get the example dataset URL issues resolved for Altair?

I noticed the broken example in the docs and found this issue. Looks like there's open PRs with fixes already.

Screenshot 2020-11-24 at 22 02 35

@jakevdp
Copy link
Collaborator

jakevdp commented Nov 26, 2020

Current broken docs fixed by using vega_datasets 0.9, which loads datasets from CDN to get around the broken URLs introduced by vega/vega-datasets version 2.0.

Going forward, we need to do some more work, mainly to remove the iris examples throughout the docs, so that the docs will be compatible with the datasets now available in vega-datasets 2.0.

The renamed fields in vega-datasets 2.0 are going to be more difficult, because there's not really any way to make Altair's docs compatible with both the old and the new version at once. So we'll need a vega_datasets release simultaneous with an altair release.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

4 participants