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

Andreas Jaeger aj at suse.com
Mon Nov 21 12:40:54 UTC 2016

On 2016-11-21 13:00, Steven Dake (stdake) wrote:
> 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.

You can link from one to the other.

But having one document where you hit next, next, next will not work.
You will always have separate documents.

> 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”.

Common stuff in kolla, specific stuff in kolla-ansible, kolla-kubernetes?

 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