Improve References to User Guides

Insert Note before DW User Guide Links
Add index entries to for major sections topics
Remove requirement.txt workarounds after RTD change to
recognize readthedocs.yml in the root folder
Update release notes

Change-Id: Id57ff10a055ea1d1e5394170d5b5b401d51d58ab
Issue-ID: DOC-60
Signed-off-by: Rich Bennett <rb2745@att.com>

diff --git a/docs/guides/onap-developer/apiref/index.rst b/docs/guides/onap-developer/apiref/index.rst
index b14acc1..db4cd6a 100644 (file)
--- a/docs/guides/onap-developer/apiref/index.rst
+++ b/docs/guides/onap-developer/apiref/index.rst
@@ -2,6 +2,8 @@
    International License. http://creativecommons.org/licenses/by/4.0
    Copyright 2017 AT&T Intellectual Property.  All rights reserved.
 
+.. index:: API Reference
+
 .. _doc-apiref:
 
 REST API Reference

diff --git a/docs/guides/onap-developer/architecture/index.rst b/docs/guides/onap-developer/architecture/index.rst
index 960cda2..d4f38d9 100644 (file)
--- a/docs/guides/onap-developer/architecture/index.rst
+++ b/docs/guides/onap-developer/architecture/index.rst
@@ -3,6 +3,8 @@
    International License. http://creativecommons.org/licenses/by/4.0
    Copyright 2017 AT&T Intellectual Property.  All rights reserved.
 
+.. index:: Platform Architecture
+
 .. _doc-architecture:
 
 Architecture

diff --git a/docs/guides/onap-developer/developing/index.rst b/docs/guides/onap-developer/developing/index.rst
index c5690ac..c6528f1 100644 (file)
--- a/docs/guides/onap-developer/developing/index.rst
+++ b/docs/guides/onap-developer/developing/index.rst
@@ -2,6 +2,8 @@
 .. http://creativecommons.org/licenses/by/4.0
 .. Copyright 2017 AT&T Intellectual Property.  All rights reserved.
 
+.. index:: Developer Guides
+
 .. _doc_onap-developer_guide_projects:
 
 Developing ONAP

diff --git a/docs/guides/onap-developer/how-to-use-docs/addendum.rst b/docs/guides/onap-developer/how-to-use-docs/addendum.rst
index eccd002..2d8a25c 100644 (file)
--- a/docs/guides/onap-developer/how-to-use-docs/addendum.rst
+++ b/docs/guides/onap-developer/how-to-use-docs/addendum.rst
@@ -60,8 +60,6 @@ You can add html content that only appears in html output by using the
         This line will be shown only in html version.
 
 
-.. index:: single: indices
-
 Creating Indices
 ----------------
 

diff --git a/docs/guides/onap-developer/how-to-use-docs/documentation-guide.rst b/docs/guides/onap-developer/how-to-use-docs/documentation-guide.rst
index 8fd9a73..9c5822d 100644 (file)
--- a/docs/guides/onap-developer/how-to-use-docs/documentation-guide.rst
+++ b/docs/guides/onap-developer/how-to-use-docs/documentation-guide.rst
@@ -100,7 +100,6 @@ A starting structure is shown below and may change as content is
 integrated for each release.   Other ONAP projects will provide
 content that is referenced from this structure.
 
-.. index:: master
 
 
 ::
@@ -133,7 +132,6 @@ ONAP jenkins jobs that verify and merge documentation are triggered by
 RST file changes in the top level docs directory and below.
 
 
-.. index:: licensing
 
 Licensing
 ---------

diff --git a/docs/guides/onap-developer/how-to-use-docs/index.rst b/docs/guides/onap-developer/how-to-use-docs/index.rst
index a73ae6f..6f1dd2d 100644 (file)
--- a/docs/guides/onap-developer/how-to-use-docs/index.rst
+++ b/docs/guides/onap-developer/how-to-use-docs/index.rst
@@ -12,3 +12,8 @@ Creating Documentation
    include-documentation
    converting-formats
    addendum
+
+.. toctree::
+   :hidden:
+
+   update-review.rst

diff --git a/docs/guides/onap-developer/settingup/fullonap.rst b/docs/guides/onap-developer/settingup/fullonap.rst
index 859005f..6d3d891 100644 (file)
--- a/docs/guides/onap-developer/settingup/fullonap.rst
+++ b/docs/guides/onap-developer/settingup/fullonap.rst
@@ -7,6 +7,8 @@
    :depth: 2
 ..
 
