summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorSofia Wallin <sofia.wallin@ericsson.com>2015-12-03 12:47:50 +0100
committerSofia Wallin <sofia.wallin@ericsson.com>2015-12-09 15:24:13 +0100
commitf99ae304e7414bbfcf2cb1dcccff3526dd6d0544 (patch)
tree79eaa70c062668f83f37445c34a4d3f11afbf83e
parent47881da551e1995ef13d805be94f1e9df9a3577f (diff)
Adding structure to the Config guide
Removed content text from the index file. Created content files, added sub sections for installers and features. Change-Id: I630ac62546b6cd8facc793e595f647b5a5d8c45f Signed-off-by: Sofia Wallin <sofia.wallin@ericsson.com>
-rw-r--r--docs/configguide/abstract.rst5
-rw-r--r--docs/configguide/configguide.rst6
-rw-r--r--docs/configguide/configoptions.rst5
-rw-r--r--docs/configguide/index.rst19
-rw-r--r--docs/configguide/introduction.rst14
5 files changed, 40 insertions, 9 deletions
diff --git a/docs/configguide/abstract.rst b/docs/configguide/abstract.rst
new file mode 100644
index 000000000..20403308d
--- /dev/null
+++ b/docs/configguide/abstract.rst
@@ -0,0 +1,5 @@
+
+Abstract
+--------
+
+We write something about the doc for the title page.
diff --git a/docs/configguide/configguide.rst b/docs/configguide/configguide.rst
deleted file mode 100644
index d1df7ca04..000000000
--- a/docs/configguide/configguide.rst
+++ /dev/null
@@ -1,6 +0,0 @@
-Introduction
----------------
-
-The OPNFV Config Guide needs work...
-
-
diff --git a/docs/configguide/configoptions.rst b/docs/configguide/configoptions.rst
new file mode 100644
index 000000000..2e56fa08d
--- /dev/null
+++ b/docs/configguide/configoptions.rst
@@ -0,0 +1,5 @@
+Configuration Options
+=====================
+
+Add an overview section and reference table for installers and features.
+
diff --git a/docs/configguide/index.rst b/docs/configguide/index.rst
index b46d0fa6e..70f16e2d2 100644
--- a/docs/configguide/index.rst
+++ b/docs/configguide/index.rst
@@ -3,20 +3,33 @@
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
-Welcome to OPNFV Configuration Guide
+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.
+ abstract.rst
Contents:
.. toctree::
:maxdepth: 2
- configguide.rst
+
+ introduction.rst
+ configoptions.rst
+
+Installation Description
+========================
+
+
+Feature Description
+===================
../../sdnvpn/docs/configguide/configguide.rst
+Post Configuration Activities
+=============================
+
+
Indices and tables
==================
diff --git a/docs/configguide/introduction.rst b/docs/configguide/introduction.rst
new file mode 100644
index 000000000..093a93609
--- /dev/null
+++ b/docs/configguide/introduction.rst
@@ -0,0 +1,14 @@
+
+Scope
+=====
+
+Using this guide
+----------------
+
+
+Pre-requisites
+--------------
+
+The OPNFV Config Guide needs work...
+
+