I agree with Matt. If the 3.0 docs were only somewhat out of sync that would be one thing, but there's about a year's worth of work that needs to be covered before the docs are correct.<div><br></div><div>I understand your concern about documenting new features, however given that there is already so much that needs to be documented, I don't think adding epsilon on top of that is a big deal.<span></span></div>
<div><br>On Friday, December 13, 2013, Matthew Turk wrote:<br><blockquote class="gmail_quote" style="margin:0 0 0 .8ex;border-left:1px #ccc solid;padding-left:1ex">On Fri, Dec 13, 2013 at 10:37 AM, Cameron Hummels <<a href="javascript:;" onclick="_e(event, 'cvml', 'chummels@gmail.com')">chummels@gmail.com</a>> wrote:<br>
> Sounds good, but I guess I don't understand why the 3.0 docs aren't yet<br>
> buildable. I can build them locally. The only thing that prevented me from<br>
> doing this is that I had to pip install the new bootstrap theme in order for<br>
> them to not fail. Is this what you mean, Kacper?<br>
><br>
> I understand not wanting to have out of date docs available to the user<br>
> base, but i'd love to get something up so people can document new changes to<br>
> the code as they make them.<br>
<br>
I agree with having the docs, but I worry that having *incorrect* docs<br>
will be more damaging, particularly to perception, than no docs.<br>
<br>
> Let me know if you need help on this, Matt.<br>
<br>
I definitely do! The best way to get started is to go through the<br>
cookbook and make sure all the recipes work; I did this at one point,<br>
but I may have missed a few, and I know a few have been updated in the<br>
2.x repo.<br>
<br>
Today after the conference call I can devote some cycles to this.<br>
<br>
-Matt<br>
<br>
><br>
> Cameron<br>
><br>
><br>
> On Fri, Dec 13, 2013 at 6:42 AM, Matthew Turk <<a href="javascript:;" onclick="_e(event, 'cvml', 'matthewturk@gmail.com')">matthewturk@gmail.com</a>> wrote:<br>
>><br>
>> Hi Cameron,<br>
>><br>
>> Thanks for taking this on! I think that we should definitely push up<br>
>> some 3.0 docs (which it sounds like Kacper is working on) but I'm not<br>
>> sure that we should link them *until* they are mostly up to date.<br>
>> Fortunately the cookbook process and the IPython Notebook process<br>
>> won't pass until they are, so that's good.<br>
>><br>
>> Once the AGORA telecon is over today I should be able to spend some<br>
>> time hitting the easy changes to the docs that should bring them<br>
>> mostly up to speed. One thing we'll need to do with 3.0 that we<br>
>> haven't in the past is emphasize much more strongly the developer<br>
>> aspects, as some areas of the code -- while cleaner -- are different<br>
>> in some key ways.<br>
>><br>
>> -MAtt<br>
>><br>
>> On Thu, Dec 12, 2013 at 6:34 PM, Cameron Hummels <<a href="javascript:;" onclick="_e(event, 'cvml', 'chummels@gmail.com')">chummels@gmail.com</a>><br>
>> wrote:<br>
>> > Hello everyone,<br>
>> ><br>
>> > Now that the bulk of the development is moving over to the yt-3.0<br>
>> > branch, I<br>
>> > propose we have the yt-3.0 docs available on the website. Right now, a<br>
>> > yt-3.0 branch exists in the yt-doc repository, but there are very minor<br>
>> > changes in it relative to the yt 2.x documentation. Unfortunately,<br>
>> > there is<br>
>> > no public way to view these documentations aside from downloading the<br>
>> > repository and building locally. I think by putting the 3.0 docs on the<br>
>> > webpage, it will make it more likely that people contribute docs when<br>
>> > they<br>
>> > contribute new code changes, whereas if we wait too long, the codebase<br>
>> > may<br>
>> > get considerably out of sync with the docs.<br>
>> ><br>
>> > I think this will only require a slight change to the buildbot targets<br>
>> > by<br>
>> > Kacper. What do people think?<br>
>> ><br>
>> > Cameron<br>
>> ><br>
>> ><br>
>> > --<br>
>> > Cameron Hummels<br>
>> > Postdoctoral Researcher<br>
>> > Steward Observatory<br>
>> > University of Arizona<br>
>> > <a href="http://chummels.org" target="_blank">http://chummels.org</a><br>
>> ><br>
>> > _______________________________________________<br>
>> > yt-dev mailing list<br>
>> > <a href="javascript:;" onclick="_e(event, 'cvml', 'yt-dev@lists.spacepope.org')">yt-dev@lists.spacepope.org</a><br>
>> > <a href="http://lists.spacepope.org/listinfo.cgi/yt-dev-spacepope.org" target="_blank">http://lists.spacepope.org/listinfo.cgi/yt-dev-spacepope.org</a><br>
>> ><br>
>> _______________________________________________<br>
>> yt-dev mailing list<br>
>> <a href="javascript:;" onclick="_e(event, 'cvml', 'yt-dev@lists.spacepope.org')">yt-dev@lists.spacepope.org</a><br>
>> <a href="http://lists.spacepope.org/listinfo.cgi/yt-dev-spacepope.org" target="_blank">http://lists.spacepope.org/listinfo.cgi/yt-dev-spacepope.org</a><br>
><br>
><br>
><br>
><br>
> --<br>
> Cameron Hummels<br>
> Postdoctoral Researcher<br>
> Steward Observatory<br>
> University of Arizona<br>
> <a href="http://chummels.org" target="_blank">http://chummels.org</a><br>
><br>
> _______________________________________________<br>
> yt-dev mailing list<br>
> <a href="javascript:;" onclick="_e(event, 'cvml', 'yt-dev@lists.spacepope.org')">yt-dev@lists.spacepope.org</a><br>
> <a href="http://lists.spacepope.org/listinfo.cgi/yt-dev-spacepope.org" target="_blank">http://lists.spacepope.org/listinfo.cgi/yt-dev-spacepope.org</a><br>
><br>
_______________________________________________<br>
yt-dev mailing list<br>
<a href="javascript:;" onclick="_e(event, 'cvml', 'yt-dev@lists.spacepope.org')">yt-dev@lists.spacepope.org</a><br>
<a href="http://lists.spacepope.org/listinfo.cgi/yt-dev-spacepope.org" target="_blank">http://lists.spacepope.org/listinfo.cgi/yt-dev-spacepope.org</a><br>
</blockquote></div>