[openstack-dev] [OpenStack-docs] [telemetry] Ceilometer and Aodh install guide(s)

Ravi, Goutham Goutham.Ravi at netapp.com
Tue Jun 28 13:31:44 UTC 2016

Hi Ildikó, 

Please take a look at the tooling in https://review.openstack.org/#/c/317152/ - I tried preserving the ‘only::’ tags because I had a similar concern about all the common parts to someone compiling the install guide from time to time. We were discussing whether this was a good solution as opposed to using ‘include’ directives with distro-specific files referencing common sections; or ignore both and maintain four different files (obs, debian, rdo, ubuntu) with common sections included within each. 


On 6/28/16, 8:55 AM, "Ildikó Váncsa" <ildiko.vancsa at ericsson.com> wrote:


I'm currently working on to move the Install Guide for Ceilometer [1] and Aodh [2] under the project trees. I faced with a few difficulties so far about which I would like to ask your opinion.

First of all these two projects are under the Telemetry umbrella, so they are not completely separate. I tried to name the services in the documents accordingly in the files. My question here would be whether these two guides will be included in the overall document as two totally standalone services or we can link them together somehow?

The other question I had in mind is in connection with removing ".. only::". As Ceilometer is integrated with several other projects it needs additional configuration steps, where we have distro specific steps to follow. I chose the direction of extracting the common parts and reused them in the distro specific files. The end result still looks ugly and I have concerns about maintainability. We merged a first version of the structure, but I'm happy to change if we can come up with a better solution. Do you have suggestions on this?

I have a third less urgent question. The install-guide has it's own folder at the same level where these two projects have their 'doc' folder. I would assume other projects have the same or similar folder for the developer docs. Would that be reasonable/possible to have one main 'doc' folder for all the docs?

Thanks and Best Regards,

[1] https://review.openstack.org/#/c/330051/ 
[2] https://review.openstack.org/#/c/330048/ 

OpenStack-docs mailing list
OpenStack-docs at lists.openstack.org

More information about the OpenStack-dev mailing list