[OpenStack-docs] [install-guide] [manila] Project specific install guide -> use of the "only" tag

Andreas Jaeger aj at suse.com
Fri Jun 24 05:41:07 UTC 2016


On 06/23/2016 08:05 PM, Goutham Ravi wrote:
> Hi,
>
> [At the outset, I apologize, I may be late to this train. I hadn’t
> subscribed to this mailing list.]
>
> The current structure of the install guide allows for a way to specify
> per-distro commands inside a file using the “only” directive. However,
> the install-guides that have been worked on so far have separate rst
> files for each distribution, examples: Heat [1] Magnum [2]. Spyros
> proposed to update the cookie-cutter to follow this style [3].
>
> While I think this is a fine approach… source content wise, that this is
> not as easily “maintainable”, because we are duplicating a lot of
> similar information between these documents. I wanted to mimic what
> openstack-manuals is doing with the current install-guide. I put up the
> manila patch [3], and it currently builds to targets
> ‘install-guide/build-rdo’, ‘install-guide/build-ubuntu’,
> ‘install-guide/build-obs’, ‘install-guide/build-debian’.

If you look at Spyros' change, you see that it includes the common 
content, so there is little duplication,

Andreas

>
> I wanted to gather opinions on this approach.
>
> [1]
> http://docs.openstack.org/project-install-guide/orchestration/draft/index.html
>
> [2] https://review.openstack.org/#/c/330051/
>
> [3] https://review.openstack.org/#/c/332161/
>
> [4] https://review.openstack.org/#/c/317152/
>
> Thanks,
>
> Goutham
>
>
>
> _______________________________________________
> OpenStack-docs mailing list
> OpenStack-docs at lists.openstack.org
> http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs
>


-- 
  Andreas Jaeger aj@{suse.com,opensuse.org} Twitter: jaegerandi
   SUSE LINUX GmbH, Maxfeldstr. 5, 90409 Nürnberg, Germany
    GF: Felix Imendörffer, Jane Smithard, Graham Norton,
        HRB 21284 (AG Nürnberg)
     GPG fingerprint = 93A3 365E CE47 B889 DF7F  FED1 389A 563C C272 A126




More information about the OpenStack-docs mailing list