Multiple editorial improvements

Release notes expanded outline and content
Release notes for doc projet
Remove aai/sparky-fe submodule combined with spark-be
Remove Module & Renamed Index and Search

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

diff --git a/.gitmodules b/.gitmodules
index e2f2fab..bf84b34 100644 (file)
--- a/.gitmodules
+++ b/.gitmodules
@@ -118,11 +118,6 @@
        url = ../aai/esr-gui
        branch = .
        ignore = dirty
-[submodule "docs/submodules/aai/sparky-fe.git"]
-       path = docs/submodules/aai/sparky-fe.git
-       url = ../aai/sparky-fe
-       branch = .
-       ignore = dirty
 [submodule "docs/submodules/aai/sparky-be.git"]
        path = docs/submodules/aai/sparky-be.git
        url = ../aai/sparky-be

diff --git a/docs/guides/onap-developer/apiref/index.rst b/docs/guides/onap-developer/apiref/index.rst
new file mode 100644 (file)
index 0000000..bad2793
--- /dev/null
+++ b/docs/guides/onap-developer/apiref/index.rst
@@ -0,0 +1,9 @@
+.. 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.
+
+.. _doc-apiref:
+
+API Reference
+=============
+

diff --git a/docs/guides/onap-developer/architecture/index.rst b/docs/guides/onap-developer/architecture/index.rst
index 8e9fadf..1bb57cf 100644 (file)
--- a/docs/guides/onap-developer/architecture/index.rst
+++ b/docs/guides/onap-developer/architecture/index.rst
@@ -1,7 +1,9 @@
-.. 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.
 
+.. 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.
+
+.. _doc-architecture:
 
 Architecture
 ============
@@ -79,7 +81,6 @@ Common Services
    AAI ESR UI <../../../submodules/aai/esr-gui.git/docs/platform/architecture.rst>
    AAI ESR Server <../../../submodules/aai/esr-server.git/docs/platform/architecture.rst>
    ../../../submodules/aai/sparky-be.git/docs/architecture.rst
-   ../../../submodules/aai/sparky-fe.git/docs/architecture.rst
    ../../../submodules/dmaap/messagerouter/messageservice.git/docs/architecture.rst
    MSB - Microservices Bus <../../../submodules/msb/apigateway.git/docs/platform/architecture.rst>
    ../../../submodules/msb/discovery.git/docs/architecture.rst
@@ -108,7 +109,7 @@ SDKs
    ../../../submodules/ccsdk/storage/esaas.git/docs/architecture.rst
    ../../../submodules/ccsdk/storage/pgaas.git/docs/architecture.rst
    ../../../submodules/ccsdk/utils.git/docs/architecture.rst
-   ../../../submodules/portal.git/docs/portal-sdk/architecture.rst
+   Portal <../../../submodules/portal.git/docs/tutorials/portal-sdk/architecture.rst>
    ../../../submodules/vnfsdk/model.git/docs/architecture.rst
 
 Other

diff --git a/docs/guides/onap-developer/index.rst b/docs/guides/onap-developer/index.rst
index 4787f52..13c7372 100644 (file)
--- a/docs/guides/onap-developer/index.rst
+++ b/docs/guides/onap-developer/index.rst
@@ -14,4 +14,5 @@ Describe the kinds of references, tutorials, specifications provided for develop
    settingup/index
    developing/index
    how-to-use-docs/index
+   apiref/index
 

diff --git a/docs/guides/onap-developer/tutorials/index.rst b/docs/guides/onap-developer/tutorials/index.rst
index 5864e4d..4519eae 100644 (file)
--- a/docs/guides/onap-developer/tutorials/index.rst
+++ b/docs/guides/onap-developer/tutorials/index.rst
@@ -3,5 +3,9 @@
 Tutorials
 =========
 
+.. toctree::
+   :maxdepth: 1
+   :titlesonly:
 
-
+   
+   platform/index.rst

diff --git a/docs/guides/onap-developer/tutorials/platform/index.rst b/docs/guides/onap-developer/tutorials/platform/index.rst
new file mode 100644 (file)
index 0000000..75cbadf
--- /dev/null
+++ b/docs/guides/onap-developer/tutorials/platform/index.rst
@@ -0,0 +1,8 @@
+.. 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.
+
+.. _demo-installing-running-onap:
+
+Installing & Running ONAP
+=========================

diff --git a/docs/guides/onap-user/vnfprovider.rst b/docs/guides/onap-user/vnfprovider.rst
index d643677..6d6fd2f 100644 (file)
--- a/docs/guides/onap-user/vnfprovider.rst
+++ b/docs/guides/onap-user/vnfprovider.rst
@@ -1,8 +1,8 @@
 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
 
 
