diff options
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/configguide/feature-config.rst | 7 | ||||
| -rw-r--r-- | docs/configguide/index.rst | 23 | ||||
| -rw-r--r-- | docs/configguide/installer-config.rst | 8 | ||||
| -rw-r--r-- | docs/configguide/post-install.rst | 7 | ||||
| -rw-r--r-- | docs/userguide/feature-usage.rst | 7 | ||||
| -rw-r--r-- | docs/userguide/general-system.rst | 11 | ||||
| -rw-r--r-- | docs/userguide/index.rst | 33 |
7 files changed, 49 insertions, 47 deletions
diff --git a/docs/configguide/feature-config.rst b/docs/configguide/feature-config.rst new file mode 100644 index 000000000..df9728bb9 --- /dev/null +++ b/docs/configguide/feature-config.rst @@ -0,0 +1,7 @@ +Feature Configuration +===================== + +The following sections describe the configuration options for specific platform features provided in Brahmaputra. +Further details for each feature are captured in the referred project documentation. + +.. include:: ../projects/sdnvpn/configguide/configguide.rst diff --git a/docs/configguide/index.rst b/docs/configguide/index.rst index 39e3be34d..0a47f1589 100644 --- a/docs/configguide/index.rst +++ b/docs/configguide/index.rst @@ -9,26 +9,9 @@ Contents: ./abstract ./introduction ./configoptions - -Installer Configuration -======================= - -Waiting for the structue in the installer repo's to -add the include references. - -Feature Configuration -===================== - -.. toctree:: - :maxdepth: 2 - -.. include:: ../projects/sdnvpn/configguide/configguide.rst - -Post Configuration Activities -============================= - -Waiting for the structue in the remote repo's to -add the include references. + ./installer-config + ./feature-config + ./post-install Indices and tables ================== diff --git a/docs/configguide/installer-config.rst b/docs/configguide/installer-config.rst new file mode 100644 index 000000000..89632ea3f --- /dev/null +++ b/docs/configguide/installer-config.rst @@ -0,0 +1,8 @@ +Installer Configuration +======================= + +The following sections describe the per installer configuration options. +Further details for each installer are captured in the referred project documentation. + +.. include:: ../projects/fuel/configguide/installerconfig.rst +.. include:: ../projects/joid/configguide/installerconfig.rst diff --git a/docs/configguide/post-install.rst b/docs/configguide/post-install.rst new file mode 100644 index 000000000..b63d44aac --- /dev/null +++ b/docs/configguide/post-install.rst @@ -0,0 +1,7 @@ +Post Configuration Activities +============================= + +This section describes the post configuration activitites that will allow you to validate the success +of your configuration. Further details may be found in the referred project specific documentation. + +.. include:: ../projects/joid/configguide/postinstall.rst diff --git a/docs/userguide/feature-usage.rst b/docs/userguide/feature-usage.rst new file mode 100644 index 000000000..ea1e9e54e --- /dev/null +++ b/docs/userguide/feature-usage.rst @@ -0,0 +1,7 @@ +Using Brahmaputra Features +========================== + +This section of the user guide provides feature specific user guides and references. +This provides user information when leveraging the features in the platform where as a user you may +need to perform operations, many operation in this section refer to the guides in the general system usage +section. diff --git a/docs/userguide/general-system.rst b/docs/userguide/general-system.rst new file mode 100644 index 000000000..3865f3dd7 --- /dev/null +++ b/docs/userguide/general-system.rst @@ -0,0 +1,11 @@ +General system usage +==================== + +This section of the user guide provides general system component user guides and references. +This provides user information for common components of the platform where as a user you may +need to perform operations, depending on the scenario deployed and types of activities you are doing. + +.. include:: ./openstack.rst +.. include:: ./opendaylight.rst +.. include:: ./onos.rst +.. include:: ./ovs.rst diff --git a/docs/userguide/index.rst b/docs/userguide/index.rst index 6aea80894..023c1d317 100644 --- a/docs/userguide/index.rst +++ b/docs/userguide/index.rst @@ -1,36 +1,15 @@ -.. 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 -=========================== - -.. toctree:: - :maxdepth: 2 - - abstract.rst - introduction.rst - -General system usage -==================== +OPNFV User Guide +================ .. toctree:: :maxdepth: 2 - openstack.rst - opendaylight.rst - onos.rst - ovs.rst - -Using Brahmaputra Features -========================== - -.. include:: ./projects-userguide.rst + ./abstract + ./introduction + ./general-system + ./feature-usage Indices and tables ================== -* :ref:`genindex` -* :ref:`modindex` * :ref:`search` |