[SciPy-Dev] Google Season of Docs

[Christoph Baumgarten]

Sure, I will add it in the next few days.

On Tue, Apr 2, 2019 at 6:02 PM <scipy-dev-request at python.org> wrote:

> Send SciPy-Dev mailing list submissions to
>         scipy-dev at python.org
>
> To subscribe or unsubscribe via the World Wide Web, visit
>         https://mail.python.org/mailman/listinfo/scipy-dev
> or, via email, send a message with subject or body 'help' to
>         scipy-dev-request at python.org
>
> You can reach the person managing the list at
>         scipy-dev-owner at python.org
>
> When replying, please edit your Subject line so it is more specific
> than "Re: Contents of SciPy-Dev digest..."
>
>
> Today's Topics:
>
>    1. Re: Google Season of Docs (Ralf Gommers)
>
>
> ----------------------------------------------------------------------
>
> Message: 1
> Date: Tue, 2 Apr 2019 10:40:20 +0200
> From: Ralf Gommers <ralf.gommers at gmail.com>
> To: SciPy Developers List <scipy-dev at python.org>
> Subject: Re: [SciPy-Dev] Google Season of Docs
> Message-ID:
>         <CABL7CQipvttnWrAE=
> V6Fr+iJKjGM1x0wgKbK-ea7ZNsOXx6YDg at mail.gmail.com>
> Content-Type: text/plain; charset="utf-8"
>
> On Fri, Mar 22, 2019 at 8:07 PM Ralf Gommers <ralf.gommers at gmail.com>
> wrote:
>
> >
> >
> > On Thu, Mar 21, 2019 at 12:10 PM Christoph Baumgarten <
> > christoph.baumgarten at gmail.com> wrote:
> >
> >>
> >> Hi,
> >>
> >> taking up Ralf's mail on GSoD, I had a look at the website and propose
> to
> >> apply.
> >>
> >> My project suggestion would be to work on the documentation of a module
> >> like stats:
> >>
> >
> >> - improve the tutorial site
> >> https://docs.scipy.org/doc/scipy/reference/tutorial/stats.html
> >> - improve the documentation of the API
> >>   - check whether current descriptions can be improved
> >>   - add examples and references
> >>   - cross-ref to other relevant / similar functions in the module
> >>
> >> The second point would require decent knowledge of statistics whereas
> the
> >> first point should be easier to tackle for a technical writer. So I see
> the
> >> second point as optional and one could also try to work on the tutorial
> >> site of more than one module during the 3-month period.
> >>
> >
> >> The task would leave quite a bit of freedom to the writer to choose what
> >> areas to focus on, potentially taking up some of the documentation
> issues
> >> that are already on Github.
> >>
> >> I could assist as a mentor for stats (we need at least two mentors).
> >>
> >> Any suggestions or comments?
> >>
> >
> > Thanks Christoph, this sounds like a good idea to me. We have a lot of
> > content on scipy.stats, and a tech writer could really make a difference
> in
> > making that easier to understand for users. I suggest we write this up as
> > an idea on our (to be created) ideas page as soon as we know whether we
> > have an umbrella organization that we can participate with.
> >
>
>  An update on this: NumFOCUS is applying as an umbrella org. We'll need to
> add our ideas at
> https://github.com/numfocus/gsod/blob/master/2019/SciPy_ideas_list.md.
> Since there are going to be few spots available, it's the quality of the
> content that matters for acceptance of NumFOCUS as an umbrella org. We
> should have 1-2 ideas that are well described up on that page by April
> 14th. There are some guidelines at
>
> https://developers.google.com/season-of-docs/docs/project-ideas#project-idea
>
> Christoph, could you add your idea in that SciPy_ideas_list.md file?
>
> I will add some more general information there about getting started on the
> SciPy docs. Also, if anyone has another idea, that would be great to hear.
>
> Cheers,
> Ralf
> -------------- next part --------------
> An HTML attachment was scrubbed...
> URL: <
> http://mail.python.org/pipermail/scipy-dev/attachments/20190402/244fdd76/attachment-0001.html
> >
>
> ------------------------------
>
> Subject: Digest Footer
>
> _______________________________________________
> SciPy-Dev mailing list
> SciPy-Dev at python.org
> https://mail.python.org/mailman/listinfo/scipy-dev
>
>
> ------------------------------
>
> End of SciPy-Dev Digest, Vol 186, Issue 6
> *****************************************
>
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://mail.python.org/pipermail/scipy-dev/attachments/20190403/bcb13739/attachment.html>