-VNF Provider Guide
-==================
+VNF Provider Guidelines and Requirements
+========================================
 
 .. toctree::
    :maxdepth: 2

diff --git a/docs/index.rst b/docs/index.rst
index e1e2ab2..32d9b93 100644 (file)
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -14,9 +14,8 @@ ONAP Documentation
 
 
 
-Indices and tables
-==================
+Index and Search
+================
 
 * :ref:`genindex`
-* :ref:`modindex`
 * :ref:`search`

diff --git a/docs/release-notes.rst b/docs/release-notes.rst
new file mode 100644 (file)
index 0000000..716baa9
--- /dev/null
+++ b/docs/release-notes.rst
@@ -0,0 +1,36 @@
+
+.. 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.
+
+.. _doc-release-notes:
+
+Release Notes
+=============
+
+
+Version: x.y.z
+--------------
+
+
+:Release Date: yyyy-mm-dd
+
+
+
+**New Features**
+
+Release controlled documentation moved to / now managed in gerrit and published
+on readthedocs.
+
+**Bug Fixes**
+         
+
+**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.
+
+===========
+
+End of Release Notes

diff --git a/docs/release/index.rst b/docs/release/index.rst
index aad7d75..c7dd5bb 100644 (file)
--- a/docs/release/index.rst
+++ b/docs/release/index.rst
@@ -1,32 +1,78 @@
-.. This work is licensed under a Creative Commons Attribution 4.0 International License.
-
+.. This work is licensed under a Creative Commons Attribution 4.0
+   International License. http://creativecommons.org/licenses/by/4.0
 
 Releases
 ========
-ONAP is developed and released around 6 month cycles.   After an initial major release, additional
-stable point releases may be created.
+ONAP is developed and released around 6 month cycles. After an initial
+major release, additional stable point releases may be created.  The first
+release is Amsterdam and subsequent major release will be named using city
+names.
+
+
+Amsterdam Release
+-----------------
+
+Summary
++++++++
+
+Functionality
++++++++++++++
+
+
+Project Specific Release Notes
+++++++++++++++++++++++++++++++
+Major and stable point releases are specified by a list of project artifact
+versions in a :ref:`manifest here<doc-release-manifest>`.
+Each project provides detailed :ref:`release notes here <doc-releaserepos>`
+and prepends to these if/when any updated versions, the project team believes
+are compatible with major release, are made available.
+
+
+Supported Platforms
++++++++++++++++++++
+
+
+Documentation
++++++++++++++
+Release controlled documentation is available :ref:`here <master_index>`.
+For Amsterdam this includes:
+
+* A high level architecture view of how components delivered by all projects
+  relate to each other are :ref:`available here <doc-architecture>`.
+
+* A collection of documentation provided by each project and for some projects
+  several components / repositories within the project
+  are :ref:`available here <doc-repolist>`.
+
+* Application Programming Interface Reference :ref:`available here <doc-apiref>`
+
+* The `developer wiki <http://wiki.onap.org>`_ remains a good source of
+  information on meeting plans and notes from committees, project teams,
+  community events and general, release independent information about
+  ONAP.  Release dependent information is being migrated from the wiki to
+  gerrit source control. See the doc
+  project :ref:`release notes <doc-release-notes>` for current status.
+
+
+Known Issues and Limitations
+++++++++++++++++++++++++++++
+TBP overall / general statement
+See :ref:`release notes <doc-releaserepos>` for each project.
+
+License
++++++++
 
-Named Releases
---------------
 
-.. csv-table:: 
-   :align: left
-   :header-rows: 0
-   :header: "Release", "Status", "Initial Release Date", "Next Phase", "EOL Date"
-   :widths:  15,       10,       10,                     15,           10
+How to Report a Bug
++++++++++++++++++++
 
-   "Amsterdam", "Under Development", "TBD",   "",  ""
-   "OpenECOMP R1.0.0 Seed Code", "EOL", "2017-04-XX", "", ""
 
-Amsterdam Projects
-------------------
-The following projects repositories have been approved by the TSC to be part of
-the Amsterdam Release and provide detailed release notes at the links below.
+Download and Use
+++++++++++++++++
 
-.. include:: releaserepos.rst
+* Source Code in Gerrit https://gerrit.onap.org
 
+* Artifacts in Nexus / Docker Hub
 
-==========================
+* Platform :ref:`Demo <demo-installing-running-onap>`.
 