+.. index:: Setting Up Full ONAP
+
 
 ========================
 **Setting Up Full ONAP**

diff --git a/docs/guides/onap-user/platformadmin.rst b/docs/guides/onap-user/platformadmin.rst
index 1c573f4..4ebc72b 100644 (file)
--- a/docs/guides/onap-user/platformadmin.rst
+++ b/docs/guides/onap-user/platformadmin.rst
@@ -1,5 +1,11 @@
 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. http://creativecommons.org/licenses/by/4.0
+.. Copyright 2017 AT&T Intellectual Property.  All rights reserved.
 
 Platform Administrator
 ======================
-* `See Platform Administrator <https://wiki.onap.org/x/fIsP>`_
+.. note::
+   Until this section is migrated to gerrit/readthedocs, use the link below.
+
+* `ONAP Portal  <https://wiki.onap.org/x/fIsP>`_
+

diff --git a/docs/guides/onap-user/serviceadmin.rst b/docs/guides/onap-user/serviceadmin.rst
index 97db426..40bdf01 100644 (file)
--- a/docs/guides/onap-user/serviceadmin.rst
+++ b/docs/guides/onap-user/serviceadmin.rst
@@ -2,6 +2,9 @@
 
 Service Administrator
 =====================
+.. note::
+   Until this section is migrated to gerrit/readthedocs, use the links below.
+
 * `Deploy <https://wiki.onap.org/x/CowP>`_
 
 * `Operate <https://wiki.onap.org/x/TYwP>`_

diff --git a/docs/guides/onap-user/servicedesigner.rst b/docs/guides/onap-user/servicedesigner.rst
index 0ae7f35..c934c3a 100644 (file)
--- a/docs/guides/onap-user/servicedesigner.rst
+++ b/docs/guides/onap-user/servicedesigner.rst
@@ -2,5 +2,7 @@
 
 Service Designer
 ================
+.. note::
+   Until this section is migrated to gerrit/readthedocs, use the link below.
 
-* `See Service Designer <https://wiki.onap.org/x/E4AP>`_
+* `Service Designer <https://wiki.onap.org/x/E4AP>`_

diff --git a/docs/release-notes.rst b/docs/release-notes.rst
index 716baa9..8c8b5e1 100644 (file)
--- a/docs/release-notes.rst
+++ b/docs/release-notes.rst
@@ -13,13 +13,13 @@ Version: x.y.z
 --------------
 
 
-:Release Date: yyyy-mm-dd
+:Release Date: 2017-11-20
 
 
 
 **New Features**
 
-Release controlled documentation moved to / now managed in gerrit and published
+Project release controlled documentation is now managed in gerrit and published
 on readthedocs.
 
 **Bug Fixes**
@@ -27,9 +27,9 @@ on readthedocs.
 
 **Other**
 
-The developer wiki still contains pages that are release dependent, should be
-under change control in gerrit, and are being referenced from some gerrit change controlled documentation.  The pages and links that remain to be migrated
-are listed in <JIRA ISSUE> and by TBD tag or other indicator on the wiki.
+The developer wiki still contains some pages that are referenced from the
+readthedocs documentation. The pages and links that remain to be migrated
+are listed in Jira Issue DOC-179 and labeled on the wiki with "move-to-rtd".
 
 ===========
 

diff --git a/docs/release/index.rst b/docs/release/index.rst
index 2224848..bc4ee56 100644 (file)
--- a/docs/release/index.rst
+++ b/docs/release/index.rst
@@ -1,6 +1,8 @@
 .. This work is licensed under a Creative Commons Attribution 4.0
    International License. http://creativecommons.org/licenses/by/4.0
 
+.. index:: Release Notes
+
 Releases
 ========
 This page is the ONAP Amsterdam Release Notes. The first release is
@@ -27,10 +29,10 @@ product could on its own.
 
 Functionality
 +++++++++++++
-*Portal* - a single, consistent user experience for both design timer
+**Portal** - a single, consistent user experience for both design timer
 and run time environments, based on the user’s role.
 
-*Design Time Framework* - a comprehensive development environment with
+**Design Time Framework** - a comprehensive development environment with
 tools, techniques, and repositories for defining/describing resources,
 services, and products:
 
