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

Steven Dake (stdake) stdake at cisco.com
Mon Nov 21 12:00:51 UTC 2016

Yup this is a real challenge to sort out properly.  I’ve included infra for their guidance (thanks people :).

Here is the issue

Each package should include enough docs that it stands alone after a git checkout (IMO).  We also publish docs to docs.oo which should IMO contain one set of docs for the entire kolla project in the /kolla namespace.

I guess the above if what I’d want in a star trek universe.  This provides best of both worlds - kolla-ansible, kolla-kubernetes, kolla documentation all with their respective repositories, but merged on the docs.oo site into one document.  How do you do that?  No idea.

So if that isn’t a possibility, putting all in kolla repo seems to make most sense to me although it slows down reviews for kolla-ansible and kolla-kkubernetes docs.  We could put a reference page in the docs of kolla-ansible and kolla-kubernetes to “go reference kolla”.


On 11/21/16, 3:13 AM, "Jeffrey Zhang" <zhang.lei.fly at gmail.com> wrote:

>Then what's the case of kolla-kubernetes?
>On Mon, Nov 21, 2016 at 5:54 PM, Paul Bourke <paul.bourke at oracle.com> wrote:
>> Propose all docs stay under the kolla namespace
>> (http://docs.openstack.org/developer/kolla).
>> Steve mentioned that we should try to keep all components (e.g. mailing list
>> tags) under the same umbrella which I agree with.
>> On 21/11/16 08:05, Jeffrey Zhang wrote:
>>> After the split, we have two projects and two develop docs[0][1].
>>> These two sites have lots of duplicated lines.
>>> So will we split the doc site?
>>> if so, we need to remove the duplicated doc in the repos.
>>> if not, we need to remove one site's doc.
>>> [0] http://docs.openstack.org/developer/kolla
>>> [1] http://docs.openstack.org/developer/kolla-ansible/
>> __________________________________________________________________________
>> 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
>Jeffrey Zhang
>Blog: http://xcodest.me
>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