From e22faa69fd0d8fab3cce39d9a2b47752292cc565 Mon Sep 17 00:00:00 2001
From: Lingxian Kong <anlin.kong@gmail.com>
Date: Tue, 1 May 2018 14:09:18 +1200
Subject: [PATCH] Outline for Qinling doc

Change-Id: I37daf816e30babfecffed3d91f8782929124e3ae
Story: 2001577
Task: 6526
---
 doc/source/admin/index.rst        |  1 +
 doc/source/admin/installation.rst | 29 +++++++++++++++++++++++++++++
 doc/source/features.rst           |  2 +-
 doc/source/glossary.rst           | 21 +++++++++++++++++++++
 doc/source/index.rst              |  9 +++++++++
 doc/source/user/index.rst         | 28 ++++++++++++++++++++++++++++
 6 files changed, 89 insertions(+), 1 deletion(-)
 create mode 100644 doc/source/admin/installation.rst
 create mode 100644 doc/source/glossary.rst
 create mode 100644 doc/source/user/index.rst

diff --git a/doc/source/admin/index.rst b/doc/source/admin/index.rst
index 69f71f70..daaaaa28 100644
--- a/doc/source/admin/index.rst
+++ b/doc/source/admin/index.rst
@@ -21,6 +21,7 @@ Administration/Operation Guide
 .. toctree::
     :maxdepth: 1
 
+    installation
     runtime
     security
 
diff --git a/doc/source/admin/installation.rst b/doc/source/admin/installation.rst
new file mode 100644
index 00000000..baa55d02
--- /dev/null
+++ b/doc/source/admin/installation.rst
@@ -0,0 +1,29 @@
+..
+      Copyright 2018 Catalyst IT Ltd
+      All Rights Reserved.
+      not use this file except in compliance with the License. You may obtain
+      a copy of the License at
+
+          http://www.apache.org/licenses/LICENSE-2.0
+
+      Unless required by applicable law or agreed to in writing, software
+      distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+      WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
+      License for the specific language governing permissions and limitations
+      under the License.
+
+Installation Guide
+==================
+
+Install Qinling in DevStack
+~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+Refer to
+`Developer Guide <https://docs.openstack.org/qinling/latest/contributor/development-environment-devstack.html>`_
+
+Config Qinling using existing Kubernetes cluster
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+In most cases, it's not ideal to set up a new dedicated kubernetes cluster for
+Qinling. Follow the steps below to config Qinling work with the existing
+kubernetes cluster
\ No newline at end of file
diff --git a/doc/source/features.rst b/doc/source/features.rst
index 8cb8fcdb..730c1aa6 100644
--- a/doc/source/features.rst
+++ b/doc/source/features.rst
@@ -12,7 +12,7 @@
       License for the specific language governing permissions and limitations
       under the License.
 
-Qinling features
+Qinling Features
 ================
 
 This section does not intend to give you an exhaustive feature list of Qinling,
diff --git a/doc/source/glossary.rst b/doc/source/glossary.rst
new file mode 100644
index 00000000..55a15a3b
--- /dev/null
+++ b/doc/source/glossary.rst
@@ -0,0 +1,21 @@
+..
+      Copyright 2018 Catalyst IT Ltd
+      All Rights Reserved.
+      not use this file except in compliance with the License. You may obtain
+      a copy of the License at
+
+          http://www.apache.org/licenses/LICENSE-2.0
+
+      Unless required by applicable law or agreed to in writing, software
+      distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+      WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
+      License for the specific language governing permissions and limitations
+      under the License.
+
+Qinling Glossary
+================
+
+As the Qinling project evolves, it’s important that people working on Qinling,
+users using Qinling, and operators deploying Qinling use a common set of
+terminology in order to avoid misunderstandings and confusion. To that end, we
+are providing the following glossary of terms.
\ No newline at end of file
diff --git a/doc/source/index.rst b/doc/source/index.rst
index 926322d7..39d1953b 100644
--- a/doc/source/index.rst
+++ b/doc/source/index.rst
@@ -42,6 +42,7 @@ Overview
    :maxdepth: 1
 
    quick_start
+   glossary
    features
 
 Administration/Operation Guide
@@ -61,6 +62,14 @@ Contributor/Developer Guide
    contributor/index
    specs/index
 
+User Guide
+----------
+
+.. toctree::
+   :maxdepth: 1
+
+   user/index
+
 Function Programming Guide
 --------------------------
 
diff --git a/doc/source/user/index.rst b/doc/source/user/index.rst
new file mode 100644
index 00000000..51a6934b
--- /dev/null
+++ b/doc/source/user/index.rst
@@ -0,0 +1,28 @@
+..
+      Copyright 2010-2011 United States Government as represented by the
+      Administrator of the National Aeronautics and Space Administration.
+      All Rights Reserved.
+
+      Licensed under the Apache License, Version 2.0 (the "License"); you may
+      not use this file except in compliance with the License. You may obtain
+      a copy of the License at
+
+          http://www.apache.org/licenses/LICENSE-2.0
+
+      Unless required by applicable law or agreed to in writing, software
+      distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+      WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
+      License for the specific language governing permissions and limitations
+      under the License.
+
+User Guide
+==========
+
+.. toctree::
+    :maxdepth: 1
+
+Indices and tables
+------------------
+
+* :ref:`genindex`
+* :ref:`search`