summaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
authorRich Bennett <rb2745@att.com>2018-06-14 00:15:29 -0400
committerRich Bennett <rb2745@att.com>2018-06-14 00:21:52 -0400
commit259bf4d16dd04ce6ad4537ed1616be6397215523 (patch)
treef29cdeecb5a70097f5d6782badfed5e9dbafe67d /docs
parent3b9974fed12bd16bf5abe9ac5598abf7e1d4c210 (diff)
Correct references and add release notes
Correct gerrit URL, architecture, and API refrences Position Use Case Diagrams in Developer Section Change-Id: I149aad66844e343697771a7a3e4db14ff3a3daea Issue-ID: DOC-278 Signed-off-by: Rich Bennett <rb2745@att.com>
Diffstat (limited to 'docs')
-rw-r--r--docs/guides/onap-developer/apiref/index.rst2
-rw-r--r--docs/guides/onap-developer/architecture/references.rst2
-rw-r--r--docs/guides/onap-developer/developing/index.rst3
-rw-r--r--docs/guides/onap-developer/index.rst5
-rw-r--r--docs/guides/onap-developer/settingup/onap_individual.rst9
-rw-r--r--docs/guides/onap-developer/use-cases/index.rst (renamed from docs/use-cases/index.rst)5
-rw-r--r--docs/guides/onap-developer/use-cases/vfw.rst (renamed from docs/use-cases/vfw.rst)4
-rw-r--r--docs/guides/onap-user/index.rst4
-rw-r--r--docs/guides/onap-user/vnfcertifier.rst2
-rw-r--r--docs/index.rst7
-rw-r--r--docs/release-notes.rst16
11 files changed, 38 insertions, 21 deletions
diff --git a/docs/guides/onap-developer/apiref/index.rst b/docs/guides/onap-developer/apiref/index.rst
index 53b075b8f..f1a1171fd 100644
--- a/docs/guides/onap-developer/apiref/index.rst
+++ b/docs/guides/onap-developer/apiref/index.rst
@@ -47,7 +47,7 @@ Common Services
:titlesonly:
AAI - Active and Available Inventory <../../../submodules/aai/aai-common.git/docs/AAI REST API Documentation/AAIRESTAPI_AMSTERDAM.rst>
- AAI ESR <../../../submodules/submodules/aai/esr-server.git/docs/offeredapis.rst>
+ AAI ESR <../../../submodules/aai/esr-server.git/docs/offeredapis.rst>
DMAAP MR - Data Management as a Platform (Message Router) <../../../submodules/dmaap/messagerouter/messageservice.git/docs/offeredapis/offeredapis.rst>
ExtAPI- External API/NBI - NorthBound API <../../../submodules/externalapi/nbi.git/docs/offeredapis/index.rst>
Modeling Parsers <../../../submodules/modeling/toscaparsers.git/docs/offeredapis.rst>
diff --git a/docs/guides/onap-developer/architecture/references.rst b/docs/guides/onap-developer/architecture/references.rst
index beaed5cde..520f8f988 100644
--- a/docs/guides/onap-developer/architecture/references.rst
+++ b/docs/guides/onap-developer/architecture/references.rst
@@ -31,7 +31,7 @@ User Interfaces
APPC CDT - Application Controller Design Tool <../../../submodules/appc.git/docs/APPC CDT Guide/APPC CDT Guide.rst>
CLAMP - Closed Loop Automation Platform <../../../submodules/clamp.git/docs/architecture.rst>
CLI - Command Line Interface <../../../submodules/cli.git/docs/architecture.rst>
- PORTAL
+ PORTAL <../../../submodules/portal.git/docs/platform/architecture.rst>
SDC - Service Design and Creation <../../../submodules/sdc.git/docs/architecture.rst>
UUI- Usecase UI <../../../submodules/usecase-ui.git/docs/platform/architecture.rst>
VID - Virtual Infrastructure Deployment <../../../submodules/vid.git/docs/architecture.rst>
diff --git a/docs/guides/onap-developer/developing/index.rst b/docs/guides/onap-developer/developing/index.rst
index a7877d449..a34afa908 100644
--- a/docs/guides/onap-developer/developing/index.rst
+++ b/docs/guides/onap-developer/developing/index.rst
@@ -139,8 +139,9 @@ Integration
* ONAP Amsterdam release content is specified within a list of project
artifact versions available in the form of
a :ref:`manifest<doc-release-manifest>`.
+
* To install the whole ONAP (from a complete demo solution perspective)
- refer to :ref:`Setting Up ONAP <demo-installing-running-onap>`.
+ refer to :ref:`Setting Up ONAP <demo-installing-running-onap-requirements>`.
Logging Analytics
-----------------
diff --git a/docs/guides/onap-developer/index.rst b/docs/guides/onap-developer/index.rst
index 8ef2c0a10..8ed4eaee6 100644
--- a/docs/guides/onap-developer/index.rst
+++ b/docs/guides/onap-developer/index.rst
@@ -4,8 +4,8 @@
.. _onap_developer_guides:
-ONAP Developer Guides
-=====================
+Developer Guides
+================
The following guides are provided for developers who want to
understanding or contribute to the ONAP open source.
@@ -18,4 +18,5 @@ understanding or contribute to the ONAP open source.
developing/index
how-to-use-docs/index
apiref/index
+ use-cases/index
diff --git a/docs/guides/onap-developer/settingup/onap_individual.rst b/docs/guides/onap-developer/settingup/onap_individual.rst
index faac85ad7..8bd92d8a9 100644
--- a/docs/guides/onap-developer/settingup/onap_individual.rst
+++ b/docs/guides/onap-developer/settingup/onap_individual.rst
@@ -23,8 +23,13 @@ developers who desire to focus their attention on a few components and who
have a deep understanding of dependencies between components.
This type of installation is not recommended to fully install ONAP.
-* The list of ports used by default within ONAP is documented in `ONAP Service List <https://wiki.onap.org/display/DW/ONAP+Services+List>`_.
-* The ONAP Source Code is available through Gerrit at https://gerrit.onap.org or Git at https://git.onap.org/.
+* The list of ports used by default within ONAP is documented
+ in `ONAP Service List <https://wiki.onap.org/display/DW/ONAP+Services+List>`_.
+
+* The ONAP Source Code is available through Gerrit
+ at https://gerrit.onap.org/r/#/admin/projects or Git at https://git.onap.org/.
+
* ONAP is packaged within Docker and can be dowloaded from Docker Hub at https://hub.docker.com/r/onap.
+
* ONAP Docker releases are specified by a list of project artifact versions
in a :ref:`manifest<doc-release-manifest>`.
diff --git a/docs/use-cases/index.rst b/docs/guides/onap-developer/use-cases/index.rst
index cc076b1c5..d9dc0d202 100644
--- a/docs/use-cases/index.rst
+++ b/docs/guides/onap-developer/use-cases/index.rst
@@ -2,8 +2,8 @@
.. http://creativecommons.org/licenses/by/4.0
.. Copyright 2017 AT&T Intellectual Property. All rights reserved.
-ONAP Use Cases
-==============
+Use Cases
+=========
Example uses case descriptions and sequence diagrams illustrating
interactions between platform components.
@@ -12,3 +12,4 @@ interactions between platform components.
:maxdepth: 1
vfw.rst
+ volte.rst
diff --git a/docs/use-cases/vfw.rst b/docs/guides/onap-developer/use-cases/vfw.rst
index 7c230ca0d..2f83102a9 100644
--- a/docs/use-cases/vfw.rst
+++ b/docs/guides/onap-developer/use-cases/vfw.rst
@@ -2,8 +2,8 @@
.. http://creativecommons.org/licenses/by/4.0
.. Copyright 2017 AT&T Intellectual Property. All rights reserved.
-vFirewall
-=========
+vFirewall Use Case
+==================
Description
-----------
diff --git a/docs/guides/onap-user/index.rst b/docs/guides/onap-user/index.rst
index 189d34fd3..24cfcf134 100644
--- a/docs/guides/onap-user/index.rst
+++ b/docs/guides/onap-user/index.rst
@@ -4,8 +4,8 @@
-ONAP User Guides
-================
+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.
diff --git a/docs/guides/onap-user/vnfcertifier.rst b/docs/guides/onap-user/vnfcertifier.rst
index 76a96be4f..4387d0c0c 100644
--- a/docs/guides/onap-user/vnfcertifier.rst
+++ b/docs/guides/onap-user/vnfcertifier.rst
@@ -4,6 +4,6 @@ VNF Certifier
==============
.. toctree::
- :maxdepth:2
+ :maxdepth: 2
../../../submodules/vvp/documentation.git/docs/index.rst
diff --git a/docs/index.rst b/docs/index.rst
index fbcb897a9..a882caf4c 100644
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -1,4 +1,6 @@
-.. 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.
.. _master_index:
@@ -11,9 +13,6 @@ ONAP Documentation
release/index
guides/onap-developer/index
guides/onap-user/index
- use-cases/index
-
-
Index and Search
================
diff --git a/docs/release-notes.rst b/docs/release-notes.rst
index fbc9e7f3f..8b9cc2c9a 100644
--- a/docs/release-notes.rst
+++ b/docs/release-notes.rst
@@ -1,4 +1,3 @@
-
.. 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.
@@ -11,14 +10,25 @@ Release Notes
Version: 2.0.0
--------------
-:Release Date: 2018-07-06
+:Release Date: 2018-06-07
**New Features**
+* Created a beijing branch referencing all repos providing documentation
+ for the beijing release.
-**Other**
+* Added tox environments and documentation for linkcheck and spellcheck buiders.
+
+* Verify jobs now include the html build in the archived log to make it
+ easier to review changes prior to merge.
+* Provided guidelines for document "code reviews" and
+ end of release work with multiple branches.
+
+* Added a template for a Virtual Netework Function
+
+**Other**
Version: 1.0.0
--------------