From 426e63772496769ba37538bfc2d3cd472a7a1ab8 Mon Sep 17 00:00:00 2001
From: Steven Dake <stdake@cisco.com>
Date: Mon, 2 Nov 2015 07:07:47 -0700
Subject: [PATCH] Implement Mitaka ODS Documentation structure
From this etherpad:
https://etherpad.openstack.org/p/kolla-mitaka-documentation
Lay groundwork for structure of new documentation layout.
Further work will finish the job on this doc work.
Note in a later change I793244c47ffbe0ba304e79bacf708494e59d99c4
ansible-deployment, deploy-all-in-one-node, and quickstart.rst
will be merged into one document.
Change-Id: I42b576ffab796da6e27adc9dbf55b2ceed641c16
---
doc/advanced-configuration.rst | 10 +++++++++
...ployment.rst => deployment-philosophy.rst} | 0
doc/{devenv-heat.rst => heat-dev-env.rst} | 0
doc/index.rst | 16 +++++++-------
doc/operating-kolla.rst | 22 +++++++++++++++++++
doc/{dev-quickstart.rst => quickstart.rst} | 0
...devenv-vagrant.rst => vagrant-dev-env.rst} | 0
7 files changed, 40 insertions(+), 8 deletions(-)
create mode 100644 doc/advanced-configuration.rst
rename doc/{customize-deployment.rst => deployment-philosophy.rst} (100%)
rename doc/{devenv-heat.rst => heat-dev-env.rst} (100%)
create mode 100644 doc/operating-kolla.rst
rename doc/{dev-quickstart.rst => quickstart.rst} (100%)
rename doc/{devenv-vagrant.rst => vagrant-dev-env.rst} (100%)
diff --git a/doc/advanced-configuration.rst b/doc/advanced-configuration.rst
new file mode 100644
index 0000000000..fda524ce85
--- /dev/null
+++ b/doc/advanced-configuration.rst
@@ -0,0 +1,10 @@
+Advanced Configuration
+======================
+
+Deployment Configuration
+------------------------
+TODO(all) fill this section out
+
+OpenStack Service Configuration in Kolla
+----------------------------------------
+TODO(all) fill this section out
diff --git a/doc/customize-deployment.rst b/doc/deployment-philosophy.rst
similarity index 100%
rename from doc/customize-deployment.rst
rename to doc/deployment-philosophy.rst
diff --git a/doc/devenv-heat.rst b/doc/heat-dev-env.rst
similarity index 100%
rename from doc/devenv-heat.rst
rename to doc/heat-dev-env.rst
diff --git a/doc/index.rst b/doc/index.rst
index 1a14ba4c19..41eef16ebf 100644
--- a/doc/index.rst
+++ b/doc/index.rst
@@ -23,19 +23,19 @@ customization. This permits operators with little experience to deploy
OpenStack quickly and as experience grows modify the OpenStack configuration to
suit the operator's exact requirements.
-Deployment Information
-======================
-
.. toctree::
:maxdepth: 1
- dev-quickstart
+ deployment-philosophy
+ quckstart
ansible-deployment
- devenv-vagrant
- devenv-heat
- image-building
deploy-all-in-one-node
- customize-deployment
+ heat-dev-env
+ vagrant-dev-env
+ image-building
+ advanced-configuration
+ operating-kolla
+
Services in Kolla
=================
diff --git a/doc/operating-kolla.rst b/doc/operating-kolla.rst
new file mode 100644
index 0000000000..fda01e7683
--- /dev/null
+++ b/doc/operating-kolla.rst
@@ -0,0 +1,22 @@
+Operating Kolla
+===============
+
+Upgrading
+---------
+TODO(all) fill this section out
+
+Diagnostics
+-----------
+TODO(all) fill this section out
+
+Failure Recovery
+----------------
+TODO(all) fill this section out
+
+Reconfiguration of an existing environment
+------------------------------------------
+TODO(all) fill this section out
+
+Tips and Tricks
+---------------
+TODO(all) fill this section out
diff --git a/doc/dev-quickstart.rst b/doc/quickstart.rst
similarity index 100%
rename from doc/dev-quickstart.rst
rename to doc/quickstart.rst
diff --git a/doc/devenv-vagrant.rst b/doc/vagrant-dev-env.rst
similarity index 100%
rename from doc/devenv-vagrant.rst
rename to doc/vagrant-dev-env.rst
--
GitLab