<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=us-ascii">
</head>
<body style="word-wrap: break-word; -webkit-nbsp-mode: space; -webkit-line-break: after-white-space;" class="">
<div class="">We are eager to improve our documentation, but I think quite a few of us who work on Ironic documentation have a strong preference to keeping those documents in-tree. This allows us to enforce contributors having documentation changes or additions
merge at the same time or in close proximity to the code changes and is much easier for us to interact with. I have the willingness to help implement admin guides in-tree sooner, but if the docs team doesn't want this yet obviously there's nothing to help
with.</div>
<div class=""><br class="">
</div>
As for what to do today today; I agree with Ruby on this entirely. I'm adding an item to Monday's Ironic meeting agenda to reach consensus on what our project will do in the meantime. My recommendation will be option B as listed by Ruby; build out a better
admin-guide in tree as part of our developer docs, and migrate them over, just like we did for the install guide, when the work to allow in-tree admin guides is complete.
<div class=""><br class="">
</div>
<div class="">Thanks,</div>
<div class="">Jay Faulkner</div>
<div class=""><br class="">
<div class="">
<div>
<blockquote type="cite" class="">
<div class="">On Oct 11, 2016, at 9:38 AM, Ruby Loo <<a href="mailto:opensrloo@gmail.com" class="">opensrloo@gmail.com</a>> wrote:</div>
<br class="Apple-interchange-newline">
<div class="">
<div dir="ltr" class="">From my point of view, the rush is so that we can be more efficient with all of our time/efforts. In ironic, we have a bit of a mess. We now have duplicated (and perhaps out-of-sync) admin-related information in our developer docs [1]
as well as in the official admin guide [2] -- the latter content was added but I am unaware of that knowledge/coordination being done with the ironic community :-(
<div class="">
<div class=""><br class="">
</div>
<div class="">Should we :</div>
<div class="">A. move our admin-related information from our developer docs to the existing admin guide; then move the admin guide to the new in-tree solution later</div>
<div class=""><br class="">
</div>
<div class="">B. replace what is in the existing admin guide with a pointer to the developer docs; then move the admin content to the new in-tree solution later</div>
<div class=""><br class="">
</div>
<div class="">C. status quo until the new in-tree solution is available</div>
<div class=""><br class="">
</div>
<div class="">--ruby</div>
<div class=""><br class="">
</div>
<div class="">[1] <a href="http://docs.openstack.org/developer/ironic/" class="">http://docs.openstack.org/developer/ironic/</a></div>
<div class="">[2] <a href="http://docs.openstack.org/admin-guide/baremetal.html" class="">http://docs.openstack.org/admin-guide/baremetal.html</a></div>
<div class=""><br class="">
<div class="gmail_extra"><br class="">
<div class="gmail_quote">On Mon, Oct 10, 2016 at 7:07 PM, Lana Brindley <span dir="ltr" class="">
<<a href="mailto:openstack@lanabrindley.com" target="_blank" class="">openstack@lanabrindley.com</a>></span> wrote:<br class="">
<blockquote class="gmail_quote" style="margin:0px 0px 0px 0.8ex;border-left:1px solid rgb(204,204,204);padding-left:1ex">
<span class="gmail-">On 10/10/16 16:25, Andreas Jaeger wrote:<br class="">
> On 2016-10-10 01:37, Steve Martinelli wrote:<br class="">
>> On Oct 9, 2016 6:57 PM, "Lana Brindley" <<a href="mailto:openstack@lanabrindley.com" class="">openstack@lanabrindley.com</a><br class="">
>> <mailto:<a href="mailto:openstack@lanabrindley.com" class="">openstack@<wbr class="">lanabrindley.com</a>>> wrote:<br class="">
>>><br class="">
>>> Why the rush?<br class="">
>><br class="">
>> I think its more eagerness than rush. Project teams made a lot of head<br class="">
>> way with the API ref and install guides being in-tree that they want to<br class="">
>> keep the momentum with the admin guide.<br class="">
><br class="">
> Those teams are more than welcome to contribute today to the<br class="">
> openstack-manuals repository! Is there anything we can help these?<br class="">
><br class="">
> Andreas<br class="">
><br class="">
<br class="">
</span>Yes, Andreas makes a good point. If there's content you want in the guides now, we can help you with that.<br class="">
<span class="gmail-HOEnZb"><font color="#888888" class=""><br class="">
Lana<br class="">
</font></span>
<div class="gmail-HOEnZb">
<div class="gmail-h5"><br class="">
--<br class="">
Lana Brindley<br class="">
Technical Writer<br class="">
Rackspace Cloud Builders Australia<br class="">
<a href="http://lanabrindley.com/" rel="noreferrer" target="_blank" class="">http://lanabrindley.com</a><br class="">
<br class="">
</div>
</div>
<br class="">
______________________________<wbr class="">______________________________<wbr class="">______________<br class="">
OpenStack Development Mailing List (not for usage questions)<br class="">
Unsubscribe: <a href="http://OpenStack-dev-request@lists.openstack.org/?subject:unsubscribe" rel="noreferrer" target="_blank" class="">
OpenStack-dev-request@lists.<wbr class="">openstack.org?subject:<wbr class="">unsubscribe</a><br class="">
<a href="http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-dev" rel="noreferrer" target="_blank" class="">http://lists.openstack.org/<wbr class="">cgi-bin/mailman/listinfo/<wbr class="">openstack-dev</a><br class="">
<br class="">
</blockquote>
</div>
<br class="">
</div>
</div>
</div>
</div>
__________________________________________________________________________<br class="">
OpenStack Development Mailing List (not for usage questions)<br class="">
Unsubscribe: <a href="mailto:OpenStack-dev-request@lists.openstack.org" class="">
OpenStack-dev-request@lists.openstack.org</a>?subject:unsubscribe<br class="">
<a href="http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-dev" class="">http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-dev</a><br class="">
</div>
</blockquote>
</div>
<br class="">
</div>
</div>
</body>
</html>