openstack/kolla-ansible
Code Issues Proposed changes

Build a more organized doc structure

Browse Source 
Use directories to further organize the path a user would
take through the docs.

Change-Id: I8e3885c7ac3a72eaadbf547efedf0de477aa0a9f
Partially-implements: blueprint documentation-rework
This commit is contained in:
Ryan Hallisey 2016-07-27 12:09:07 -04:00
parent b7d1d98668
commit aa517c4bf9
4 changed files with 46 additions and 24 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

40
doc/deployment-philosophy/deployment-philosophy.rst Normal file
View File

@ -0,0 +1,40 @@
.. _deployment-philosophy:
=============================
Kolla's Deployment Philosophy
=============================
Overview
========
Kolla has an objective to replace the inflexible, painful, resource-intensive
deployment process of OpenStack with a flexible, painless, inexpensive
deployment process. Often to deploy OpenStack at the 100+ node scale small
businesses may require means building a team of OpenStack professionals to
maintain and manage the OpenStack deployment. Finding people experienced in
OpenStack deployment is very difficult and expensive, resulting in a big
barrier for OpenStack adoption. Kolla seeks to remedy this set of problems by
simplifying the deployment process but enabling flexible deployment models.
Kolla is a highly opinionated deployment tool out of the box. This permits
Kolla to be deployable with the simple configuration of three key/value pairs.
As an operator's experience with OpenStack grows and the desire to customize
OpenStack services increases, Kolla offers full capability to override every
OpenStack service configuration option in the deployment.
Templating and Customization Philosophy
=======================================
To read up on the Kolla communities template philosphy go to the
:doc:`templating` doc.
Architecture
============
#TODO: Link an image showing the architecture
.. toctree::
:hidden:
templating

0
doc/deployment-philosophy/templating-and-customization.rst Normal file
View File

26
doc/deployment-philosophy.rst → doc/deployment-philosophy/templating.rst
View File

@ -1,26 +1,8 @@
.. _deployment-philosophy:
.. _templating:
=============================
Kolla's Deployment Philosophy
=============================
Overview
========
Kolla has an objective to replace the inflexible, painful, resource-intensive
deployment process of OpenStack with a flexible, painless, inexpensive
deployment process. Often to deploy OpenStack at the 100+ node scale small
businesses may require means building a team of OpenStack professionals to
maintain and manage the OpenStack deployment. Finding people experienced in
OpenStack deployment is very difficult and expensive, resulting in a big
barrier for OpenStack adoption. Kolla seeks to remedy this set of problems by
simplifying the deployment process while enabling flexible deployment models.
Kolla is a highly opinionated deployment tool out of the box. This permits
Kolla to be deployable with the simple configuration of three key/value pairs.
As an operator's experience with OpenStack grows and the desire to customize
OpenStack services increases, Kolla offers full capability to override every
OpenStack service configuration option in the deployment.
================
Kolla Templating
================
Why not Template Customization?
===============================

4
doc/index.rst
View File

@ -34,9 +34,9 @@ Kolla Overview
==============
.. toctree::
:maxdepth: 1
:maxdepth: 2
deployment-philosophy
deployment-philosophy/deployment-philosophy
quickstart
multinode
image-building