Updating Installation and fixing the toc.tree

Minor editorial changes in User guide

Signed-off-by: Edit Koselak <edit.koselak@nokia.com>
Change-Id: Ib0afb05062cc8e5e3c5ad5a61fc51aef258613f0

diff --git a/docs/index.rst b/docs/index.rst
index 30adf1c..391be47 100644 (file)
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -31,13 +31,13 @@ projects.
 Participation is open to anyone, whether you are an employee of a member company or just passionate about network
 transformation.
 
-Documentation for Anuket Users
+Documentation for Anuket users
 ------------------------------
 
 These documents are targeted to the users of the different Anuket sub-projects and here they are organized by
 sub-project categories.
 
-Anuket Specifications
+Anuket specifications
 ~~~~~~~~~~~~~~~~~~~~~
 
 :doc:`Anuket Specifications <cntt:index>` provide reference specifications for cloud infrastructures and their
@@ -57,6 +57,13 @@ workloads. The specifications are organized to the following documents:
 * Reference Implementation based on RA2 specifications (RI2) - a blueprint to build a Kubernetes container orchestration
   platform based on the RA2 specificcations.
 
+.. toctree::
+   :maxdepth: 1
+   :hidden:
+
+   release/installation.introduction
+   release/userguide.introduction
+   release/release-notes
 
 Implementation projects
 ~~~~~~~~~~~~~~~~~~~~~~~
@@ -65,27 +72,20 @@ Implementation projects address specific needs in the cloud technology relevant
 reuseable implementation. The implementation projects have their release notes, installation and user guides in the
 aggregated documentation set referred here:
 
-.. toctree::
-   :maxdepth: 1
-
-   release/installation.introduction
-   release/userguide.introduction
-   release/release-notes
-
+- :doc:`Installation Introduction<release/installation.introduction>`
+- :doc:`User Guide and Configuration Guide<release/userguide.introduction>`
+- :doc:`Release Notes<release/release-notes>`
 
-Testing Projects and Frameworks
+Testing projects and frameworks
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 Testing projects, like ViNePERF provide testing tools to assess certain characteristics of cloud infrastructures while
 the Functest testing framework provides an automatic test suite to test the cloud infrastructures. The testing projects
 and frameworks have their release notes, installation and user guides in the aggregated documentation set referred here:
 
-.. toctree::
-   :maxdepth: 1
-
-   release/installation.introduction
-   release/userguide.introduction
-   release/release-notes
+- :doc:`Installation Introduction<release/installation.introduction>`
+- :doc:`User Guide and Configuration Guide<release/userguide.introduction>`
+- :doc:`Release Notes<release/release-notes>`
 
 Integration projects
 ~~~~~~~~~~~~~~~~~~~~
@@ -94,12 +94,9 @@ The integration projects integrate OpenStack and Kubernetes based cloud infrastr
 and RI2. The integration projects have their release notes, installation and user guides in the aggregated documentation
 set referred here:
 
-.. toctree::
-   :maxdepth: 1
-
-   release/installation.introduction
-   release/userguide.introduction
-   release/release-notes
+- :doc:`Installation Introduction<release/installation.introduction>`
+- :doc:`User Guide and Configuration Guide<release/userguide.introduction>`
+- :doc:`Release Notes<release/release-notes>`
 
 Documentation for Anuket contributors
 -------------------------------------

diff --git a/docs/release/installation.introduction.rst b/docs/release/installation.introduction.rst
index 46bb40e..22ccd55 100644 (file)
--- a/docs/release/installation.introduction.rst
+++ b/docs/release/installation.introduction.rst
@@ -4,40 +4,35 @@
 .. SPDX-License-Identifier: CC-BY-4.0
 .. (c) Anuket CCC, AT&T, and other contributors
 
-============
-Installation
-============
+=========================
+Installation Introduction
+=========================
 
-Abstract
-========
+This is the collection of installation documents for Anuket. Use this document for further reference.
 
-This is the collection of installation documents for Anuket, please use this document for further reference.
+Anuket specifications
+=====================
 
-Installation procedures
-=======================
+It is recommended to use the online version of the :doc:`Anuket Specifications <cntt:index>`.
 
-Each of the sub-projects and test frameworks have their separate installations procedures in their individual
-documentation.
+Implementation projects
+=======================
 
 - :ref:`Barometer Installation Guide <barometer-docker-userguide>`
-- :ref:`CIRV-SDV Installation Guide <cirv-sdv-installation>`
-- :ref:`Kuberef Installation Guide <kuberef-installation>`
+
+Testing projects and frameworks
+===============================
+
 - :ref:`ViNePERF installation Guide <vineperf-installation>`
 - :doc:`Functest Installation Guide <functest:testing/user/configguide/index>`
 
-Anuket Test Frameworks
-======================
-
-Testing can be started after the installation of the test frameworks. The basic deployment validation only addresses
-some of the generic capabilities of cloud infrastructures. To run more exhaustive tests some investigation will be
+Testing can be started after the installation of the test frameworks. The basic deployment validation only addresses 
+some of the generic capabilities of cloud infrastructures. To run more exhaustive tests, some investigation is 
 required to select the right test suites to run.
 
-Many of the Anuket test projects provide user-guide documentation and installation instructions in
-:ref:`this document <testing-userguide>`
+For more instructions on using the Anuket testing projects after installation, see :ref:`this document <testing-userguide>`.
 
-Anuket Specifications
-=====================
+Integration projects
+====================
 
-There is no need to "install" the Anuket Reference Specifications! You can view them here:
-
-* :doc:`Anuket Specifications <cntt:index>`
+- :ref:`Kuberef Installation Guide <kuberef-installation>`

diff --git a/docs/release/userguide.introduction.rst b/docs/release/userguide.introduction.rst
index 7e74a1e..827d2c7 100644 (file)
--- a/docs/release/userguide.introduction.rst
+++ b/docs/release/userguide.introduction.rst
@@ -5,7 +5,7 @@
 .. (c) Anuket CCC, AT&T, and other contributors
 
 ================================
-User Guide & Configuration Guide
+User Guide and Configuration Guide
 ================================
 
 Abstract
@@ -27,7 +27,7 @@ Anuket provides infrastructure deployment options, which are able to be installe
 (VNFs) and cloud native network functions (CNFs). This document intends to help users leverage the features and
 capabilities delivered by Anuket.
 
-Feature Overview
+Feature overview
 ================
 
 The following links outline the feature deliverables from Anuket sub-projects. Each of the sub-projects provide detailed
@@ -40,7 +40,7 @@ are part of the Anuket release.
 
 The `Anuket developer wiki  <http://wiki.anuket.io>`_ might contain more details about the specific projects.
 
-Configuration Guides
+Configuration guides
 ====================
 
 * :ref:`Barometer Configuration Guide <barometer-configguide>`
@@ -49,7 +49,7 @@ Configuration Guides
 * :doc:`ViNePERF Configuration Guide <vineperf:testing/user/configguide/index>`
 * :doc:`Functest Configuration Guide <functest:testing/user/configguide/index>`
 
-User Guides
+User guides
 ===========
 
 * :ref:`Barometer User Guide <barometer-userguide>`