Open Stack

On Fri, Mar 27, 2015 at 10:29 PM, Meg McRoberts <dreidellhasa at yahoo.com>
wrote:

> Hi, all,
> I'm a newbie and have been mostly lurking and learning here...
>

Welcome! Great to see you asking good questions.


>
> 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.
>

So, you already "have" to do that for the Install Guides that are
published. Currently we get three guides from one set of source.

These are the three titles with separate links for each.
http://docs.openstack.org/juno/install-guide/install/zypper/content/ is
Installation Guide for openSUSE 13.1 and SUSE Linux Enterprise Server 11

http://docs.openstack.org/juno/install-guide/install/yum/content/ is
Installation Guide for Red Hat Enterprise Linux 7, CentOS 7, and Fedora 20

http://docs.openstack.org/juno/install-guide/install/apt/content/ is
Installation Guide for Ubuntu 14.04 (LTS)


>
> 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.
>
>
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.

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.

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.


> Just something to consider as part of these discussions,
>

Great points, thanks for bringing them up.
Anne


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


-- 
Anne Gentle
annegentle at justwriteclick.com
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.openstack.org/pipermail/openstack-docs/attachments/20150327/defb5e32/attachment-0001.html>