<div dir="ltr">How do we go about doing this?  Something through <a href="http://yt.readthedocs.org">yt.readthedocs.org</a>?  Or a secret URL on <a href="http://yt-project.org/docs/3.0test">yt-project.org/docs/3.0test</a> or something?  </div>

<div class="gmail_extra"><br><br><div class="gmail_quote">On Fri, Dec 13, 2013 at 9:24 AM, Matthew Turk <span dir="ltr"><<a href="mailto:matthewturk@gmail.com" target="_blank">matthewturk@gmail.com</a>></span> wrote:<br>

<blockquote class="gmail_quote" style="margin:0 0 0 .8ex;border-left:1px #ccc solid;padding-left:1ex"><div class="im">On Fri, Dec 13, 2013 at 11:21 AM, Cameron Hummels <<a href="mailto:chummels@gmail.com">chummels@gmail.com</a>> wrote:<br>


> "... given that there is already so much that needs to be documented, I<br>
> don't think adding epsilon on top of that is a big deal."<br>
><br>
> This is exactly the sentiment that I was trying to avoid.  The longer the<br>
> docs are out of date, the easier it is to justify not documenting that<br>
> newest push that one makes to the codebase.<br>
<br>
</div>I agree with this, but as I noted before, I think we can have a build<br>
of the docs that is not linked from the main website until it is<br>
largely up to date.<br>
<div class="HOEnZb"><div class="h5"><br>
><br>
><br>
> I understand that things are busy with the unit refactor, but I would say<br>
> that as soon as it is accepted we should aim to have fully updated docs that<br>
> are viewable to the public.<br>
><br>
> Matt, I can try to test the cookbook recipes if that makes it easier.<br>
><br>
> Cameron<br>
><br>
><br>
><br>
><br>
><br>
> On Fri, Dec 13, 2013 at 9:12 AM, Nathan Goldbaum <<a href="mailto:nathan12343@gmail.com">nathan12343@gmail.com</a>><br>
> wrote:<br>
>><br>
>> I agree with Matt.  If the 3.0 docs were only somewhat out of sync that<br>
>> would be one thing, but there's about a year's worth of work that needs to<br>
>> be covered before the docs are correct.<br>
>><br>
>> I understand your concern about documenting new features, however given<br>
>> that there is already so much that needs to be documented, I don't think<br>
>> adding epsilon on top of that is a big deal.<br>
>><br>
>> On Friday, December 13, 2013, Matthew Turk wrote:<br>
>>><br>
>>> On Fri, Dec 13, 2013 at 10:37 AM, Cameron Hummels <<a href="mailto:chummels@gmail.com">chummels@gmail.com</a>><br>
>>> 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<br>
>>> > from<br>
>>> > doing this is that I had to pip install the new bootstrap theme in<br>
>>> > 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<br>
>>> > 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="mailto:matthewturk@gmail.com">matthewturk@gmail.com</a>><br>
>>> > 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="mailto: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<br>
>>> >> > now, a<br>
>>> >> > yt-3.0 branch exists in the yt-doc repository, but there are very<br>
>>> >> > 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<br>
>>> >> > the<br>
>>> >> > repository and building locally.  I think by putting the 3.0 docs on<br>
>>> >> > the<br>
>>> >> > webpage, it will make it more likely that people contribute docs<br>
>>> >> > when<br>
>>> >> > they<br>
>>> >> > contribute new code changes, whereas if we wait too long, the<br>
>>> >> > 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<br>
>>> >> > 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="mailto: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="mailto: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="mailto: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="mailto: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>
>> yt-dev mailing list<br>
>> <a href="mailto: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="mailto: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="mailto: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>
</div></div></blockquote></div><br><br clear="all"><div><br></div>-- <br>Cameron Hummels<div>Postdoctoral Researcher</div><div>Steward Observatory</div><div>University of Arizona</div><div><a href="http://chummels.org" target="_blank">http://chummels.org</a></div>


</div>