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

Ildikó Váncsa ildiko.vancsa at ericsson.com
Tue Jun 28 16:30:52 UTC 2016


@Julien: +1 to the one 'doc' folder.

I think it's not yet decided whether it should be modular, using '.. only::' or we can/will have both.

I use the modular approach as well right now, I have many files containing the common things and the distro specific steps. For Ceilometer it resulted in way more files and folders than it should be in my opinion. And I think it will discourage people from contributing to it. The more files you have the harder to see how the guide will look like after the build, which can make it slower to identify and then modify the files.

Do you have a good proposal for structuring things?


> -----Original Message-----
> From: Spyros Trigazis [mailto:strigazi at gmail.com]
> Sent: June 28, 2016 17:18
> To: OpenStack Development Mailing List (not for usage questions); Ildikó Váncsa; openstack-docs at lists.openstack.org
> Subject: Re: [openstack-dev] [telemetry] Ceilometer and Aodh install guide(s)
> +1 on the modular approach by Rodrigo Caballero
> I'm writing magnum's guide and I'm working on the debian guide. Debian's guide will have a couple of differences and I plan to move
> them in other files or/and break the existing common config files.
> IMO, one of the goals of the project specific guides was to let teams decide what works for them. If the output guide is similar to
> others, I think you can choose what suits you best.
> Cheers,
> Spyros
> On 28 June 2016 at 16:44, Julien Danjou <julien at danjou.info> wrote:
> 	On Tue, Jun 28 2016, Ildikó Váncsa wrote:
> 	> 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?
> 	This is our long-term objective for Telemetry projects.
> 	Gnocchi already have only one doc/ folder with all the documentation,
> 	From installation to usage.
> 	I don't think our projects are not big enough and have enough resources
> 	to start maintaining different documentations with different scopes,
> 	etc.
> 	--
> 	Julien Danjou
> 	;; Free Software hacker
> 	;; https://julien.danjou.info
> 	__________________________________________________________________________
> 	OpenStack Development Mailing List (not for usage questions)
> 	Unsubscribe: OpenStack-dev-request at lists.openstack.org?subject:unsubscribe
> 	http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-dev

More information about the OpenStack-dev mailing list