-The complete list of projects providing documentation for current and future releases
-has been moved to the onap-developer guide :ref:`doc_onap-developer_guide_projects`.   

diff --git a/docs/release/release-manifest.rst b/docs/release/release-manifest.rst
new file mode 100644 (file)
index 0000000..a74fc72
--- /dev/null
+++ b/docs/release/release-manifest.rst
@@ -0,0 +1,27 @@
+.. 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.
+
+.. _doc-release-manifest:
+
+Release Manifest
+----------------
+
+
+Nexus Artifacts nexus.onap.org
+++++++++++++++++++++++++++++++
+
+
+.. csv-table::  
+   :align: left
+   :header-rows: 1
+   :file:  ../submodules/integration.git/version-manifest/src/main/resources/java-manifest.csv
+
+
+Docker Images  nexus3.onap.org
+++++++++++++++++++++++++++++++
+
+.. csv-table:: 
+   :align: left
+   :header-rows: 1
+   :file:  ../submodules/integration.git/version-manifest/src/main/resources/docker-manifest.csv

diff --git a/docs/release/releaserepos.rst b/docs/release/releaserepos.rst
index 9669f96..b717a89 100644 (file)
--- a/docs/release/releaserepos.rst
+++ b/docs/release/releaserepos.rst
@@ -3,6 +3,8 @@
 .. Copyright 2017 AT&T Intellectual Property.  All rights reserved.
 
 
+.. _doc-releaserepos:
+
 Project Specific Release Notes
 ------------------------------
 
@@ -15,7 +17,6 @@ Project Specific Release Notes
    Release Notes for aai/esr-gui<../submodules/aai/esr-gui.git/docs/release-notes.rst>
    Release Notes for aai/esr-server<../submodules/aai/esr-server.git/docs/release-notes.rst>
    Release Notes for aai/sparky-be<../submodules/aai/sparky-be.git/docs/release-notes.rst>
-   Release Notes for aai/sparky-fe<../submodules/aai/sparky-fe.git/docs/release-notes.rst>
    Release Notes for appc/deployment<../submodules/appc/deployment.git/docs/release-notes.rst>
    Release Notes for appc<../submodules/appc.git/docs/release-notes.rst>
    Release Notes for ccsdk/dashboard<../submodules/ccsdk/dashboard.git/docs/release-notes.rst>
@@ -34,6 +35,7 @@ Project Specific Release Notes
    Release Notes for clamp<../submodules/clamp.git/docs/release-notes.rst>
    Release Notes for cli<../submodules/cli.git/docs/release-notes.rst>
    Release Notes for dcaegen2<../submodules/dcaegen2.git/docs/sections/release-notes.rst>
+   Release Notes for doc <../release-notes.rst>
    Release Notes for dmaap/messagerouter/messageservice<../submodules/dmaap/messagerouter/messageservice.git/docs/release-notes.rst>
    Release Notes for holmes/engine-management<../submodules/holmes/engine-management.git/docs/release-notes.rst>
    Release Notes for holmes/rule-management<../submodules/holmes/rule-management.git/docs/release-notes.rst>

diff --git a/docs/release/repolist.rst b/docs/release/repolist.rst
index 6a37e2f..a4fdebc 100644 (file)
--- a/docs/release/repolist.rst
+++ b/docs/release/repolist.rst
@@ -1,9 +1,9 @@
-.. 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.
-
+.. 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.
 
 
+.. _doc-repolist:
 
 Project/Components
 ------------------
@@ -73,6 +73,6 @@ Project/Components
    VFC - Virtual Function Controller <../submodules/vfc/nfvo/lcm.git/docs/index>
    VID - Virtual Infrastructure Deployment <../submodules/vid.git/docs/index>
    vid/asdcclient <../submodules/vid/asdcclient.git/docs/index>
-   VNF Guidelines <../submodules/vnfrqts/guidelines.git/docs/index>
-   VNF Requirements <../submodules/vnfrqts/requirements.git/docs/index>
+   ../submodules/vnfrqts/guidelines.git/docs/index
+   ../submodules/vnfrqts/requirements.git/docs/index
    VNF Software Development Kit <../submodules/vnfsdk/model.git/docs/index>

diff --git a/docs/submodules/aai/sparky-fe.git b/docs/submodules/aai/sparky-fe.git
deleted file mode 160000 (submodule)
index b17197c..0000000
--- a/docs/submodules/aai/sparky-fe.git
+++ /dev/null
@@ -1 +0,0 @@
-Subproject commit b17197cd75aaddbb1b37c49846842fbee0f7c2aa