Re: [openstack-dev] [OpenStack-docs] [telemetry] Ceilometer and Aodh install guide(s)
snip > > Do you have a good proposal for structuring things? [] I am assuming that you have distro specific instructions mixed with non-specific ones. I can only suggest what has worked for me in the past. I created a common file describing the process devoid of any instructions, distro specific or otherwise. Then I created distro specific procedures containing all the needed instructions with the appropriate level of detail. The steps on the common file serve as the headings for all distro specific procedures. That makes the common file an excellent introduction to all procedures while keeping the entire instructions in a single place. This system is not perfect however. There is some content repetition on the instructions side of things. This could be avoided if we used the .. only:: directive on the instructions side. You would then have a high level overview of the procedure, common to all distros, and a single file containing all instructions for all distros differentiated by the only directive. I guess what I am saying is that there is no magic bullet here. At the end of the day, the content determines what modularity model you can use, IMO. Regards, Rodrigo > > Thanks, > /Ildikó snip __ OpenStack Development Mailing List (not for usage questions) Unsubscribe: openstack-dev-requ...@lists.openstack.org?subject:unsubscribe http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-dev
Re: [openstack-dev] [telemetry] Ceilometer and Aodh install guide(s)
> -Original Message- > From: Ildikó Váncsa [mailto:ildiko.van...@ericsson.com] > Sent: Tuesday, June 28, 2016 7:56 AM > To: openstack-d...@lists.openstack.org > Cc: openstack-dev@lists.openstack.org > Subject: [OpenStack-docs] [telemetry] Ceilometer and Aodh install > guide(s) snip > > 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 would suggest a modular approach with the use of .. include:: It would look something like this: == Instructions for Ubuntu == .. include:: file-with-common-steps.rst .. include:: file-with-ubuntu-steps.rst Then you can do the same for each distro. Having all the separate procedures in different files should help solve your maintainability concerns. Regards, Rodrigo Caballero snip > > Thanks and Best Regards, > Ildikó > > [1] https://review.openstack.org/#/c/330051/ > [2] https://review.openstack.org/#/c/330048/ > > ___ > OpenStack-docs mailing list > openstack-d...@lists.openstack.org > http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs __ OpenStack Development Mailing List (not for usage questions) Unsubscribe: openstack-dev-requ...@lists.openstack.org?subject:unsubscribe http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-dev
