diff options
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/configguide/abstract.rst | 5 | ||||
| -rw-r--r-- | docs/configguide/configoptions.rst | 5 | ||||
| -rw-r--r-- | docs/configguide/index.rst | 38 | ||||
| -rw-r--r-- | docs/configguide/introduction.rst | 14 | ||||
| -rw-r--r-- | docs/platformoverview/index.rst | 25 | ||||
| -rw-r--r-- | docs/platformoverview/platformoverview.rst | 4 | ||||
| -rw-r--r-- | docs/userguide/index.rst | 25 | ||||
| -rw-r--r-- | docs/userguide/userguide.rst | 4 |
8 files changed, 120 insertions, 0 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/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 new file mode 100644 index 000000000..70f16e2d2 --- /dev/null +++ b/docs/configguide/index.rst @@ -0,0 +1,38 @@ +.. 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. + +OPNFV Configuration Guide +================================================ + + abstract.rst + +Contents: + +.. toctree:: + :maxdepth: 2 + + + introduction.rst + configoptions.rst + +Installation Description +======================== + + +Feature Description +=================== + ../../sdnvpn/docs/configguide/configguide.rst + + +Post Configuration Activities +============================= + + +Indices and tables +================== + +* :ref:`genindex` +* :ref:`modindex` +* :ref:`search` 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... + + 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... |