On 02/20/2017 05:34 PM, Christian Berendt  wrote:
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.

Note that we publish to /ocata/ from stable/ocata branch - so remember to backport any such changes...

The master branch publishes to https://docs.openstack.org/project-deploy-guide/draft/kolla-ansible etc

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


__________________________________________________________________________
OpenStack Development Mailing List (not for usage questions)
Unsubscribe: [email protected]?subject:unsubscribe
http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-dev

Reply via email to