<div dir="ltr"><br><div class="gmail_extra"><br><br><div class="gmail_quote">On Wed, Jun 25, 2014 at 3:22 PM, Sean Roberts <span dir="ltr"><<a href="mailto:seanrob@yahoo-inc.com" target="_blank">seanrob@yahoo-inc.com</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><div style="color:rgb(0,0,0);font-family:HelveticaNeue,'Helvetica Neue',Helvetica,Arial,'Lucida Grande',sans-serif;font-size:10pt;background-color:rgb(255,255,255)">
<div><span>Having many sub-directories follows the docs layout because of the different repos. If we go that way then we would need to treat each project directory separate with their own release directories like </span></div>
<div style="color:rgb(0,0,0);font-size:13px;font-family:HelveticaNeue,'Helvetica Neue',Helvetica,Arial,'Lucida Grande',sans-serif;font-style:normal;background-color:transparent"><span>/doc-spec/training-guides/juno</span></div>
<div style="color:rgb(0,0,0);font-size:13px;font-family:HelveticaNeue,'Helvetica Neue',Helvetica,Arial,'Lucida Grande',sans-serif;font-style:normal;background-color:transparent"><span style="background-color:transparent"><br>
</span></div><div style="color:rgb(0,0,0);font-size:13px;font-family:HelveticaNeue,'Helvetica Neue',Helvetica,Arial,'Lucida Grande',sans-serif;font-style:normal;background-color:transparent"><span style="background-color:transparent">The drawback will be that this makes finding approved specs difficult. The other projects are using the single /specs directory with a flat naming scheme like ml2-dell-afc-mech-driver.rst.</span></div>
<div style="color:rgb(0,0,0);font-size:13px;font-family:HelveticaNeue,'Helvetica Neue',Helvetica,Arial,'Lucida Grande',sans-serif;font-style:normal;background-color:transparent"><span style="background-color:transparent"><br>
</span></div><div style="color:rgb(0,0,0);font-size:13px;font-family:HelveticaNeue,'Helvetica Neue',Helvetica,Arial,'Lucida Grande',sans-serif;font-style:normal;background-color:transparent">For specs that overlay projects like install-guides and training-guides, it will be confusing which, what, where. Because of this I vote
for this structure</div><div style="color:rgb(0,0,0);font-size:13px;font-family:HelveticaNeue,'Helvetica Neue',Helvetica,Arial,'Lucida Grande',sans-serif;font-style:normal;background-color:transparent"><br>
</div><div style="color:rgb(0,0,0);font-size:13px;font-family:HelveticaNeue,'Helvetica Neue',Helvetica,Arial,'Lucida Grande',sans-serif;font-style:normal;background-color:transparent">doc-spec -</div><div style="color:rgb(0,0,0);font-size:13px;font-family:HelveticaNeue,'Helvetica Neue',Helvetica,Arial,'Lucida Grande',sans-serif;font-style:normal;background-color:transparent">
<span style="white-space:pre-wrap"> </span>specs -</div><div style="color:rgb(0,0,0);font-size:13px;font-family:HelveticaNeue,'Helvetica Neue',Helvetica,Arial,'Lucida Grande',sans-serif;font-style:normal;background-color:transparent">
<span style="white-space:pre-wrap">
</span>juno - (all docs program juno cycle RST reside here)</div><div style="color:rgb(0,0,0);font-size:13px;font-family:HelveticaNeue,'Helvetica Neue',Helvetica,Arial,'Lucida Grande',sans-serif;font-style:normal;background-color:transparent">
<span style="white-space:pre-wrap"> </span>tests -</div><div style="color:rgb(0,0,0);font-size:13px;font-family:HelveticaNeue,'Helvetica Neue',Helvetica,Arial,'Lucida Grande',sans-serif;font-style:normal;background-color:transparent">
<span style="white-space:pre-wrap"> </span>doc -</div><div></div><div> </div></div></div></blockquote><div><br></div><div>Yep, looks like that's the accepted structure. </div><div><br></div><div>Here's the starting openstack-infra/config patch:</div>
<div>
<p class=""><span class=""><a href="https://review.openstack.org/103115">https://review.openstack.org/103115</a></span></p><p class="">and I'll populate the repo with this repo:</p><p class="">
</p><p class=""><span class=""><a href="https://github.com/annegentle/docs-specs">https://github.com/annegentle/docs-specs</a></span> </p></div><div>I'll figure out how to get that repo uploaded next. </div><div>Thanks,</div>
<div>Anne</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"><div><div style="color:rgb(0,0,0);font-family:HelveticaNeue,'Helvetica Neue',Helvetica,Arial,'Lucida Grande',sans-serif;font-size:10pt;background-color:rgb(255,255,255)">
<div><div><b><br></b></div><div style="font-family:arial,helvetica,clean,sans-serif;font-weight:bold"><b>Sean Roberts</b></div><div>Infrastructure Strategy, Yahoo</div><div><span><a rel="nofollow" href="mailto:seanrob@yahoo-inc.com" target="_blank">seanrob@yahoo-inc.com</a></span></div>
<div><a href="tel:%28925%29%20980-4729" value="+19259804729" target="_blank">(925) 980-4729</a></div></div> <div><br><br></div><div style="display:block"> <div style="font-family:HelveticaNeue,'Helvetica Neue',Helvetica,Arial,'Lucida Grande',sans-serif;font-size:10pt">
<div style="font-family:HelveticaNeue,'Helvetica Neue',Helvetica,Arial,'Lucida Grande',sans-serif;font-size:12pt"><div><div class="h5"> <div dir="ltr"> <font face="Arial"> On Wednesday, June 25, 2014 12:59 PM, Andreas Jaeger <<a href="mailto:aj@suse.com" target="_blank">aj@suse.com</a>> wrote:<br>
</font> </div> <br><br> </div></div><div><div><div class="h5">On 06/25/2014 04:56 PM, Anne Gentle wrote:<br clear="none">> Hi all, <br clear="none">> I wanted to hear more from the teams about a need for a doc-specs repo.<br clear="none">
> The training team has started to bring specs into their repo. I'm happy<br clear="none">> to get this started for the Documentation
program but wanted to get some<br clear="none">> input. <br clear="none">> <br clear="none">> I'd like to have an openstack/doc-spec repo set up with different<br clear="none">> directories for each area of the documentation. Some projects have<br clear="none">
> designated by release as well, though since only our install guide and<br clear="none">> config guides are "released" I think we could just have:<br clear="none">> /api<br clear="none">> /training<br clear="none">
> /user<br clear="none">> /appdev<br clear="none">> juno/ops (this is where install and config specs would live)<br clear="none">> /security<br clear="none"><br clear="none">Some of this is not really clear. Why not just use the repository names<br clear="none">
like:<br clear="none">api-site<br clear="none">operations-guide<br clear="none">manuals (or openstack-manuals)<br clear="none">doc-tools (or openstack-doc-tools)<br clear="none">security<br clear="none">training-guides ?<br clear="none">
<br clear="none">I'm fine with giving it a try for a release cycle,<br clear="none">Andreas<br clear="none">-- <br clear="none"> Andreas Jaeger aj@{<a href="http://suse.com" target="_blank">suse.com</a>,<a href="http://opensuse.org" target="_blank">opensuse.org</a>} Twitter/Identica: jaegerandi<br clear="none">
SUSE LINUX Products GmbH, Maxfeldstr. 5, 90409 Nürnberg, Germany<br clear="none"> GF: Jeff Hawn,Jennifer Guild,Felix Imendörffer,HRB16746 (AG Nürnberg)<br clear="none"> GPG fingerprint = 93A3 365E CE47 B889 DF7F FED1 389A 563C C272 A126</div>
</div><div><br clear="none"><div class=""><br clear="none">_______________________________________________<br clear="none">Openstack-docs mailing list<br clear="none"><a shape="rect" href="mailto:Openstack-docs@lists.openstack.org" target="_blank">Openstack-docs@lists.openstack.org</a><br clear="none">
<a shape="rect" href="http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs" target="_blank">http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs</a></div></div><br><br></div> </div> </div> </div>
</div></div></blockquote></div><br></div></div>