summaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
authorfsandoval <frank.sandoval@oamtechnologies.com>2018-05-26 18:44:43 -0600
committerfsandoval <frank.sandoval@oamtechnologies.com>2018-05-26 18:44:57 -0600
commit8d241fa5e19202ee0cf251d6281af9a2e9841deb (patch)
tree22e24c6e9986c57030831a0e652edd2d89e985ba /docs
parent23c3354245f8a9bc1d87ea3becc0f217bf10bbd7 (diff)
fix comments OPTFRA-242, edit release notes
Issue-ID: OPTFRA-242 Change-Id: I06fbf6286c6c3631a3353e49a2085501be99c6f1 Signed-off-by: fsandoval <frank.sandoval@oamtechnologies.com>
Diffstat (limited to 'docs')
-rw-r--r--docs/index.rst2
-rw-r--r--docs/sections/installation.rst3
-rw-r--r--docs/sections/offeredapis.rst2
-rw-r--r--docs/sections/release-notes.rst55
4 files changed, 47 insertions, 15 deletions
diff --git a/docs/index.rst b/docs/index.rst
index 71e290e..c3ea9da 100644
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -2,7 +2,7 @@
Optimization Framework: Optimization Service Design Framework (OSDF)
-=============================================
+=========================================================================
.. toctree::
:maxdepth: 1
diff --git a/docs/sections/installation.rst b/docs/sections/installation.rst
index fac87bf..e3a7a73 100644
--- a/docs/sections/installation.rst
+++ b/docs/sections/installation.rst
@@ -6,5 +6,8 @@ Installation
Installing from the Source Code
------------------------------------
Get code from the Linux Foundation Projects page
+
+.. code-block:: bash
+
$ git clone https://gerrit.onap.org/r/optf/osdf
diff --git a/docs/sections/offeredapis.rst b/docs/sections/offeredapis.rst
index c88bcf8..5c0f5e6 100644
--- a/docs/sections/offeredapis.rst
+++ b/docs/sections/offeredapis.rst
@@ -25,7 +25,7 @@ Request Header
+----------------+-----------+-------------------------------------------------------------------------------------------+
| Header Name | Required | Description |
+================+===========+===========================================================================================+
-| Accept | N | Determines the format of the body of the response. Valid value is “application/json” |
+| Accept | N | Determines the format of the body of the response. Valid value is “application/json” |
+----------------+-----------+-------------------------------------------------------------------------------------------+
| Authorization | Y | Supplies Basic Authentication credentials for the request. If the Authorization header is |
| | | missing, then an HTTP 400 Invalid Request response is returned. If the string supplied is |
diff --git a/docs/sections/release-notes.rst b/docs/sections/release-notes.rst
index 967433f..ec2358e 100644
--- 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
+--------------
-New Features
-------------
-* Baseline functionality
-* Integration with OOF HAS, SO, Policy and SDC
+:Release Date: 2018-06-07 (Beijing Release)
+
+**New Features**
+-----------------
+
+The ONAP Optimization Framework (OOF) is new in Beijing. A summary of features incldues:
+
+* Baseline HAS functionality
+ * 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
-----