Release notes for R1/Amsterdam/1.3.0
Issue: PORTAL-141
Change-Id: I15540167d1205230515c7cb4e8030314f4bd6a3b
Signed-off-by: Christopher Lott (cl778h) <clott@research.att.com>
diff --git a/docs/index.rst b/docs/index.rst
index da29985..b187c2d 100644
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -2,13 +2,15 @@
Portal
------
-
+
.. toctree::
:maxdepth: 2
+ platform/index
+ release-notes/index
tutorials/index
Search
======
-
+
* :ref:`search`
diff --git a/docs/platform/PortalArchDiagram.jpg b/docs/platform/PortalArchDiagram.jpg
new file mode 100644
index 0000000..91195f8
--- /dev/null
+++ b/docs/platform/PortalArchDiagram.jpg
Binary files differ
diff --git a/docs/platform/PortalLandingPage.png b/docs/platform/PortalLandingPage.png
new file mode 100644
index 0000000..cb82df7
--- /dev/null
+++ b/docs/platform/PortalLandingPage.png
Binary files differ
diff --git a/docs/platform/architecture.rst b/docs/platform/architecture.rst
new file mode 100644
index 0000000..324b5ff
--- /dev/null
+++ b/docs/platform/architecture.rst
@@ -0,0 +1,23 @@
+ .. This work is licensed under a Creative Commons Attribution 4.0 International License.
+ .. http://creativecommons.org/licenses/by/4.0
+
+
+Architecture
+------------
+
+.. contents::
+ :depth: 3
+
+PORTAL Platform
+
+The ONAP Portal is a platform that provides the ability to integrate different ONAP applications into a centralized Portal Core. The intention is to allow decentralized applications to run within their own infrastructure while providing common management services and connectivity. The Portal core provides capabilities including application onboarding & management, centralized access management, and hosted application widgets. Using the provided SDK, application developers can leverage the built-in capabilities (Services / API / UI controls) along with bundled tools and technologies.
+.. image:: PortalArchDiagram.jpg
+
+The Portal provides a web-based user interface that provides access to all of the subsystems of an instance of ONAP. It offers both design-time tools and run-time monitoring and control.
+
+Any user seeking access to an ONAP application will first visit the Portal, where authentication will be performed. Based on the user’s configured access level, the Portal will let the user access different application widgets, and might also redirect the user to a specific run-time environment.
+
+From the Portal, users access applications and Key Performance Indicators. Administrators onboard and manage applications and hosted application widgets, and manage user access.
+
+Here are two views of the Portal landing screen, one for administrators, and one for users:
+.. image:: PortalLandingPage.png
diff --git a/docs/platform/index.rst b/docs/platform/index.rst
new file mode 100644
index 0000000..8befd88
--- /dev/null
+++ b/docs/platform/index.rst
@@ -0,0 +1,9 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+
+Portal Platform
+---------------
+
+.. toctree::
+ :maxdepth: 1
+
+ architecture.rst
diff --git a/docs/release-notes/bug-fixes.rst b/docs/release-notes/bug-fixes.rst
new file mode 100644
index 0000000..136ec27
--- /dev/null
+++ b/docs/release-notes/bug-fixes.rst
@@ -0,0 +1,42 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+
+Bug Fixes
+---------
+
+ ONAP PORTAL Framework items for: (Last Updated: 16 November 2017
+
+ * **Version**: Amsterdam Release
+ * **Release Date**: 16 November 2017
+ * **Description**: R1
+
+Bug
+^^^
+
+ * [PORTAL-101] Accessing Portal Encountered Server.int() Error
+ * [PORTAL-102] got error 404 when create/update App account management
+ * [PORTAL-108] unable to delete an existing account from APP Account Management
+ * [PORTAL-116] Empty Widgets on Home page
+ * [PORTAL-117] Not able to see the CLI app in portal application catalog
+ * [PORTAL-124] xDemo App and DMaap Bus Ctrl roles are not loading in CSIT env
+ * [PORTAL-125] missing role assignment when add/update a user in portal
+ * [PORTAL-127] remove GreenSock code from b2b libraries
+ * [PORTAL-137] Enhance authentication
+ * [PORTAL-138] Portal failed to install, error on "invalid docker-compose.yml"
+ * [PORTAL-139] modify onboard DB script
+ * [PORTAL-30] Failed to communicate with the widget microservice
+ * [PORTAL-33] Could not find artifact org.openecomp.ecompsdkos:epsdk-core:jar:1.1.0-SNAPSHOT in snapshots
+ * [PORTAL-57] rename 3 widgets in pre-load process
+ * [PORTAL-59] failed to display Portal users on User page
+ * [PORTAL-68] unable to get Swagger for ONAP Portal
+ * [PORTAL-69] unable to pick role in Functional Menu Update
+ * [PORTAL-72] Portal code Sonar scan
+ * [PORTAL-74] Sub component "ecomp-portal-BE-os" of Portal has its Log Provider Configuration File sealed inside the WAR
+ * [PORTAL-77] unable to update image on App Onboarding page
+ * [PORTAL-79] remove unwanted SDK left menu under Report-sample dashboard
+ * [PORTAL-80] remove ZIP file in microservice initialization
+ * [PORTAL-82] unable to pick Role in Widget onboarding for assigned app
+ * [PORTAL-85] unable to save App onboarding on "name space" field
+ * [PORTAL-86] Remove internal att.com usages from tests and other files
+ * [PORTAL-91] Search is not working in Widget Onboarding
+ * [PORTAL-93] Unable to assign roles to users in Rackspace env
+ * [PORTAL-99] portal-master-release-version-java-daily job is failing
diff --git a/docs/release-notes/index.rst b/docs/release-notes/index.rst
new file mode 100644
index 0000000..dcf4ef2
--- /dev/null
+++ b/docs/release-notes/index.rst
@@ -0,0 +1,39 @@
+.. 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.
+
+
+Portal Platform Release Notes
+=============================
+
+.. note::
+ * Portal SDK - Digital Experience Control/UI Upgrade.
+ * Ability for admin to use notification and act on it w/o copy/paste, e.g. hyperlink to target function with context transfer.
+ * Detailed new features are described in Jira with the IDs listed below.
+ * Defects listed below are fixed as part of this release.
+
+
+
+Version: 1.3.0
+--------------
+
+:Release Date: 16 November 2017
+
+.. toctree::
+ :maxdepth: 1
+
+ new-features.rst
+ bug-fixes.rst
+ known-issues.rst
+
+**Security Issues**
+
+**Upgrade Notes**
+
+**Deprecation Notes**
+
+**Other**
+
+===========
+
+End of Release Notes
diff --git a/docs/release-notes/known-issues.rst b/docs/release-notes/known-issues.rst
new file mode 100644
index 0000000..40299d2
--- /dev/null
+++ b/docs/release-notes/known-issues.rst
@@ -0,0 +1,17 @@
+ .. This work is licensed under a Creative Commons Attribution 4.0 International License.
+
+Known Issues
+------------
+
+ONAP PORTAL Framework items for: (Last Updated: 16 November 2017)
+
+* **Version**: Amsterdam Release
+* **Release Date**: 16 November 2017
+* **Description**: R1
+
+Issues
+^^^^^^
+
+* PORTAL-140 Portal role synch error with partner apps
+* The issue "Portal-137 Enhance Authentication" is fixed in Portal and in its SDK. The Portal team recommend partnering apps like Policy, VID, AAI, SDC to upgrade to SDK's 1.3.2 or latest version to address the login vulnerability.
+
diff --git a/docs/release-notes/new-features.rst b/docs/release-notes/new-features.rst
new file mode 100644
index 0000000..f9143ae
--- /dev/null
+++ b/docs/release-notes/new-features.rst
@@ -0,0 +1,56 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+
+New Features
+------------
+
+ONAP PORTAL Framework items for: (Last Updated: 16 November 2017)
+
+* **Version**: Amsterdam Release
+* **Release Date**: 16 November 2017
+* **Description**: R1
+
+.. contents::
+ :depth: 2
+
+Epic
+^^^^
+
+* [PORTAL-27] Digital Experience Control/UI upgrade
+* [PORTAL-28] Portal Notification Enhancement
+
+User Story
+^^^^^^^^^^
+
+* [PORTAL-100] create a documentation Template in ReadTheDocs
+* [PORTAL-21] 1710 feature - centralized user role management
+* [PORTAL-24] 1710 feature - enhanced notification module
+* [PORTAL-26] 1710 feature - enhance Look & Feel GUI
+* [PORTAL-29] 1710 feature - enhanced notification module
+* [PORTAL-53] functional test case integration
+* [PORTAL-92] Independent Versioning and Release Process
+* [PORTAL-105] create doc folder/directory
+* [PORTAL-123] CSIT Jenkins jobs for Portal-SDK
+* [PORTAL-78] Portal's SDK Demo App test case
+* [PORTAL-98] CSIT Jenkins jobs
+* [PORTAL-103] enhanced notification ticket source for ONAP
+* [PORTAL-104] replace mysql DB connector with mariaDB in ONAP
+* [PORTAL-106] update Onboarding DB script - continue
+* [PORTAL-109] Update Docker version to 1.3 for Portal images
+* [PORTAL-110] Centralized Role management prep step1
+* [PORTAL-112] Remove old jenkins jobs that are not planned to fix
+* [PORTAL-126] Remove DMaaP BC UI app from Portal deployment
+* [PORTAL-130] Change FQDN for portal and associated GUI's to use onap.org url
+* [PORTAL-134] Release 1.3.0 for Portal repo
+* [PORTAL-20] remove mariadb client reference from be-common pom
+* [PORTAL-39] Remove MojoHaus Maven plug-in from pom file
+* [PORTAL-50] JUnit test coverage enabling in ONAP Portal code for Sonar scans.
+* [PORTAL-52] remove etc.zip file from repo and replace with folder structure of all properties files.
+* [PORTAL-54] Javadocs generation jenkins job needs to be fixed
+* [PORTAL-55] From main portal, provide an menu for CLI download
+* [PORTAL-61] 1710 feature - enhanced notification module
+* [PORTAL-70] update Portal wiki documetation for 1.1.0 release
+* [PORTAL-84] update Onboarding DB script
+* [PORTAL-89] Portal/SDK release 1.3.0
+* [PORTAL-90] new ONAP License.txt approved change by LF council
+* [PORTAL-95] Docker container start timeout too short for database
+
diff --git a/docs/tutorials/index.rst b/docs/tutorials/index.rst
index d730b82..5af6800 100644
--- a/docs/tutorials/index.rst
+++ b/docs/tutorials/index.rst
@@ -5,7 +5,7 @@
.. toctree::
:maxdepth: 2
-
+
portal-sdk/index
diff --git a/docs/tutorials/portal-sdk/architecture.rst b/docs/tutorials/portal-sdk/architecture.rst
index ba97157..203fc17 100644
--- a/docs/tutorials/portal-sdk/architecture.rst
+++ b/docs/tutorials/portal-sdk/architecture.rst
@@ -1,18 +1,4 @@
Application architecture
============================================
-
-When building the tutorial app with the ONAP Portal SDK, you'll be working with:
-
-1. `Spring Framework`_: You'll build a Spring Framework controller, which will handle your database queries and provide the top-level access to your application.
-2. AngularJS_: Support for AngularJS is built into the SDK. AngularJS is a popular and powerful framework that lets developers create dynamic client-side web applications. E.g. Gmail. Unlike server-side frameworks like PHP, almost all GUI interaction is handled by the client in JavaScript.
-3. `Bootstrap UI`_: Bootstrap is a front-end framework that makes designing web pages easier by incorporating extensive CSS.
-4. `Google Charts`_: Google charts makes including graphs in your applications easier.
-5. Gridster_: Although not covered in this tutorial, the ONAP Portal SDK also comes with built-in support for the Gridster JavaScript library, which lets you produce pages with draggable and resizeable layouts from elements spanning multiple columns.
-
-Although the learning curve may seem daunting, the most difficult aspect of creating ONAP Portal SDK web applications is understanding how all the pieces fit together. The various frameworks themselves are not hard to understand. However, how they interact with one another isn't always obvious. If you have a basic grasp of Java, JavaScript, HTML, and CSS, you'll have no trouble.
-
-.. _Spring Framework: https://projects.spring.io/spring-framework/
-.. _AngularJS: https://angularjs.org/
-.. _Bootstrap UI: http://www.bootstrap-ui.com/
-.. _Google Charts: https://developers.google.com/chart/
-.. _Gridster: http://dsmorse.github.io/gridster.js/
+
+ONAP Portal Architecture:
diff --git a/docs/tutorials/portal-sdk/creating.rst b/docs/tutorials/portal-sdk/creating.rst
index 0285846..333a45e 100644
--- a/docs/tutorials/portal-sdk/creating.rst
+++ b/docs/tutorials/portal-sdk/creating.rst
@@ -1,6 +1,6 @@
Creating a new application
==========================
-
+
Our tutorial application will consist of two parts:
1. Java code: We'll create a controller (in reality you might need to create many, depending on how complex your application is) that will handle many of our web requests. Most importantly, it will handle the top-level access request.
diff --git a/docs/tutorials/portal-sdk/dynamic-content.rst b/docs/tutorials/portal-sdk/dynamic-content.rst
index aa8c067..7e749cb 100644
--- a/docs/tutorials/portal-sdk/dynamic-content.rst
+++ b/docs/tutorials/portal-sdk/dynamic-content.rst
@@ -1,6 +1,6 @@
Dynamic content
===============
-
+
Now, we'll make our new application dynamic by allowing user interaction. To do this, we'll let the user select between "download" and "upload" charts with an HTML select/option menu.
Creating the Angularized select/option menu
diff --git a/docs/tutorials/portal-sdk/google-charts.rst b/docs/tutorials/portal-sdk/google-charts.rst
index 859849c..e67dd89 100644
--- a/docs/tutorials/portal-sdk/google-charts.rst
+++ b/docs/tutorials/portal-sdk/google-charts.rst
@@ -1,6 +1,6 @@
Google Charts
=============
-
+
Now that we've established our database connection and can request and retrieve data from our tables, we can focus on our web application.
Installing
diff --git a/docs/tutorials/portal-sdk/img/addmenu.png b/docs/tutorials/portal-sdk/img/addmenu.png
index a7093d1..73fa270 100755
--- a/docs/tutorials/portal-sdk/img/addmenu.png
+++ b/docs/tutorials/portal-sdk/img/addmenu.png
Binary files differ
diff --git a/docs/tutorials/portal-sdk/img/menus.png b/docs/tutorials/portal-sdk/img/menus.png
index bd05d5c..a5d5d6e 100644
--- a/docs/tutorials/portal-sdk/img/menus.png
+++ b/docs/tutorials/portal-sdk/img/menus.png
Binary files differ
diff --git a/docs/tutorials/portal-sdk/img/newmenuitem.png b/docs/tutorials/portal-sdk/img/newmenuitem.png
index b25314f..8781e8e 100644
--- a/docs/tutorials/portal-sdk/img/newmenuitem.png
+++ b/docs/tutorials/portal-sdk/img/newmenuitem.png
Binary files differ
diff --git a/docs/tutorials/portal-sdk/index.rst b/docs/tutorials/portal-sdk/index.rst
index b37855c..023fc62 100644
--- a/docs/tutorials/portal-sdk/index.rst
+++ b/docs/tutorials/portal-sdk/index.rst
@@ -5,7 +5,7 @@
Building ONAP Portal SDK Web Applications
=========================================
-
+
.. toctree::
:maxdepth: 6
:caption: Contents:
diff --git a/docs/tutorials/portal-sdk/intro.rst b/docs/tutorials/portal-sdk/intro.rst
index 9a117bf..fa11b33 100644
--- a/docs/tutorials/portal-sdk/intro.rst
+++ b/docs/tutorials/portal-sdk/intro.rst
@@ -1,6 +1,6 @@
Introduction
============
-
+
In this tutorial you'll be creating your own ONAP Portal SDK web application, starting with pulling the source code directly from ONAP's Portal SDK Gerrit repository.
Your new web application will use the various frameworks that are included in the Portal SDK to display a simple but interactive application page that will let a user choose from two different charts to display.
diff --git a/docs/tutorials/portal-sdk/pulling-db-data.rst b/docs/tutorials/portal-sdk/pulling-db-data.rst
index 4efeff5..dc377bc 100644
--- a/docs/tutorials/portal-sdk/pulling-db-data.rst
+++ b/docs/tutorials/portal-sdk/pulling-db-data.rst
@@ -1,6 +1,6 @@
Pulling DB data
===============
-
+
In the :ref:`connectionjava` section, we set up a connection to the :code:`ecomp_sdk` database. Now, we going to use our AngularJS controller (:code:`controller.js`) and data service (:code:`data-service.js`) to make an HTTP request to our Spring controller (:code:`MyAppController.java`), wait for the results, and map them into a Google Chart.
AngularJS Promises
diff --git a/docs/tutorials/portal-sdk/setting-up-db.rst b/docs/tutorials/portal-sdk/setting-up-db.rst
index 3e73fa1..5d89ea8 100644
--- a/docs/tutorials/portal-sdk/setting-up-db.rst
+++ b/docs/tutorials/portal-sdk/setting-up-db.rst
@@ -1,6 +1,6 @@
Setting up a database connection
================================
-
+
Most applications will need access to a database. In this tutorial, we'll connect to a database in order to pull data for displaying in a Google chart.
Injecting data
diff --git a/docs/tutorials/portal-sdk/setting-up.rst b/docs/tutorials/portal-sdk/setting-up.rst
index 6c0ece5..af50a91 100644
--- a/docs/tutorials/portal-sdk/setting-up.rst
+++ b/docs/tutorials/portal-sdk/setting-up.rst
@@ -1,6 +1,6 @@
Setting up
==========
-
+
Dependencies
------------
diff --git a/docs/tutorials/portal-sdk/wrapping-up.rst b/docs/tutorials/portal-sdk/wrapping-up.rst
index 72a9482..fc99799 100644
--- a/docs/tutorials/portal-sdk/wrapping-up.rst
+++ b/docs/tutorials/portal-sdk/wrapping-up.rst
@@ -1,4 +1,4 @@
Wrapping up
===========
-
+
AngularJS and the ONAP Portal SDK are powerful tools, and we've only seen the bare minimum of their capabilities in this tutorial. Hopefully, you now have enough information to jump in and start building your own Portal apps.
diff --git a/docs/tutorials/portal-sdk/your-angularjs-app.rst b/docs/tutorials/portal-sdk/your-angularjs-app.rst
index f97d693..e728b92 100644
--- a/docs/tutorials/portal-sdk/your-angularjs-app.rst
+++ b/docs/tutorials/portal-sdk/your-angularjs-app.rst
@@ -1,6 +1,6 @@
Your AngularJS app
=========================
-
+
Now that we've established a database connection, it's time to work on the web side of your app. To start, we'll create some files in :code:`sdk/ecomp-sdk/epsdk-app-os/src/main/webapp/app/fusion/scripts/myapp/myfirstpage`.
myfirstpage.html
