[openstack-dev] [kolla] Structuring the documentation on all repositories

Christian Berendt berendt at betacloud-solutions.de
Mon Feb 20 16:34:05 UTC 2017

This is a summary about structuring the documentation on all repositories as discussed at the PTG (https://etherpad.openstack.org/p/kolla-pike-ptg-docs).

The doc directory:

kolla/doc — kolla developer documentation (about our docker images) and generic documentation
kolla-ansible/doc — kolla-ansible developer documentation
kolla-k8s/doc — kolla-k8s developer documentation

Contents will be published to https://docs.openstack.org/developer/kolla…/

The doc directory in the kolla repositories will be splitted into 2 parts and will keep the generic kolla documentation (landing page, mission, philosophy, explanation of deliverables, overview of deployment guides (previous QSG), bug triage, how to contribute, ...) and the development documentation related to kolla images.

The central entry point (landing page) for the kolla project will be https://docs.openstack.org/developer/kolla.

The deploy-guide directory:

kolla-ansible/deploy-guide — Kolla deployment guide for Ansible, how to deploy with kolla-ansible (previous name: quick start guide)
kolla-k8s/deploy-guide — Kolla deployment guide for K8S, how to deploy with kolla-k8s (previous name: quick start guide)

We will add 2 links to https://docs.openstack.org/project-deploy-guide/ocata/:

* Kolla deployment guide for Ansible
* Kolla deployment guide for K8S

Sample split for kolla-ansible prepared at https://review.openstack.org/#/c/427965/.

The guides itself will be published at https://docs.openstack.org/project-deploy-guide/ocata/kolla-ansible and https://docs.openstack.org/project-deploy-guide/ocata/kolla-k8s.


Christian Berendt
Chief Executive Officer (CEO)

Mail: berendt at betacloud-solutions.de
Web: https://www.betacloud-solutions.de

Betacloud Solutions GmbH
Teckstrasse 62 / 70190 Stuttgart / Deutschland

Geschäftsführer: Christian Berendt
Unternehmenssitz: Stuttgart
Amtsgericht: Stuttgart, HRB 756139

More information about the OpenStack-dev mailing list