From 1ecfd3adaac2fb9dae1e1fa17061788291253014 Mon Sep 17 00:00:00 2001 From: ShubhamRathi Date: Fri, 31 Mar 2017 04:56:24 +0530 Subject: [PATCH] Final Misc Changs before D1 1. Update pharos link in installation 2. Update/ remove projects in config-user guide 3. Update/ remove projects from release notes 4. Update/ remove feature projects 5. Remove warning atop index page Change-Id: I9f685c39a711fdd12ab4c6ce573e03679a0c7a01 Signed-off-by: ShubhamRathi (cherry picked from commit d3e7fb65df69c64bcc41e13e905544a27ba6ddac) --- docs/featureprojects.rst | 44 ------------------------------ docs/index.rst | 3 +- docs/release/installation.introduction.rst | 13 ++------- docs/release/release-notes.rst | 4 --- docs/release/userguide.introduction.rst | 5 ---- 5 files changed, 4 insertions(+), 65 deletions(-) diff --git a/docs/featureprojects.rst b/docs/featureprojects.rst index 24b4e325b..6a4cd8193 100644 --- a/docs/featureprojects.rst +++ b/docs/featureprojects.rst @@ -59,20 +59,6 @@ Barometer ../submodules/barometer/docs/development/manuals/index -Bottlenecks ------------ -.. toctree:: - :maxdepth: 1 - - ../submodules/bottlenecks/docs/development/overview/index - ../submodules/bottlenecks/docs/development/requirements/index - ../submodules/bottlenecks/docs/release/installation/index - ../submodules/bottlenecks/docs/release/configguide/index - ../submodules/bottlenecks/docs/release/userguide/index - ../submodules/bottlenecks/docs/development/design/index - ../submodules/bottlenecks/docs/development/manuals/index - - Compass4Nfv ----------- .. toctree:: @@ -129,20 +115,6 @@ Domino ../submodules/domino/docs/development/manuals/index -Fds ---- -.. toctree:: - :maxdepth: 1 - - ../submodules/fds/docs/development/overview/index - ../submodules/fds/docs/development/requirements/index - ../submodules/fds/docs/release/installation/index - ../submodules/fds/docs/release/configguide/index - ../submodules/fds/docs/release/userguide/index - ../submodules/fds/docs/development/design/index - ../submodules/fds/docs/development/manuals/index - - IPV6 ---- .. toctree:: @@ -281,19 +253,3 @@ SFC ../submodules/sfc/docs/release/userguide/index ../submodules/sfc/docs/development/design/index ../submodules/sfc/docs/development/manuals/index - - -Vswitchperf ------------ -.. toctree:: - :maxdepth: 1 - - ../submodules/vswitchperf/docs/development/overview/index - ../submodules/vswitchperf/docs/development/requirements/index - ../submodules/vswitchperf/docs/release/installation/index - ../submodules/vswitchperf/docs/release/configguide/index - ../submodules/vswitchperf/docs/release/userguide/index - ../submodules/vswitchperf/docs/development/design/index - ../submodules/vswitchperf/docs/development/manuals/index - - diff --git a/docs/index.rst b/docs/index.rst index 78c35e473..48c72a6cd 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -1,4 +1,5 @@ -.. note:: This page is still under development. +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. SPDX-License-Identifier: CC-BY-4.0 OPNFV Documentation =================== diff --git a/docs/release/installation.introduction.rst b/docs/release/installation.introduction.rst index 9296bd9f1..470715861 100644 --- a/docs/release/installation.introduction.rst +++ b/docs/release/installation.introduction.rst @@ -32,7 +32,7 @@ it is important to understand your required target platform capabilities before configuring your scenarios. An OPNFV installation requires either a physical, or virtual, infrastructure environment as defined -in the `Pharos specification `. +in the `Pharos specification `_. When configuring a physical infrastructure it is strongly advised to follow the Pharos configuration guidelines. @@ -56,7 +56,6 @@ description documents provided: - :ref:`os-odl_l2-fdio-ha ` - :ref:`os-odl_l2-fdio-noha ` - :ref:`os-nosdn-fdio-noha ` -- :ref:`os-nosdn-kvm-noha <>` - :ref:`os-odl-gluon-noha ` - :ref:`os-nosdn-openo-ha ` - :ref:`os-odl_l2-sfc-ha ` @@ -90,12 +89,4 @@ The basic deployment validation only addresses a small part of capabilities prov the platform and you may want to execute more exhaustive tests. Some investigation will be required to select the right test suites to run on your platform. -Many of the OPNFV test project provide user-guide documentation and installation instructions in :ref:`this document ` - -Security Notes -============== - -The following patches were applied to fix security issues discovered in OPNFV -projects, during the Danube release cycle. - -- Links to security patches need to be added here. (todo) +Many of the OPNFV test project provide user-guide documentation and installation instructions in :ref:`this document ` \ No newline at end of file diff --git a/docs/release/release-notes.rst b/docs/release/release-notes.rst index 3bba1367a..9191b7556 100644 --- a/docs/release/release-notes.rst +++ b/docs/release/release-notes.rst @@ -26,8 +26,6 @@ Project release notes: :ref:`Doctor Release Notes ` -:ref:`Domino Release Notes ` - :ref:`FDS Release Notes ` :ref:`Fuel Release Notes ` @@ -40,8 +38,6 @@ Project release notes: :ref:`KVMforNFV Release Notes ` -:ref:`Multisite Release Notes ` - :ref:`Netready Release Notes ` :ref:`Opera Release Notes ` diff --git a/docs/release/userguide.introduction.rst b/docs/release/userguide.introduction.rst index 743567416..57a84e6df 100644 --- a/docs/release/userguide.introduction.rst +++ b/docs/release/userguide.introduction.rst @@ -58,16 +58,13 @@ OPNFV wiki page at http://wiki.opnfv.org, for more details. Feature Configuration Guides ============================ -- :ref:`Armband Configuration Guide ` - :ref:`Copper Configuration Guide ` - :ref:`Doctor Configuration Guide ` - :ref:`IPv6 Configuration Guide ` - :ref:`KVMforNFV Configuration Guide ` - :ref:`Netready Configuration Guide ` -- :ref:`ONOSFW Configuration Guide ` - :ref:`Parser Configuration Guide ` - :ref:`Promise Configuration Guide ` -- :ref:`SDNVPN Configuration Guide ` - :ref:`SFC Configuration Guide ` Feature User Guides @@ -79,8 +76,6 @@ Feature User Guides - :ref:`IPv6 User Guide ` - :ref:`KVMforNFV User Guide ` - :ref:`Netready User Guide ` -- :ref:`ONOSFW User Guide ` - :ref:`Parser User Guide ` - :ref:`Promise User Guide ` -- :ref:`SDNVPN User Guide ` - :ref:`SFC User Guide ` -- 2.16.6