Clean-up using onap section

Migrate top level structure from wiki
Eliminate duplicated subsections
Move to current stable release of Sphinx (1.6.7)

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

diff --git a/docs/conf.py b/docs/conf.py
index d6c6b03..de65991 100644 (file)
--- a/docs/conf.py
+++ b/docs/conf.py
@@ -376,4 +376,3 @@ epub_exclude_files = ['search.html']
 
 # Patterns to ignore in linkcheck builder
 linkcheck_ignore = [r'http://localhost:\d+/']
-

diff --git a/docs/guides/onap-developer/index.rst b/docs/guides/onap-developer/index.rst
index 11a4518..8ef2c0a 100644 (file)
--- a/docs/guides/onap-developer/index.rst
+++ b/docs/guides/onap-developer/index.rst
@@ -1,10 +1,13 @@
-.. 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
+.. Copyright 2017 AT&T Intellectual Property.  All rights reserved.
 
 .. _onap_developer_guides:
 
-ONAP Developer
-==============
-Documentation for developers.
+ONAP Developer Guides
+=====================
+The following guides are provided for developers who want to
+understanding or contribute to the ONAP open source.
 
 .. toctree::
    :maxdepth: 1

diff --git a/docs/guides/onap-user/index.rst b/docs/guides/onap-user/index.rst
index d0b52f8..7b0420d 100644 (file)
--- a/docs/guides/onap-user/index.rst
+++ b/docs/guides/onap-user/index.rst
@@ -1,15 +1,19 @@
-.. 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
+.. Copyright 2017 AT&T Intellectual Property.  All rights reserved.
 
 
-ONAP User
-==========
-Describe the different user audiences, tasks performed, and the guides provided for each.
+
+ONAP User Guides
+================
+The following guides are provided to describe tasks that a user of
+ONAP may need to perform when integrating, deploying, and operating
+an instance of ONAP.
 
 .. toctree::
    :maxdepth: 1
 
-   onboarding_and_distributing.rst
-   vnfprovider.rst
-   servicedesigner.rst
-   serviceadmin.rst
    platformadmin.rst
+   servicedesigner.rst
+   servicecreator.rst
+   vnfprovider.rst

diff --git a/docs/guides/onap-user/onap-portal-home.png b/docs/guides/onap-user/onap-portal-home.png
new file mode 100755 (executable)
index 0000000..4e89725
Binary files /dev/null and b/docs/guides/onap-user/onap-portal-home.png differ

diff --git a/docs/guides/onap-user/onboarding_and_distributing.rst b/docs/guides/onap-user/onboarding_and_distributing.rst
deleted file mode 100644 (file)
index c150703..0000000
--- a/docs/guides/onap-user/onboarding_and_distributing.rst
+++ /dev/null
@@ -1,16 +0,0 @@
-.. This work is licensed under a Creative Commons Attribution 4.0 International License.
-.. http://creativecommons.org/licenses/by/4.0
-.. Copyright 2017 ONAP
-
-.. _onboarding-and-distributing:
-
-============================================================
-Onboarding and Distributing a Vendor Software Product (VSP)
-============================================================
-
-   Those are links to the SDC user guides found in ONAP Confluence:
-
-- `Resource Onboarding <https://wiki.onap.org/display/DW/Resource+Onboarding>`_
-- `Service Design <https://wiki.onap.org/display/DW/Service+Design>`_
-- `VF Creation and Testing <https://wiki.onap.org/display/DW/VF+Creation+and+Testing>`_
-- `Governance Approval and Service Distribution <https://wiki.onap.org/display/DW/Governance+Approval+and+Service+Distribution>`_

diff --git a/docs/guides/onap-user/platformadmin.rst b/docs/guides/onap-user/platformadmin.rst
index 8c1fb2e..c0db9d6 100644 (file)
--- a/docs/guides/onap-user/platformadmin.rst
+++ b/docs/guides/onap-user/platformadmin.rst
@@ -2,10 +2,55 @@
 .. http://creativecommons.org/licenses/by/4.0
 .. Copyright 2017 AT&T Intellectual Property.  All rights reserved.
 
-User Portal
+
+ONAP Portal
 ===========
