<div dir="ltr"><br><div class="gmail_extra"><br><br><div class="gmail_quote">On Fri, Aug 30, 2013 at 8:31 AM, Julien Danjou <span dir="ltr"><<a href="mailto:julien@danjou.info" target="_blank">julien@danjou.info</a>></span> wrote:<br>

<blockquote class="gmail_quote" style="margin:0px 0px 0px 0.8ex;border-left-width:1px;border-left-color:rgb(204,204,204);border-left-style:solid;padding-left:1ex"><div class="im">On Fri, Aug 30 2013, Davanum Srinivas wrote:<br>


<br>
> How about mandating that when one adds a DocImpact in a review it should<br>
> have a url to an etherpad/wiki with sufficient information for the doc<br>
> team? yes, +1 to let docs team figure out where to fit it into existing<br>
> guides.<br>
<br>
</div>That's a possibility.<br>
<br>
It still seems better to me to have the project's developers involved<br>
into the documentation than outsourcing it completely to another team.<br>
For example, there's no way to be sure the documentation team is going<br>
to understand what the developer meant on that wiki page, and that it'll<br>
then write correct instructions.<br></blockquote><div><br></div><div>While we do have a nice spike in new contributors to the OpenStack docs [1], we always have to refer to the original developer anyway, even with a detailed blueprint / wiki page. So be involved and be ready for questions from doc writers.</div>

<div> </div><blockquote class="gmail_quote" style="margin:0px 0px 0px 0.8ex;border-left-width:1px;border-left-color:rgb(204,204,204);border-left-style:solid;padding-left:1ex">
<br>
Having the patches sent on the documented project directly makes sure<br>
developers are going to review it and that to the doc writer who's<br>
improving the documentation for example got things right.<br>
<span class=""><font color="#888888"><br></font></span></blockquote><div><br></div><div>For integrated projects, this is certainly the way to go, as the docs program has had to draw the line at core. However, when people come to <span class=""><a href="http://docs.openstack.org">docs.openstack.org</a></span>, they want OpenStack docs. We need to get projects fitting into the install guide, configuration guide, end user guide, admin user guide, and so on. I'd like as much integrated information in those as possible by October 17th. We do publish continuously so all the projects need to get better at continuously updating docs.</div>

<div><br></div><div>I'd like to get docs closer to code all the time, but Sphinx hasn't met a few crucial requirements: translation, content reuse, PDF, and comment integration. I'd rather have repos and docs by audience than by project. To repeat, people come to <a href="http://docs.openstack.org">docs.openstack.org</a> for OpenStack docs. Let's make those better all the time.</div>

<div><br></div><div>Thanks,<br></div><div>Anne</div>







<div><br></div><div><br></div><div>1. <a href="https://github.com/openstack/openstack-manuals/graphs/contributors">https://github.com/openstack/openstack-manuals/graphs/contributors</a></div><div> </div><blockquote class="gmail_quote" style="margin:0px 0px 0px 0.8ex;border-left-width:1px;border-left-color:rgb(204,204,204);border-left-style:solid;padding-left:1ex">

<span class=""><font color="#888888">
--<br>
Julien Danjou<br>
-- Free Software hacker - independent consultant<br>
-- <a href="http://julien.danjou.info" target="_blank">http://julien.danjou.info</a><br>
</font></span><br>_______________________________________________<br>
OpenStack-dev mailing list<br>
<a href="mailto:OpenStack-dev@lists.openstack.org">OpenStack-dev@lists.openstack.org</a><br>
<a href="http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-dev" target="_blank">http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-dev</a><br>
<br></blockquote></div><br><br clear="all"><div><br></div>-- <br>Anne Gentle<br><a href="mailto:annegentle@justwriteclick.com" target="_blank">annegentle@justwriteclick.com</a>
</div></div>