[yt-dev] Documentation Sprint and Creating BB Issues When You See a Gap

[Cameron Hummels]

That sounds great to me!  I'll happily be the doc steward.  I like the idea
of small local sprints.  It's too bad I didn't go to the AGORA thing this
weekend, as we could do one there.  Oh well.  But yes, October/November
sounds like a great time to do this.  Perhaps we can do one the next time I
come to NYC too.

Cameron


On Sat, Aug 17, 2013 at 5:46 AM, Matthew Turk <matthewturk at gmail.com> wrote:

> Hi Cameron et al,
>
> This is a very good idea.  Cameron, I think you would be well-suited
> to being a documentation steward for yt -- not in terms of *writing*
> it, but helping to ensure that the coverage remains high and that
> features aren't simply forgotten about as they are submitted.
>
> As for a sprint, I would be very keen to have one, and at the time
> when development switches over would be a perfect one.  Since there's
> some clustering of yt devs recently, what we could try for is
> semi-remote sprints.  Anybody that wanted to come to Columbia, I'd buy
> pizza for and we could all write in the same room.  Interested
> participants that are clustered at other institutions could work
> together, too, and the groups could meet over IRC/Hangouts.
>
> But yes, let's aim for this.  Perhaps sometime in October or November?
>  Or is that too soon?
>
> -Matt
>
> On Fri, Aug 16, 2013 at 6:23 PM, Cameron Hummels <chummels at gmail.com>
> wrote:
> > Hey peeps,
> >
> > After talking with Matt at some length about the yt documentation, we
> > thought it might be a good idea to have a documentation sprint in a few
> > months when we've moved over to yt 3.0 as the focus of our development.
>  The
> > docs in general are good, but there are some gaps here and there with
> some
> > functionality not present in the documentation.  I'm not proposing an
> entire
> > (or even partial) rewrite of the docs, as I think that would be
> > counterproductive.  I'm simply thinking we could fill in the holes to
> make
> > sure all of the cool stuff in yt is written up so people know how to use
> it.
> >
> > Now, I know doc writing is not often fun, but I think this could be
> really
> > beneficial to our user base, and actually cut down on the amount of time
> we
> > have to respond to new users on the mailing list and irc (as well as
> making
> > it easier for people to use yt).
> >
> > What I'm asking from you is if you encounter something that you don't
> think
> > is well documented in the formal docs (not simply the docstrings), could
> you
> > take a moment to create a bitbucket issue about it?  You don't even have
> to
> > fix it then, just note it, so we know where to work when we do the
> sprint in
> > a few months.
> >
> > Anyone else have any other ideas about this?
> >
> > Cameron
> >
> > --
> > Cameron Hummels
> > Postdoctoral Researcher
> > Steward Observatory
> > University of Arizona
> > http://chummels.org
> >
> > _______________________________________________
> > yt-dev mailing list
> > yt-dev at lists.spacepope.org
> > http://lists.spacepope.org/listinfo.cgi/yt-dev-spacepope.org
> >
> _______________________________________________
> yt-dev mailing list
> yt-dev at lists.spacepope.org
> http://lists.spacepope.org/listinfo.cgi/yt-dev-spacepope.org
>



-- 
Cameron Hummels
Postdoctoral Researcher
Steward Observatory
University of Arizona
http://chummels.org
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.spacepope.org/pipermail/yt-dev-spacepope.org/attachments/20130817/22b1419e/attachment.htm>