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

Ildikó Váncsa ildiko.vancsa at ericsson.com
Tue Jun 28 18:23:34 UTC 2016


Hi Andreas,

If we would end up moving more guides to the project tree then it will be confusing having multiple top level docs folder in a basically code repository.

Can that be an option to have a top level 'doc' folder and having sub-folders under like 'doc/developer', 'doc/install-guide', etc.?

Thanks and Best Regards,
/Ildikó

> -----Original Message-----
> From: Andreas Jaeger [mailto:aj at suse.com]
> Sent: June 28, 2016 15:12
> To: Ildikó Váncsa; openstack-docs at lists.openstack.org
> Cc: openstack-dev at lists.openstack.org
> Subject: Re: [OpenStack-docs] [telemetry] Ceilometer and Aodh install guide(s)
> 
> On 2016-06-28 14:55, 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?
> 
> I understand the sentiment. The install-guide is a separate book, as
> Sean Dague called it nicely, which gets published to a different place,
> integrated into the full Install Tutorial. If you make it part of the
> developer documentation, it might integrate more nicely there but not in
> the overall cross-project Install Tutorial. Developer documentation is a
> separate book already and placing several books under doc will need even
> further changes to make it clear what goes where and how to publish.
> 
> So, I think the top-level folder is the best place for this,
> 
> Andreas
> --
>  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-dev mailing list