diff options
author | Christopher Lott (cl778h) <clott@research.att.com> | 2017-11-06 15:13:17 -0500 |
---|---|---|
committer | Chris Lott <cl778h@att.com> | 2017-11-06 20:15:03 +0000 |
commit | 881d219f34ba287e24ce74402e2c56dcbdd49991 (patch) | |
tree | c105a017df754975c2cf352558588b847a4e7970 /docs/tutorials | |
parent | ff3619ea67dd2f008b2378f59511f3a22ce23177 (diff) |
Release notes for R1/Amsterdam/1.3.0
Issue: PORTAL-141
Change-Id: I15540167d1205230515c7cb4e8030314f4bd6a3b
Signed-off-by: Christopher Lott (cl778h) <clott@research.att.com>
Diffstat (limited to 'docs/tutorials')
-rw-r--r-- | docs/tutorials/index.rst | 2 | ||||
-rw-r--r-- | docs/tutorials/portal-sdk/architecture.rst | 18 | ||||
-rw-r--r-- | docs/tutorials/portal-sdk/creating.rst | 2 | ||||
-rw-r--r-- | docs/tutorials/portal-sdk/dynamic-content.rst | 2 | ||||
-rw-r--r-- | docs/tutorials/portal-sdk/google-charts.rst | 2 | ||||
-rwxr-xr-x | docs/tutorials/portal-sdk/img/addmenu.png | bin | 9010 -> 15918 bytes | |||
-rw-r--r-- | docs/tutorials/portal-sdk/img/menus.png | bin | 147244 -> 36258 bytes | |||
-rw-r--r-- | docs/tutorials/portal-sdk/img/newmenuitem.png | bin | 78406 -> 25047 bytes | |||
-rw-r--r-- | docs/tutorials/portal-sdk/index.rst | 2 | ||||
-rw-r--r-- | docs/tutorials/portal-sdk/intro.rst | 2 | ||||
-rw-r--r-- | docs/tutorials/portal-sdk/pulling-db-data.rst | 2 | ||||
-rw-r--r-- | docs/tutorials/portal-sdk/setting-up-db.rst | 2 | ||||
-rw-r--r-- | docs/tutorials/portal-sdk/setting-up.rst | 2 | ||||
-rw-r--r-- | docs/tutorials/portal-sdk/wrapping-up.rst | 2 | ||||
-rw-r--r-- | docs/tutorials/portal-sdk/your-angularjs-app.rst | 2 |
15 files changed, 13 insertions, 27 deletions
diff --git a/docs/tutorials/index.rst b/docs/tutorials/index.rst index d730b82a..5af68007 100644 --- a/docs/tutorials/index.rst +++ b/docs/tutorials/index.rst @@ -5,7 +5,7 @@ Portal: Tutorials .. toctree:: :maxdepth: 2 - + portal-sdk/index diff --git a/docs/tutorials/portal-sdk/architecture.rst b/docs/tutorials/portal-sdk/architecture.rst index ba97157b..203fc177 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 0285846c..333a45e7 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 aa8c067a..7e749cb2 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 859849c5..e67dd89c 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 Binary files differindex a7093d10..73fa2707 100755 --- a/docs/tutorials/portal-sdk/img/addmenu.png +++ b/docs/tutorials/portal-sdk/img/addmenu.png diff --git a/docs/tutorials/portal-sdk/img/menus.png b/docs/tutorials/portal-sdk/img/menus.png Binary files differindex bd05d5cd..a5d5d6ed 100644 --- a/docs/tutorials/portal-sdk/img/menus.png +++ b/docs/tutorials/portal-sdk/img/menus.png diff --git a/docs/tutorials/portal-sdk/img/newmenuitem.png b/docs/tutorials/portal-sdk/img/newmenuitem.png Binary files differindex b25314f3..8781e8e2 100644 --- a/docs/tutorials/portal-sdk/img/newmenuitem.png +++ b/docs/tutorials/portal-sdk/img/newmenuitem.png diff --git a/docs/tutorials/portal-sdk/index.rst b/docs/tutorials/portal-sdk/index.rst index b37855cc..023fc622 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 9a117bf7..fa11b332 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 4efeff56..dc377bc0 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 3e73fa17..5d89ea86 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 6c0ece54..af50a912 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 72a9482e..fc99799a 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 f97d6938..e728b925 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 |