summaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
authorramamani yeleswarapu <ramamani.yeleswarapu@intel.com>2018-08-31 10:57:45 -0700
committerramamani yeleswarapu <ramamani.yeleswarapu@intel.com>2018-08-31 13:40:06 -0700
commit2f0b896a56c6297ce3434c8d5279b3440e437f18 (patch)
tree9c086f9415cd32dda0a814a729e8f1099b7b4d04 /docs
parent574785c07010a494fbd1456d11e7c0449ad43c38 (diff)
Update KRD docs build
This adds docs/index.rst with links to: - krd_architecture.rst and - sampleCommands.rst. It is now possible to generate documentation using 'tox -e docs'. Change-Id: I176a01943d36659101b3251a8756866459d5491f Signed-off-by: ramamani yeleswarapu <ramamani.yeleswarapu@intel.com> Issue-ID: MULTICLOUD-301
Diffstat (limited to 'docs')
-rw-r--r--docs/index.rst22
1 files changed, 22 insertions, 0 deletions
diff --git a/docs/index.rst b/docs/index.rst
new file mode 100644
index 00000000..127f0b0e
--- /dev/null
+++ b/docs/index.rst
@@ -0,0 +1,22 @@
+MultiCloud Kubernetes Plugin
+============================
+
+This plugin is a part of the MultiCloud component in ONAP.
+It will allow ONAP to deploy/manage VM and container based VNFs
+over cloud regions that support Kubernetes as the orchestrator.
+
+Kubernetes Reference Deployment
+===============================
+
+The Kubernetes Reference Deployment(KRD) provides an
+automated mechanism to install and configure the Kubernetes
+services required for the MultiCloud Kubernetes plugin.
+
+Table of contents
+-----------------
+
+.. toctree::
+ :maxdepth: 3
+
+ Project Architecture <krd_architecture>
+ Sample Commands <sampleCommands>