Open Stack

Hi, all,I'm a newbie and have been mostly lurking and learning here...
I am doing some work on the HA Guide, which we are writing as an adjunct to the Install Guide.We anticipate a lot of sections that roughly say, "Install and configure <blah> following the <linked>instructions in the Install Guide, then do this to implement HA."
It is going to be awkward if we have to link to multiple Install Guides for different platforms.
We hope that projects not covered in the HA Guide ((this would be non-integrated services)and they may well also need to link into the Install Guide.
Just something to consider as part of these discussions,
meg

 
      From: Anne Gentle <annegentle at justwriteclick.com>
 To: Bernd Bausch <berndbausch at gmail.com> 
Cc: "openstack-docs at lists.openstack.org" <openstack-docs at lists.openstack.org> 
 Sent: Friday, March 27, 2015 1:58 PM
 Subject: Re: [OpenStack-docs] [install guide] Conditional text in RST
   


On Fri, Mar 27, 2015 at 3:46 PM, Bernd Bausch <berndbausch at gmail.com> wrote:

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.

Has anybody investigated whether the built-in Sphinx extension "ifconfig" (http://sphinx-doc.org/ext/ifconfig.html) would be an adequate solution?


Yes. 
Refer to http://lists.openstack.org/pipermail/openstack-docs/2015-February/005863.html 
For consideration is that going to RST/Sphinx is meant to simplify authoring. Conditional, especially at the phrase level, is not simplification.
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.
Thanks,Anne


 

Bernd Bausch
berndbausch at gmail.com
_______________________________________________
OpenStack-docs mailing list
OpenStack-docs at lists.openstack.org
http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs




-- 
Anne Gentle
annegentle at justwriteclick.com
_______________________________________________
OpenStack-docs mailing list
OpenStack-docs at lists.openstack.org
http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs


   
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.openstack.org/pipermail/openstack-docs/attachments/20150328/d0121d99/attachment.html>