@@ -46,9 +48,9 @@ services, and products:
    and/or enforced.
 
  - Closed Loop Automation Management Platform (CLAMP) provides a method
-   for designing and managing control loops.**
+   for designing and managing control loops.
 
-*Runtime Framework* - The runtime execution framework executes the
+**Runtime Framework** - The runtime execution framework executes the
 rules and policies distributed by the design and creation environment
 and Controllers that manage resources corresponding to their assigned
 controlled domain:
@@ -71,7 +73,7 @@ controlled domain:
    system’s resources, services, products and their relationships with each
    other.
 
-*Closed-Loop Automation* -- Design -> Create -> Collect -> Analyze >
+**Closed-Loop Automation** -- Design -> Create -> Collect -> Analyze >
 Detect -> Publish -> Respond:
 
  - Data Collection, Analytics and Events (DCAE) collects performance,
@@ -124,11 +126,16 @@ Known Issues and limitations are documented in each project Release Notes.
 
 Refer to :ref:`release notes <doc-releaserepos>` for each project.
 
+
+.. index:: Licensing
+
 Licenses
 ++++++++
 ONAP Amsterdam Source Code is licensed under the `Apache Version 2 License <http://www.apache.org/licenses/LICENSE-2.0>`_.
 ONAP Amsterdam Documentation is licensed under the `Creative Commons Attribution 4.0 International License <http://creativecommons.org/licenses/by/4.0>`_.
 
+.. index:: Reporting Bugs
+
 How to Report a Bug
 +++++++++++++++++++
 There are 2 ways to report a bug in ONAP.
@@ -142,6 +149,7 @@ There are 2 ways to report a bug in ONAP.
 
 You may consider these `recommendations <https://wiki.onap.org/display/DW/Tracking+Issues+with+JIRA#TrackingIssueswithJIRA-RecommendationsforwrittingProperJIRAIssue>`_ to elaborate the issue you are facing and this `guideline <https://wiki.onap.org/display/DW/Mailing+Lists>`_ to register into the ONAP Discuss mailing list.
 
+.. index:: Download
 
 Download
 ++++++++
@@ -151,6 +159,9 @@ Download
 * ONAP is packaged within Docker and can be dowloaded from Docker Hub at https://hub.docker.com/r/onap .
 
 
+.. index:: Installation
+
+
 Install
 +++++++
 There are 2 approaches to install ONAP.
@@ -174,3 +185,12 @@ VNF creation, VNF preload, VF Module creation and closed loop operations)
 the vFirewall sanity use case is documented
 in `Running the ONAP Demos <https://wiki.onap.org/display/DW/Running+the+ONAP+Demos>`_.
 
+
+.. Include files referenced by link in the toctree as hidden
+
+.. toctree::
+   :hidden:
+
+   release-manifest.rst
+   releaserepos.rst
+   repolist.rst

diff --git a/docs/release/release-manifest.rst b/docs/release/release-manifest.rst
index a74fc72..9783874 100644 (file)
--- a/docs/release/release-manifest.rst
+++ b/docs/release/release-manifest.rst
@@ -2,6 +2,8 @@
    International License. http://creativecommons.org/licenses/by/4.0
    Copyright 2017 AT&T Intellectual Property.  All rights reserved.
 
+.. index:: Release Manifest
+
 .. _doc-release-manifest:
 
 Release Manifest

diff --git a/docs/release/repolist.rst b/docs/release/repolist.rst
index ecb0435..ae8adcd 100644 (file)
--- a/docs/release/repolist.rst
+++ b/docs/release/repolist.rst
@@ -3,6 +3,8 @@
    Copyright 2017 AT&T Intellectual Property.  All rights reserved.
 
 
+.. index:: Projects Providing Documentation
+
 .. _doc-repolist:
 
 Project/Components

diff --git a/docs/requirements.txt b/docs/requirements.txt
deleted file mode 100644 (file)
index 85c7da1..0000000
--- a/docs/requirements.txt
+++ /dev/null
@@ -1,12 +0,0 @@
-tox
-Sphinx==1.5.3
-doc8
-docutils
-setuptools
-six
-sphinx_rtd_theme
-sphinxcontrib-blockdiag
-sphinxcontrib-seqdiag
-sphinxcontrib-swaggerdoc
-sphinxcontrib-plantuml
-sphinx_bootstrap_theme>=0.4.11