<div dir="ltr">Hi Ben, <div>Since manila just entered incubation, the openstack-manuals repo and common documentation will not include it until it is integrated. During incubation we ask you to start documentation in your own repo and identify what will eventually move into common docs. See <a href="https://wiki.openstack.org/wiki/Documentation/IncubateIntegrate">https://wiki.openstack.org/wiki/Documentation/IncubateIntegrate</a>.</div><div><br></div><div><h4 style="margin:10px 0px;font-family:'PT Sans',sans-serif;line-height:20px;color:rgb(51,51,51);font-size:17.5px"><span class="" id="You_just_got_incubated.2C_now_what.3F">You just got incubated, now what?</span></h4><p style="margin:0px 0px 10px;color:rgb(51,51,51);font-family:'Arial Unicode MS',Arial,sans-serif;font-size:14px;line-height:20px">While you're incubating we like to see documentation in your repo in doc/source, built with Sphinx. You can start to use the oslosphinx theme, a common theme for OpenStack projects, at the point your project begins incubation. You must indicate that you're incubating by setting the oslosphinx configuration by ensuring your sphinx conf.py has incubating set to True for the theme:</p><pre style="padding:9.5px;font-family:Monaco,Menlo,Consolas,'Courier New',monospace;font-size:13px;color:rgb(51,51,51);border-top-left-radius:4px;border-top-right-radius:4px;border-bottom-right-radius:4px;border-bottom-left-radius:4px;margin-top:0px;margin-bottom:10px;line-height:20px;word-break:break-all;word-wrap:break-word;white-space:pre-wrap;border:1px solid rgba(0,0,0,0.14902);background-color:rgb(245,245,245)">   'html_theme_options = {'incubating': True}'
</pre><p style="margin:0px 0px 10px;color:rgb(51,51,51);font-family:'Arial Unicode MS',Arial,sans-serif;font-size:14px;line-height:20px">You can publish to <a href="http://docs.openstack.org/developer">docs.openstack.org/developer</a> while incubating. Prior to incubation we suggest publishing to ReadTheDocs.org or your own domain and avoid using the OpenStack logo or trademark unless you have permission as outlined in the brand guidelines from <a rel="nofollow" class="" href="http://www.openstack.org/brand/" style="color:rgb(0,136,204);text-decoration:none;padding-right:13px;background:url(https://wiki.openstack.org/w/skins/strapping/images/external-link-ltr-icon.png) 100% 50% no-repeat">http://www.openstack.org/brand/</a>.</p><p style="margin:0px 0px 10px;color:rgb(51,51,51);font-family:'Arial Unicode MS',Arial,sans-serif;font-size:14px;line-height:20px">While you're incubating and gathering developer contributors, be sure to also find writer resources. Your developers can probably manage the contributor developer documentation but be thinking about how you'll write your REST API reference documentation, your install documentation, your configuration documentation, your operator and admin documentation, and end-user documentation for CLI and dashboard interaction. You'll need to prove you're able to support your users (ops, admins, and end-users) when graduating to integrated, through docs and answers on <a href="http://ask.openstack.org">ask.openstack.org</a>.</p><p style="margin:0px 0px 10px;color:rgb(51,51,51);font-family:'Arial Unicode MS',Arial,sans-serif;font-size:14px;line-height:20px">While you're integrating, I'd suggest that your doc/source directory become the landing place for your documentation. What you'll want to look forward to is writing in such a way that your pages can be used for these deliverables in the official OpenStack documentation, found at <a rel="nofollow" class="" href="https://wiki.openstack.org/wiki/Documentation/ContentSpecs" style="color:rgb(0,136,204);text-decoration:none;padding-right:13px;background:url(https://wiki.openstack.org/w/skins/strapping/images/lock-icon.png) 100% 50% no-repeat">https://wiki.openstack.org/wiki/Documentation/ContentSpecs</a>.</p><p style="margin:0px 0px 10px;color:rgb(51,51,51);font-family:'Arial Unicode MS',Arial,sans-serif;font-size:14px;line-height:20px">Always be aware that the OpenStack Documentation Program prioritizes the core projects above integrated, but we provide frameworks and reviews and try to help with orientation as much as possible. We're just not in a position to provide shared resources such as technical writers assigned to each project, for example. Rather, we expect the projects to assign a doc liaison who can interact with the documentation group through the openstack-docs mailing list and #openstack-doc IRC channel. The docs team holds weekly meetings and it's great to have doc liaisons attend the meetings that are in their time zone. The meeting schedule and agenda are found here: <a rel="nofollow" class="" href="https://wiki.openstack.org/wiki/Meetings/DocTeamMeeting" style="color:rgb(0,136,204);text-decoration:none;padding-right:13px;background:url(https://wiki.openstack.org/w/skins/strapping/images/lock-icon.png) 100% 50% no-repeat">https://wiki.openstack.org/wiki/Meetings/DocTeamMeeting</a>.</p></div><div><br></div><div><br></div></div><div class="gmail_extra"><br><br><div class="gmail_quote">On Fri, Sep 5, 2014 at 7:27 AM, Swartzlander, Ben <span dir="ltr"><<a href="mailto:Ben.Swartzlander@netapp.com" target="_blank">Ben.Swartzlander@netapp.com</a>></span> wrote:<br><blockquote class="gmail_quote" style="margin:0 0 0 .8ex;border-left:1px #ccc solid;padding-left:1ex">





<div lang="EN-US" link="blue" vlink="purple">
<div>
<p class="MsoNormal">Now that the project is incubated, we should be moving our docs from the openstack wiki to the openstack-manuals project. Rushil Chugh has volunteered to lead this effort so please coordinate any updates to documentation with him (and me).
 Our goal is to have the updates to openstack-manuals upstream by Sept 22. It will go faster if we can split up the work and do it in parallel.<span class="HOEnZb"><font color="#888888"><u></u><u></u></font></span></p><span class="HOEnZb"><font color="#888888">
<p class="MsoNormal"><u></u> <u></u></p>
<p class="MsoNormal">-Ben<u></u><u></u></p>
<p class="MsoNormal"><u></u> <u></u></p>
</font></span></div>
</div>

<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></div>