[SciPy-User] [numfocus] Docathon : focus on documentation on your favorite opensource project!

[Ralf Gommers]

This is awesome, so I've taken the liberty of signing SciPy up. Reminds me
of the NumPy & SciPy Documentation Marathon - that's how I got started
contributing 9 years ago.

Next week is pretty poor timing for me, but I'm going to get at least 1 PR
in and review as many as I can.

There's no specific site or issues marked for this docathon, but it's easy
to participate. It's just a matter of finding functions with incomplete
documentation (that's not hard ....) - adding a usage example can be a
major improvement already.

Cheers,
Ralf



On Thu, Mar 2, 2017 at 2:02 PM, Nelle Varoquaux <nelle.varoquaux at gmail.com>
wrote:

> Hi everyone,
>
> Apologies for cross-posting : this event might be of interest to some of
> the projects of the scientific Python community. We are trying to encourage
> FOSS developers to focus on documentation for a week instead of fixing bugs
> or implementing cool features!
>
> Here are more informations about the project.
>
> Thanks,
> Nelle
> Sign up your project for the docathon!
>
> The Docathon is happening next week! We’ve already got several projects
> signed up to participate in improving their documentation during the week.
> We’ve put together a nifty project board
> <https://bids.github.io/docathon/pages/projects/projects.html> so that we
> can keep track of everybody’s progress during the week! If you sign up as
> a project <https://goo.gl/forms/0cPpw01zehrEyDDE3>, we’ll post your
> documentation commit stats like this:
>
> How can I join in?
> We want you to improve your documentation, wherever you are. To that
> extent, we’ll keep track of project activity regardless of its location. If
> you’d like to work with a group of people, here are a few specifics:
>
> To kick off the docathon we’ll have a morning of tutorials on Monday,
> March 6th. These will cover particular tools and techniques for building
> great documentation. If you’re at Berkeley then you can sign up here
> <https://www.eventbrite.com/e/bids-docathon-kickoff-tickets-32302896834?aff=mcivte>.
> This will also be live-streamed on Youtube, so you can watch from wherever
> you are!
>
> We’ll also have some working groups meeting periodically in cities around
> the country. If you’d like to join in with these groups, click one of these
> links:
>
>
>    -
>
>    New York City - Signup
>    <https://www.eventbrite.com/e/doc-a-thon-tickets-32309998074> / Agenda
>    <https://bids.github.io/docathon/pages/hosts/gc.html>
>    -
>
>    Berkeley - Signup
>    <https://www.eventbrite.com/e/bids-docathon-kickoff-tickets-32302896834?aff=mcivte>
>    / Agenda <https://bids.github.io/docathon/pages/hosts/bids.html>
>    -
>
>    Seattle - Signup <https://goo.gl/forms/GMyMPJZ9eLT6eQuF2> / Agenda
>    <https://bids.github.io/docathon/pages/hosts/uwescience.html>
>
>
> You can also work remotely if you like, we will coordinate people via
> email/GitHub, too.
>
> Wherever you are, don’t forget to sign up as a participant
> <https://goo.gl/forms/AaW2b24mMxOutxt02> so we can give some pointers on
> how to contribute. Or, suggest a project
> <https://goo.gl/forms/0cPpw01zehrEyDDE3> to work on and we’ll keep track
> of its activity on our projects page
> <https://bids.github.io/docathon/pages/projects/projects.html>.
>
> Contact
> If you have any questions, check out the Docathon website
> <http://bids.github.io/docathon> or open an issue on our GitHub repo
> <https://github.com/BIDS/docathon>.
>
> Please feel free to forward this email to anyone who may be interested.
> We'd love for other institutions/groups to get involved.
>
> --
> You received this message because you are subscribed to the Google Groups
> "NumFOCUS" group.
> To unsubscribe from this group and stop receiving emails from it, send an
> email to numfocus+unsubscribe at googlegroups.com.
> For more options, visit https://groups.google.com/d/optout.
>
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://mail.python.org/pipermail/scipy-user/attachments/20170302/32930799/attachment.html>