VegaLite.jl; what needs doing?

I do not consider myself great at VegaLite.jl and I don’t know all its elements. I am still getting used to it more and more and don’t always have much time. Still I am interested in possibly helping with this project.

I remember that documentation needed some care. What is exactly necessary?

I may not have time to already start, but if I know what’s needed, maybe I can give it some thought once in a while, so that there could be some preparation for later.

1 Like

See the issues on Github:

1 Like

@Usor, awesome, any help would be greatly appreciated!

I think an excellent (and easy) way to get into contributing is to add more of the examples from the original vega-lite documentation to our own documentation. I once made a big push, but I didn’t manage to finish all of them. I found that was a super useful exercise for myself as well, because I actually learned more about the features of vega-lite :slight_smile: So in my mind this is probably the lowest hanging fruit in terms of contributing to the docs.

But any other help with the docs would also be appreciated.

We also have a fair number of more low level coding exercises. If you want to contribute to these, let me know, and I can guide you!

4 Likes

Thanks.

Normally, yes, but I figured I may as well ask here.

1 Like

Good. That already gives me something to think about once in a while if I squeeze it in. (Just don’t know when.)

I remember that I found that some or even many of the examples in their original documentation are very convoluted or aren’t getting to the point quickly and easily. Is this a correct assessment? At least to me it looked liked it, like it’s easy to miss the whole essence in the first place, which may be why I had trouble with some of them.

And I see you recently opened on Github the first few issues for documentation. I hope to have a look at that soon.

So my thinking for the docs was that we have simple tutorials (and right now there is only one) that start easy and walk one through, and that we have examples that might be quite advanced. The examples we have I just copied from the original vega-lite and altair documentation…

2 Likes

At some point I had some VegaLite.jl code to complete some of the map examples missing from the documentation, however it wasn’t clear to me how to submit the PR and check it produced the expected results, because I couldn’t update the documentation on a local copy. I guess I could just submit the code? I really don’t know what the expected route is, but I did use VegaLite mapping for some fun stuff for a project a while ago.

You should be able to just build the documentation locally by running docs/make.jl, right?

I haven’t done it, but I assume you’re correct. To be honest, my experience with package development and package creation is almost nil, and only recently, following Chris Rackauckas’ tutorial, a lot of thing clicked for me and I thought exactly about something like that for VegaLite. I need to find some time to try it and if it works, I will gladly submit the PR.

2 Likes

Yes, and feel free to ask for help, happy to provide guidance!

2 Likes

That sounds nice. I suppose they’d have to be tailored to types of people with different backgrounds (skill-wise, knowledge-wise, etc.).

I’d be glad to write some tutorials. This month has been so busy and I hardly have energy these days. I expect to be pretty busy next month too. I also still need to get my head around some of the more advanced Vegalite stuff. So it might take some time before you will see me picking that low-hanging fruit.

Merry Christmas by the way (to anyone reading this). (Mine wasn’t so merry, by the way.)

@Usor, don’t stress yourself over this, whenever you’re ready any contribution is welcome :slight_smile:

Yes, I should take it easy, or maybe there won’t even be an opportunity to contribute.