<div dir="ltr"><br><div class="gmail_extra"><br><div class="gmail_quote">On Fri, Mar 27, 2015 at 10:29 PM, Meg McRoberts <span dir="ltr"><<a href="mailto:dreidellhasa@yahoo.com" target="_blank">dreidellhasa@yahoo.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:12px;background-color:rgb(255,255,255)"><div>Hi, all,</div><div dir="ltr">I'm a newbie and have been mostly lurking and learning here...</div></div></div></blockquote><div><br></div><div>Welcome! Great to see you asking good questions.</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:12px;background-color:rgb(255,255,255)"><div dir="ltr"><br></div><div dir="ltr">I am doing some work on the HA Guide, which we are writing as an adjunct to the Install Guide.</div><div dir="ltr">We anticipate a lot of sections that roughly say, "Install and configure <blah> following the <linked></div><div dir="ltr">instructions in the Install Guide, then do this to implement HA."</div><div dir="ltr"><br></div><div dir="ltr">It is going to be awkward if we have to link to multiple Install Guides for different platforms.</div></div></div></blockquote><div><br></div><div>So, you already "have" to do that for the Install Guides that are published. Currently we get three guides from one set of source.</div><div><br></div><div>These are the three titles with separate links for each.<br><a href="http://docs.openstack.org/juno/install-guide/install/zypper/content/">http://docs.openstack.org/juno/install-guide/install/zypper/content/</a> is <br>Installation Guide for openSUSE 13.1 and SUSE Linux Enterprise Server 11</div><div><br></div><div><a href="http://docs.openstack.org/juno/install-guide/install/yum/content/">http://docs.openstack.org/juno/install-guide/install/yum/content/</a> is</div><div>Installation Guide for Red Hat Enterprise Linux 7, CentOS 7, and Fedora 20</div><div><br></div><div><a href="http://docs.openstack.org/juno/install-guide/install/apt/content/">http://docs.openstack.org/juno/install-guide/install/apt/content/</a> is<br>Installation Guide for Ubuntu 14.04 (LTS)</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:12px;background-color:rgb(255,255,255)"><div dir="ltr"><br></div><div dir="ltr">We hope that projects not covered in the HA Guide ((this would be non-integrated services)</div><div dir="ltr">and they may well also need to link into the Install Guide.</div><div dir="ltr"><br></div></div></div></blockquote><div><br></div><div>Interesting point. I think what'll happen in the expansive future is projects will write and maintain install instructions outside of a common repo. Then we'll eventually be able to incorporate all of them into larger install guides. </div><div><br></div><div>If there's Ubuntu packaging for one project prior to it being packaged on RHEL, the project would write an RST file for the Ubuntu packages first, to be included into the Ubuntu OpenStack install guide. </div><div><br></div><div>Also we should consider that projects themselves would write a chapter for inclusion in a larger HA Guide. So yep, the linking gets complex and the collections should be thought through ahead of time. </div><div> <br></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:12px;background-color:rgb(255,255,255)"><div dir="ltr"></div><div dir="ltr">Just something to consider as part of these discussions,<br></div><div dir="ltr"></div></div></div></blockquote><div><br></div><div>Great points, thanks for bringing them up.</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:12px;background-color:rgb(255,255,255)"><div dir="ltr">meg<br></div><div><span></span></div><br> <blockquote style="border-left-width:2px;border-left-style:solid;border-left-color:rgb(16,16,255);margin-left:5px;margin-top:5px;padding-left:5px"> <div style="font-family:HelveticaNeue,'Helvetica Neue',Helvetica,Arial,'Lucida Grande',sans-serif;font-size:12px"> <div style="font-family:HelveticaNeue,'Helvetica Neue',Helvetica,Arial,'Lucida Grande',sans-serif;font-size:16px"> <div dir="ltr"> <hr size="1"> <font face="Arial"> <b><span style="font-weight:bold">From:</span></b> Anne Gentle <<a href="mailto:annegentle@justwriteclick.com" target="_blank">annegentle@justwriteclick.com</a>><br> <b><span style="font-weight:bold">To:</span></b> Bernd Bausch <<a href="mailto:berndbausch@gmail.com" target="_blank">berndbausch@gmail.com</a>> <br><b><span style="font-weight:bold">Cc:</span></b> "<a href="mailto:openstack-docs@lists.openstack.org" target="_blank">openstack-docs@lists.openstack.org</a>" <<a href="mailto:openstack-docs@lists.openstack.org" target="_blank">openstack-docs@lists.openstack.org</a>> <br> <b><span style="font-weight:bold">Sent:</span></b> Friday, March 27, 2015 1:58 PM<br> <b><span style="font-weight:bold">Subject:</span></b> Re: [OpenStack-docs] [install guide] Conditional text in RST<br> </font> </div><div><div class="h5"> <div><br><div><div><div dir="ltr"><br clear="none"><div><br clear="none"><div>On Fri, Mar 27, 2015 at 3:46 PM, Bernd Bausch <span dir="ltr"><<a rel="nofollow" shape="rect" href="mailto:berndbausch@gmail.com" target="_blank">berndbausch@gmail.com</a>></span> wrote:<br clear="none"><blockquote 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">One of the points raised in the last install guide meeting was the question if separate sources should be created for the various Linux distributions or if one source should be used, as is currently the case with the DocBook-based guides. I believe that the team tended towards separate sources because it wasn't clear how conditional text of the form "if SUSE then these install instructions, else if Redhat then those instructions" could be implemented in RST.<br clear="none">
<br clear="none">
Has anybody investigated whether the built-in Sphinx extension "ifconfig" (<a rel="nofollow" shape="rect" href="http://sphinx-doc.org/ext/ifconfig.html" target="_blank">http://sphinx-doc.org/ext/ifconfig.html</a>) would be an adequate solution?<br clear="none"></blockquote><div><br clear="none"></div><div>Yes. </div><div><br clear="none"></div><div>Refer to <a rel="nofollow" shape="rect" href="http://lists.openstack.org/pipermail/openstack-docs/2015-February/005863.html" target="_blank">http://lists.openstack.org/pipermail/openstack-docs/2015-February/005863.html</a> </div><div><br clear="none"></div><div>For consideration is that going to RST/Sphinx is meant to simplify authoring. Conditional, especially at the phrase level, is not simplification.</div><div><br clear="none"></div><div>Please do study it further though if you are interested! I could be persuaded to have one set of guides remain complicated if presented with enough information. My sense of it today is that it's not part of our primary goals going forward though.</div><div><br clear="none"></div><div>Thanks,</div><div>Anne</div><div><br><br></div><div><div><br clear="none"></div><div> </div></div><blockquote 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><span><font color="#888888"><div><br clear="none">
Bernd Bausch<br clear="none">
<a rel="nofollow" shape="rect" href="mailto:berndbausch@gmail.com" target="_blank">berndbausch@gmail.com</a><br clear="none">
_______________________________________________<br clear="none">
OpenStack-docs mailing list<br clear="none">
<a rel="nofollow" shape="rect" href="mailto:OpenStack-docs@lists.openstack.org" target="_blank">OpenStack-docs@lists.openstack.org</a><br clear="none">
<a rel="nofollow" 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><br clear="none">
</font></span></blockquote></div><br clear="none"><br clear="all"><div><br clear="none"></div>-- <br clear="none"><div>Anne Gentle<br clear="none"><a rel="nofollow" shape="rect" href="mailto:annegentle@justwriteclick.com" target="_blank">annegentle@justwriteclick.com</a></div><div>
</div></div></div></div></div><br><div>_______________________________________________<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><br clear="none"></div><br><br></div> </div></div></div> </div> </blockquote> </div></div></blockquote></div><br><br clear="all"><div><br></div>-- <br><div class="gmail_signature">Anne Gentle<br><a href="mailto:annegentle@justwriteclick.com" target="_blank">annegentle@justwriteclick.com</a></div>
</div></div>