DOCS: Example landing page #1445

Merged
merged 14 commits into from Mar 5, 2014

Projects

None yet

4 participants

@jseabold
Member
jseabold commented Mar 5, 2014

Finally implemented a thumbnail gallery-style landing page for the docs. Inspired by nbviewers frontpage [1] and that there aren't any statsmodels notebooks there...

Only downside is, you have to make the thumbnails yourself, but it's not that tough to do. Every notebook example should have a "hook."

I've also organized the notebooks into respective categories, so we see where need more. I hope this inspires people to turn their scripts into examples. Or even to pull out nice examples from our docs and make example notebooks for the gallery.

[1] http://nbviewer.ipython.org/

@josef-pkt
Member

sounds good

do the png need to go into the repo. I always worry about space with comitting plots that will change over time.

FYI, in case you haven't seen them yet. Kerby started to add notebooks to https://github.com/statsmodels/statsmodels/wiki/Examples

@jseabold
Member
jseabold commented Mar 5, 2014

The pngs aren't plots. They're screen captures of the notebooks that I did by hand, so they're not likely to change unless we're not happy with them. I tried running pngcrush over them, but it didn't compress them all that much. 10-20%. Maybe not worth if for ~25kb file.

That's great. A lot of those notebooks, should go into the examples gallery. I'll have a look at moving them at some point.

@vincentarelbundock
Member

I put a compiled version of your branch here for people to look at:

http://umich.edu/~varel/sm

My 2 cents: I think this looks really nice. So thanks for the work. Though I think this moves the page closer to "advertising" than "tutorial", since it definitely makes it harder to find the procedures you are looking for (i.e. a scatterplot is much less informative than "Robust Linear Model" in a TOC).

I think it would be nice to put a couple of these thumbnails on the home page too. Perhaps quantile regression since it is a reasonably well-developed example and the plot looks nice.

Also, could we see the regression examples first? The "User Notes" category is kind of amorphous and not really what new users will use the first time around.

@jseabold
Member
jseabold commented Mar 5, 2014

Thanks. I agree on all counts. I was torn whether to put it in the main statsmodels web-site landing page even instead of in the docs sub-pages. That will have to wait though.

I can rearrange it.

As far as TOC. What about a TOC to the main sections at the top? So you click, then you browse?

@jseabold
Member
jseabold commented Mar 5, 2014

And advertising/sexiness is kind of what I'm after here, though it's also more tutorial-like with the sections I'd argue. This was spurred after looking at nbviewer and there's no statsmodels, we didn't make continuum's "featured packages," we're not notable enough for Wikipedia, and many comments in person to move in this direction over the years.

@vincentarelbundock
Member

Yeah, a TOC with the main sections would be perfect, I think.

I think you made the right choice, putting this on the examples page. Too many thumbnails would be overwhelming. But a couple nice ones would be a nice addition, I think (the current landing is pretty bland).

"Getting started" would make sense for the landing, I think. And maybe a fancier one on top of that.

@vincentarelbundock
Member

Also, I didn't mean "advertising" to (necessarily) have a negative connotation. I agree that SM could benefit from more visibility, so with some minor tweaks I think this could be a really positive change.

@coveralls

Coverage Status

Coverage remained the same when pulling ea2e791 on jseabold:example-landing-page into c299e3f on statsmodels:master.

@jseabold
Member
jseabold commented Mar 5, 2014

See how that looks.

@jseabold
Member
jseabold commented Mar 5, 2014

I'm going to go ahead and merge to get it in the doc builds and see if there are issues across browsers. Can revert or fix things going forward. I'll look at fixing up the main sf landing page.

@jseabold jseabold merged commit 3b5edd4 into statsmodels:master Mar 5, 2014

1 check passed

default The Travis CI build passed
Details
@jseabold jseabold deleted the jseabold:example-landing-page branch Mar 5, 2014
@jseabold
Member
jseabold commented Mar 5, 2014

FYI, I updated the main sf landing page. Let me know if any changes need to be made.

https://github.com/statsmodels/statsmodels-website/issues

@josef-pkt josef-pkt added the PR label Mar 11, 2014
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment