[openstack-dev] [kolla][infra] How to handle doc in kolla and kolla-ansible

Steven Dake (stdake) stdake at cisco.com
Mon Nov 21 19:25:25 UTC 2016


Just thinking about all the documentation rework that would be necessary…  Perhaps it just confuses me ;)  I think the short term result would be mass confusion as we sort out the next iteration of the documentation in this structure since the docs are well tested at present and I’m a bit terrified to change them ;)

It may be possible to solve this via a massive reorg that is well reviewed and -2’ed until everything can merge in one go.


On 11/21/16, 5:43 AM, "Andreas Jaeger" <aj at suse.com> wrote:

>On 2016-11-21 13:24, Steven Dake (stdake) wrote:
>> Pete,
>> The main problem with that is publishing docs to docs.oo which would
>> then confuse the reader even more then they are already confused by
>> reading our docs ;)
>> Regards
>> -steve
>> From: Pete Birley <pete at port.direct <mailto:pete at port.direct>>
>> Reply-To: "OpenStack Development Mailing List (not for usage questions)"
>> <openstack-dev at lists.openstack.org
>> <mailto:openstack-dev at lists.openstack.org>>
>> Date: Monday, November 21, 2016 at 5:11 AM
>> To: "OpenStack Development Mailing List (not for usage questions)"
>> <openstack-dev at lists.openstack.org
>> <mailto:openstack-dev at lists.openstack.org>>
>> Subject: Re: [openstack-dev] [kolla] How to handle doc in kolla and
>> kolla-ansible
>> I think Jeffrey's raised a good point here. Though I agree we should
>> keep the development side under a single umbrella/namespace, to better
>> co-ordinate our efforts, I think it makes more sense to move the
>> end-user documentation and to the repo that it's associated with. I feel
>> this is the right approach as it makes it much less likely for users to
>> confuse/mix documents. With this in mind would it not make sense to spit
>> out the docs as follows?
>>   * Kolla: images (building/specs), contributing, development
>>   * Kolla-ansible: deployment via ansible, ansible specific specs
>>   * Kolla-kubernetes: deployment via k8s, k8s specific specs
>Why confusing Steve? The above sounds like a logical differentiation.
>You could have on the front-side of kolla an section "Deployment
>options" that links to kolla-ansible and kolla-kubernetes.
>And in kolla-ansible/kolla-kubernetes, you have a start file that links
>back for generic support.
>You can also start with one way and then change later on ;)
> 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
>OpenStack Development Mailing List (not for usage questions)
>Unsubscribe: OpenStack-dev-request at lists.openstack.org?subject:unsubscribe

More information about the OpenStack-dev mailing list