-.. note::
-   Until this section is migrated to gerrit/readthedocs, use the link below.
+The ONAP Portal integrates different ONAP applications in one place.
+The Portal platform provides common management services and
+connectivity, while the applications run separately.
+
+From the Portal, users access applications. Administrators
+onboard and manage applications and widgets, and manage user access.
+
+The Portal SDK for application developers includes bundled tools,
+technologies, and built-in capabilities such as services, APIs,
+and UI controls. Existing applications can migrate to the Portal
+with the provided APIs and libraries.
+See :ref:`Portal SDK <portal-sdk>`
+
+Access the ONAP Portal
+----------------------
+
+Access the ONAP Portal using a browser such as Mozilla Firefox or
+Google Chrome. The URL is dependent on a specific ONAP platform
+deployment.
+
+From the Portal, users access applications directly or by
+function using the Manage menu.
+
+.. figure:: onap-portal-home.png
+   :width: 900 px
+   :height: 600 px
+
+
+Roles in the ONAP Portal
+------------------------
+The Portal displays different menus for the following roles:
+
+* User
+
+* Portal Administrator
+
+* Application Administrator
+
+* Governor
+
+* Operator
+
+Each application also defines a distinct set of user roles.
+See Users.
 
-* `User Portal  <https://wiki.onap.org/x/fIsP>`_
+See also
+--------
 
+* `Applications in the Portal <https://wiki.onap.org/x/h4sP>`_

diff --git a/docs/guides/onap-user/serviceadmin.rst b/docs/guides/onap-user/serviceadmin.rst
deleted file mode 100644 (file)
index 40bdf01..0000000
--- a/docs/guides/onap-user/serviceadmin.rst
+++ /dev/null
@@ -1,10 +0,0 @@
-.. This work is licensed under a Creative Commons Attribution 4.0 International License.
-
-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/servicecreator.rst b/docs/guides/onap-user/servicecreator.rst
new file mode 100644 (file)
index 0000000..941bf5b
--- /dev/null
+++ b/docs/guides/onap-user/servicecreator.rst
@@ -0,0 +1,42 @@
+
+.. 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.
+
+
+Service Deployment
+==================
+Deploy a service by following these general steps:
+
+* `Instantiate a network <https://wiki.onap.org/x/r40P>`_
+* `Gather and validate data for an infrastructure service/network <https://wiki.onap.org/x/sY0P>`_
+* `Instantiate an infrastructure service <https://wiki.onap.org/x/to0P>`_
+* `Post instantiation <https://wiki.onap.org/x/uY0P>`_
+
+About infrastructure services
+-----------------------------
+
+Infrastructure services describe VFs that are designed to meet
+the need for additional capacity in the network. Service Designers
+create the VFs/services that represent such capacity, and
+Operations representatives trigger the instantiation of the
+infrastructure service using the Virtual Instantiation
+Deployment (VID) GUI. These services are based on the need for
+additional capacity or the removal of deployed capacity.
+
+Example infrastructure service types:
+
+ * mobile
+
+ * layer 3
+
+ * layer 4+
+
+ * cloud
+
+Capacity Planning
+-----------------
+
+Before triggering VF instantiation,
+ensure the capacity and resources required by each VF in
+a service are available.

diff --git a/docs/guides/onap-user/servicedesigner.rst b/docs/guides/onap-user/servicedesigner.rst
index c934c3a..823fccd 100644 (file)
--- a/docs/guides/onap-user/servicedesigner.rst
+++ b/docs/guides/onap-user/servicedesigner.rst
@@ -1,8 +1,35 @@
-.. 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
+.. Copyright 2017 AT&T Intellectual Property.  All rights reserved.
 
-Service Designer
-================
-.. note::
-   Until this section is migrated to gerrit/readthedocs, use the link below.
+Service Design
+==============
+The goal of the service design process is to create all artifacts
+(models) that are required to instantiate and manage resources,
+services, and products on the ONAP platform. The design process
+requires input from users with multiple roles.
 
-* `Service Designer <https://wiki.onap.org/x/E4AP>`_
+Design progresses logically through a series of phases. Each phase:
+
+* is organized into steps that are completed in sequence
+
+* is accessed using a different role with specific responsibilities
+  generates artifacts that are used in other phases of design or when
+  instantiating or monitoring virtual functions.
+
+Design includes the following topics:
+
+
+* `Pre-Onboarding <https://wiki.onap.org/x/Y4AP>`_
+
+* `Resource Onboarding <https://wiki.onap.org/x/YIAP>`_
+
+* `VF Creation and Testing <https://wiki.onap.org/x/PoAP>`_
+
+* `Governance Approval and Service Distribution <https://wiki.onap.org/x/UYAP>`_
+
+* `Control Loop Design <https://wiki.onap.org/x/WYAP>`_
+
+* `Policy Design <https://wiki.onap.org/x/SYAP>`_
+
+* `SDC Artifacts List <https://wiki.onap.org/x/LYAP>`_

diff --git a/etc/requirements.txt b/etc/requirements.txt
index 85c7da1..23b4659 100644 (file)
--- a/etc/requirements.txt
+++ b/etc/requirements.txt
@@ -1,5 +1,5 @@
 tox
-Sphinx==1.5.3
+Sphinx==1.6.7
 doc8
 docutils
 setuptools