address comments OPTFRA-242 and edit release notes

Issue-ID: OPTFRA-242

Change-Id: I41a089f8c22936eb66d75fa8a5acdf21fa173700
Signed-off-by: fsandoval <frank.sandoval@oamtechnologies.com>

diff --git a/docs/sections/homingspecification.rst b/docs/sections/homingspecification.rst
index 9e10730..03edcbc 100644 (file)
--- a/docs/sections/homingspecification.rst
+++ b/docs/sections/homingspecification.rst
@@ -376,8 +376,9 @@ region.
 
 **Examples**
 
-**``Service Candidate``**
-.. code:: json
+**Service Candidate**
+
+.. code-block:: json
 
     {
         "candidate_id": "1ac71fb8-ad43-4e16-9459-c3f372b8236d",
@@ -400,8 +401,9 @@ region.
         "physical_location_id": "DLLSTX9A"
     }
 
-**``Cloud Candidate``**
-.. code:: json
+**Cloud Candidate**
+
+.. code-block:: json
 
     {
         "candidate_id": "NYCNY55",
@@ -775,7 +777,7 @@ Constraint Types
 +-------------------------------------------+--------------------------+
 | ``vim_fit``                               | Constraint that checks if|
 |                                           | the incoming demand fits |
-|                                           | the VIM instance.        |         |
+|                                           | the VIM instance.        |
 +-------------------------------------------+--------------------------+
 | ``license`` (Deferred)                    | License availability     |
 |                                           | constraint.              |
@@ -832,13 +834,13 @@ CPU-Pinning, NUMA), features supported by the services, etc.
 
 **Schema**
 
-+------------+---------------------------------------------------------+
-| Property   | Value                                                   |
-+============+=========================================================+
-| ``evaluate | Opaque dictionary of attribute name and value pairs.    |
-| ``         | Values must be strings or numbers. Encoded and sent to  |
-|            | the service provider via a plugin.                      |
-+------------+---------------------------------------------------------+
++--------------+---------------------------------------------------------+
+| Property     | Value                                                   |
++==============+=========================================================+
+| ``evaluate`` | Opaque dictionary of attribute name and value pairs.    |
+|              | Values must be strings or numbers. Encoded and sent to  |
+|              | the service provider via a plugin.                      |
++--------------+---------------------------------------------------------+
 
 *Note: Attribute values are not detected/parsed as thresholds by the
 Homing framework. Such interpretations and evaluations are inventory
@@ -1038,15 +1040,15 @@ being constrained.
 
 **Schema**
 
-+-------------+--------------------------------------------------------+
-| Property    | Value                                                  |
-+=============+========================================================+
-| ``qualifier | Zone qualifier. One of ``same`` or ``different``.      |
-| ``          |                                                        |
-+-------------+--------------------------------------------------------+
-| ``category` | Zone category. One of ``disaster``, ``region``,        |
-| `           | ``complex``, ``time``, or ``maintenance``.             |
-+-------------+--------------------------------------------------------+
++---------------+--------------------------------------------------------+
+| Property      | Value                                                  |
++===============+========================================================+
+| ``qualifier`` | Zone qualifier. One of ``same`` or ``different``.      |
+|               |                                                        |
++---------------+--------------------------------------------------------+
+| ``category``  | Zone category. One of ``disaster``, ``region``,        |
+|               | ``complex``, ``time``, or ``maintenance``.             |
++---------------+--------------------------------------------------------+
 
 For example, to place two demands in different disaster zones:
 
@@ -1094,12 +1096,12 @@ supported by the services, etc.
 
 **Schema**
 
-+-------------+--------------------------------------------------------+
-| Property    | Value                                                  |
-+=============+========================================================+
-| ``evaluate  | List of flavorLabel, flavorProperties of each VM of the|
-| ``          | VNF demand.                                            |
-+-------------+--------------------------------------------------------+
++---------------+--------------------------------------------------------+
+| Property      | Value                                                  |
++===============+========================================================+
+| ``evaluate``  | List of flavorLabel, flavorProperties of each VM of the|
+|               | VNF demand.                                            |
++---------------+--------------------------------------------------------+
 
 .. code:: yaml
 
