[Numpy-discussion] Helping with website improvements

[Ralf Gommers]

On Tue, Jul 16, 2019 at 9:57 AM Sebastian Berg <sebastian at sipsolutions.net>
wrote:

> On Tue, 2019-07-16 at 07:06 -0600, Charles R Harris wrote:
> > Hi Dashamir,
> >
> > On Mon, Jul 15, 2019 at 4:49 PM Dashamir Hoxha <dashohoxha at gmail.com>
> > wrote:
> > > Hi,
> > >
> > > With respect to this call for contributions:
> > > https://github.com/numpy/numpy/pull/13988/files
> > > I would like to help with improving the website of numpy (and maybe
> > > scipy as well).
>

Thanks for offering to help Dashamir!

> > I have also applied for the Google Season of Docs 2019, and if
> > > accepted, I will be starting by the beginning of August.
> > >
> > > The improvements that I would like to make include:
> > > - Making the website responsive (so that it looks nice on small
> > > screens as well). There are responsive themes for sphinx and I may
> > > use one of them.
> > > - Improving the main page (or the landing page) so that it looks a
> > > bit more modern and attractive.
> > > - Reorganizing the structure of the information on the website, so
> > > that people from different backgrounds (students, professionals,
> > > etc.) can find more easily the relevant information that they are
> > > looking for. Including references to the external tutorials or
> > > courses about NumPy/SciPy.
>

This all sounds good. I just sent another email about the numpy.org
redesign, please feel free to jump in on the proposal (
https://github.com/numpy/numpy/pull/14032).


> > >
> > > Other tentative improvements may be these:
> > > - Reorganize the docs so that each major release has its own
> > > version of docs. Major releases are those that may introduce new
> > > features, or in general, changes in the API (minor releases are the
> > > maintenance releases, which fix bugs, or make small changes, for
> > > example to improve the efficiency, but do not change the API). For
> > > example major releases may be v1.15, v1.16, v1.17 (however I am not
> > > sure about this).
>

Note that the docs are kept separate from the numpy.org site, and when we
move numpy.org away from Sphinx that separation will be clearer.
Matti is already working on this multi-version reshuffle in
https://github.com/numpy/numpy/pull/13886.


> > > - Reorganize the docs so that the core API functionality is shown
> > > more prominently than the rest, and so that functions that may be
> > > deprecated in the future can be marked so (in order to discourage
> > > users from using them) and alternative solutions are suggested
> > > instead of them, etc.
>

This is a good idea. That sounds more like a GSoD topic - it's quite some
work to do, and to agree on the choices of what's important.

> > - Allow the users to add comments for each function or package.
> > > These may be usage examples for the benefit of other users, or
> > > pitfall alerts, or even bug reports. Reporting bugs on GitHub is
> > > better of course, but this may be a bit easier for the users.
>

This one I'm not so sure about. Could result in a lot more work for us......

> >
> > > Since these are not incremental changes, if may be better if I work
> > > on a fork of the website repository, until they are finished and
> > > the new website is ready.
>

Yes, would be good to start in a clean repo. I'd like to get the NEP
accepted first, and then put together a bit of a plan so multiple people
can work together on this.

Cheers,
Ralf


> >
> > >
> >
> > That sounds interesting and ambitious. I'll let others offer
> > suggestions, we might want to host the site at a different provider
> > which will offer easier access to developers. The repo is at at
> > https://github.com/numpy/numpy.org. There is also a scipy.org website
> > that could also use some work.
> >
>
>
> Indeed, great to see interest, it sounds very nice! I believe you are
> already in contact with Ralf directly (just in case someone wonders if
> there might be little immediate followup on the mailing list).
>
> Best,
>
> Sebastian
>
>
> > Chuck
> > _______________________________________________
> > NumPy-Discussion mailing list
> > NumPy-Discussion at python.org
> > https://mail.python.org/mailman/listinfo/numpy-discussion
> _______________________________________________
> NumPy-Discussion mailing list
> NumPy-Discussion at python.org
> https://mail.python.org/mailman/listinfo/numpy-discussion
>
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://mail.python.org/pipermail/numpy-discussion/attachments/20190716/eb0df571/attachment.html>