From aa517c4bf965f06dc9bcb20220d675ff6e77e94c Mon Sep 17 00:00:00 2001 From: Ryan Hallisey Date: Wed, 27 Jul 2016 12:09:07 -0400 Subject: [PATCH] Build a more organized doc structure Use directories to further organize the path a user would take through the docs. Change-Id: I8e3885c7ac3a72eaadbf547efedf0de477aa0a9f Partially-implements: blueprint documentation-rework --- .../deployment-philosophy.rst | 40 +++++++++++++++++++ .../templating-and-customization.rst | 0 .../templating.rst} | 26 ++---------- doc/index.rst | 4 +- 4 files changed, 46 insertions(+), 24 deletions(-) create mode 100644 doc/deployment-philosophy/deployment-philosophy.rst create mode 100644 doc/deployment-philosophy/templating-and-customization.rst rename doc/{deployment-philosophy.rst => deployment-philosophy/templating.rst} (71%) diff --git a/doc/deployment-philosophy/deployment-philosophy.rst b/doc/deployment-philosophy/deployment-philosophy.rst new file mode 100644 index 0000000000..00cbfea260 --- /dev/null +++ b/doc/deployment-philosophy/deployment-philosophy.rst @@ -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 diff --git a/doc/deployment-philosophy/templating-and-customization.rst b/doc/deployment-philosophy/templating-and-customization.rst new file mode 100644 index 0000000000..e69de29bb2 diff --git a/doc/deployment-philosophy.rst b/doc/deployment-philosophy/templating.rst similarity index 71% rename from doc/deployment-philosophy.rst rename to doc/deployment-philosophy/templating.rst index 6711d34f0c..c0511c7a28 100644 --- a/doc/deployment-philosophy.rst +++ b/doc/deployment-philosophy/templating.rst @@ -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? =============================== diff --git a/doc/index.rst b/doc/index.rst index a5d50bc6cb..4b331e0605 100644 --- a/doc/index.rst +++ b/doc/index.rst @@ -34,9 +34,9 @@ Kolla Overview ============== .. toctree:: - :maxdepth: 1 + :maxdepth: 2 - deployment-philosophy + deployment-philosophy/deployment-philosophy quickstart multinode image-building