summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorChristopherPrice <christopher.price@ericsson.com>2015-11-24 10:46:51 +0100
committerChristopherPrice <christopher.price@ericsson.com>2015-11-24 10:46:51 +0100
commit47881da551e1995ef13d805be94f1e9df9a3577f (patch)
tree78e9712e4e72fe77b12113cc2f56821bd6f775cb
parent18140941aa30ef189615367185c63cc761d74bbb (diff)
JIRA: DOCS64
Adding three test files to establish the cross repository workflow and build out the templates for the Brahmaputra release documents. Change-Id: I9afdaccfae5e583fdca43789ee65940f83514d34 Signed-off-by: ChristopherPrice <christopher.price@ericsson.com>
-rw-r--r--docs/configguide/configguide.rst6
-rw-r--r--docs/configguide/index.rst25
-rw-r--r--docs/platformoverview/index.rst25
-rw-r--r--docs/platformoverview/platformoverview.rst4
-rw-r--r--docs/userguide/index.rst25
-rw-r--r--docs/userguide/userguide.rst4
6 files changed, 89 insertions, 0 deletions
diff --git a/docs/configguide/configguide.rst b/docs/configguide/configguide.rst
new file mode 100644
index 000000000..d1df7ca04
--- /dev/null
+++ b/docs/configguide/configguide.rst
@@ -0,0 +1,6 @@
+Introduction
+---------------
+
+The OPNFV Config Guide needs work...
+
+
diff --git a/docs/configguide/index.rst b/docs/configguide/index.rst
new file mode 100644
index 000000000..b46d0fa6e
--- /dev/null
+++ b/docs/configguide/index.rst
@@ -0,0 +1,25 @@
+.. OPNFV Configuration Guide documentation master file, created by
+ sphinx-quickstart on Tue Nov 24 10:30:29 2015.
+ You can adapt this file completely to your liking, but it should at least
+ contain the root `toctree` directive.
+
+Welcome to OPNFV Configuration Guide
+================================================
+
+This guide seeks to inform operators how to configure the OPNFV Platform and its components to enable platform features provided in the Brahmaputra release.
+
+Contents:
+
+.. toctree::
+ :maxdepth: 2
+
+ configguide.rst
+ ../../sdnvpn/docs/configguide/configguide.rst
+
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`
diff --git a/docs/platformoverview/index.rst b/docs/platformoverview/index.rst
new file mode 100644
index 000000000..3a62c69f3
--- /dev/null
+++ b/docs/platformoverview/index.rst
@@ -0,0 +1,25 @@
+.. OPNFV Platform Overview documentation master file, created by
+ sphinx-quickstart on Tue Nov 24 10:30:29 2015.
+ You can adapt this file completely to your liking, but it should at least
+ contain the root `toctree` directive.
+
+Welcome to OPNFV Platform Overview document
+================================================
+
+This document seeks to inform operators how to configure the OPNFV Platform and its components to enable platform features provided in the Brahmaputra release.
+
+Contents:
+
+.. toctree::
+ :maxdepth: 2
+
+ configguide.rst
+ ../../sdnvpn/docs/platformoverview/platformoverview.rst
+
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`
diff --git a/docs/platformoverview/platformoverview.rst b/docs/platformoverview/platformoverview.rst
new file mode 100644
index 000000000..260658050
--- /dev/null
+++ b/docs/platformoverview/platformoverview.rst
@@ -0,0 +1,4 @@
+Introduction
+---------------
+
+The OPNFV Platform Overview needs work...
diff --git a/docs/userguide/index.rst b/docs/userguide/index.rst
new file mode 100644
index 000000000..581a74b33
--- /dev/null
+++ b/docs/userguide/index.rst
@@ -0,0 +1,25 @@
+.. OPNFV User Guide documentation master file, created by
+ sphinx-quickstart on Tue Nov 24 10:30:29 2015.
+ You can adapt this file completely to your liking, but it should at least
+ contain the root `toctree` directive.
+
+Welcome to OPNFV User Guide
+================================================
+
+This guide seeks to inform operators how to use the OPNFV Platform and its components to enable platform features provided in the Brahmaputra release.
+
+Contents:
+
+.. toctree::
+ :maxdepth: 2
+
+ userguide.rst
+ ../../sdnvpn/docs/userguide/userguide.rst
+
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`
diff --git a/docs/userguide/userguide.rst b/docs/userguide/userguide.rst
new file mode 100644
index 000000000..efcaa8ce1
--- /dev/null
+++ b/docs/userguide/userguide.rst
@@ -0,0 +1,4 @@
+Introduction
+---------------
+
+The OPNFV User Guide needs work...