@@ -1127,7 +1129,9 @@ supported by the services, etc.
 
 **Example**
 
-.. code:: json
+
+.. code-block:: json
+
     {
         "hpa_constraint":{
             "type":"hpa",
@@ -1222,15 +1226,15 @@ settings.
 
 **Schema**
 
-+--------------+--------------------------------------------------------+
-| Property     | Value                                                  |
-+==============+========================================================+
-| ``controller | Name of a vim controller. (e.g., multicloud)           |
-+--------------+--------------------------------------------------------+
-| ``request``  | Opaque dictionary of key/value pairs. Values           |
-|              | must be strings or numbers. Encoded and sent           |
-|              | to the vim controller via a plugin.                    |
-+--------------+--------------------------------------------------------+
++----------------+--------------------------------------------------------+
+| Property       | Value                                                  |
++================+========================================================+
+| ``controller`` | Name of a vim controller. (e.g., multicloud)           |
++----------------+--------------------------------------------------------+
+| ``request``    | Opaque dictionary of key/value pairs. Values           |
+|                | must be strings or numbers. Encoded and sent           |
+|                | to the vim controller via a plugin.                    |
++----------------+--------------------------------------------------------+
 
 .. code:: yaml
 
@@ -1249,7 +1253,9 @@ settings.
    object defined through policy, so it is not restricted to this format. In
    ONAP Beijing release MultiCloud supports the check_vim_capacity using the
    following grammar.
-   .. code:: json
+   
+   .. code-block:: json
+   
        {
          "request":{
            "vCPU":10,
@@ -1408,26 +1414,26 @@ environment.
 
 **Schema**
 
-+------------+---------------------------------------------------------+
-| Property   | Value                                                   |
-+============+=========================================================+
-| ``specific | Indicates the kind of specification being provided in   |
-| ation``    | the properties. Must be ``heat``. Future values may     |
-|            | include ``tosca``, ``Homing``, etc.                     |
-+------------+---------------------------------------------------------+
-| ``template | For specifications of type ``heat``, a single stack in  |
-| ``         | OpenStack Heat Orchestration Template (HOT) format.     |
-|            | Stacks may be expressed as a URI reference or a string  |
-|            | of well-formed YAML/JSON. Templates are validated by    |
-|            | the Heat service configured for use by HAS. Nested      |
-|            | stack references are unsupported.                       |
-+------------+---------------------------------------------------------+
-| ``environm | For specifications of type ``heat``, an optional Heat   |
-| ent``      | environment. Environments may be expressed as a URI     |
-| (Optional) | reference or a string of well-formed YAML/JSON.         |
-|            | Environments are validated by the Heat service          |
-|            | configured for use by Homing.                           |
-+------------+---------------------------------------------------------+
++-------------------+---------------------------------------------------------+
+| Property          | Value                                                   |
++===================+=========================================================+
+| ``specification`` | Indicates the kind of specification being provided in   |
+|                   | the properties. Must be ``heat``. Future values may     |
+|                   | include ``tosca``, ``Homing``, etc.                     |
++-------------------+---------------------------------------------------------+
+| ``template``      | For specifications of type ``heat``, a single stack in  |
+|                   | OpenStack Heat Orchestration Template (HOT) format.     |
+|                   | Stacks may be expressed as a URI reference or a string  |
+|                   | of well-formed YAML/JSON. Templates are validated by    |
+|                   | the Heat service configured for use by HAS. Nested      |
+|                   | stack references are unsupported.                       |
++-------------------+---------------------------------------------------------+
+| ``environment``   | For specifications of type ``heat``, an optional Heat   |
+|                   | environment. Environments may be expressed as a URI     |
+| (Optional)        | reference or a string of well-formed YAML/JSON.         |
+|                   | Environments are validated by the Heat service          |
+|                   | configured for use by Homing.                           |
++-------------------+---------------------------------------------------------+
 
 .. code:: yaml
 

diff --git a/docs/sections/installation.rst b/docs/sections/installation.rst
index 65029c6..f25aea3 100644 (file)
--- a/docs/sections/installation.rst
+++ b/docs/sections/installation.rst
@@ -6,6 +6,9 @@ Installation
 Installing from the Source Code
 ------------------------------------
 Get HAS seed code from the Linux Foundation Projects page
+
+.. code-block:: bash
+
     $ git clone https://gerrit.onap.org/r/optf/has
 
 Use python virtual environment (https://virtualenv.pypa.io/en/stable/) to create and manage libraries and dependencies for HAS project.

diff --git a/docs/sections/offeredapis.rst b/docs/sections/offeredapis.rst
index ed215d3..7ef44e9 100644 (file)
--- a/docs/sections/offeredapis.rst
+++ b/docs/sections/offeredapis.rst
@@ -15,7 +15,7 @@ This document describes the Homing API, provided by the Homing and Allocation se
 It is a work in progress and subject to frequent revision.
 
 General API Information
-------------------
+-------------------------
 
 Authenticated calls that target a known URI but that use an HTTP method
 the implementation does not support return a 405 Method Not Allowed

diff --git a/docs/sections/release-notes.rst b/docs/sections/release-notes.rst
index 32ea3a0..ec2358e 100644 (file)
--- a/docs/sections/release-notes.rst
+++ b/docs/sections/release-notes.rst
@@ -6,37 +6,66 @@
 Release Notes
 =============
 
-Release Date
-------------
-2018-05-24
 
+Version: 1.1.1
+--------------
+
+:Release Date: 2018-06-07 (Beijing Release)
+
+**New Features**
+-----------------
+
+The ONAP Optimization Framework (OOF) is new in Beijing. A summary of features incldues: 
 
-New Features
-------------
 * Baseline HAS functionality
-* Integration with OOF OSDF, AAI, and Multi-Cloud
+    * support for VCPE use case
+    * support for HPA (Hardware Platform Awareness)
+* Integration with OOF OSDF, SO, Policy, AAI, and Multi-Cloud
 * Platform Maturity Level 1
-* ~50%+ unit test coverage
+    * ~50%+ unit test coverage
+    
+The Beijing release for OOF delivered the following Epics. 
+
+    * [OPTFRA-2] - On-boarding and Stabilization of the OOF seed code
+
+    * [OPTFRA-6] - Integrate OOF with other ONAP components
+
+    * [OPTFRA-7] - Integration with R2 Use Cases [HPA, Change Management, Scaling]
+
+    * [OPTFRA-20] - OOF Adapters for Retrieving and Resolving Policies
+
+    * [OPTFRA-21] - OOF Packaging
+
+    * [OPTFRA-28] - OOF Adapters for Beijing Release (Policy, SDC, A&AI, Multi Cloud, etc.)
+
+    * [OPTFRA-29] - Policies and Specifications for Initial Applications [Change Management, HPA]
+
+    * [OPTFRA-32] - Platform Maturity Requirements for Beijing release
+
+    * [OPTFRA-33] - OOF Support for HPA
+
+    * [OPTFRA-105] - All Documentation Related User Stories and Tasks
+
 
 Bug Fixes
 ---------
-None  
+None. Initial release R2 Beijing. No previous versions  
 
 Known Issues
 ------------
-None
+None. 
 
 Security Issues
 ---------------
-None
+None. 
 
 Upgrade Notes
 -------------
-None
+None. Initial release R2 Beijing. No previous versions  
 
 Deprecation Notes
 -----------------
-None
+None. Initial release R2 Beijing. No previous versions  
 
 Other
 -----