summaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
authorRich Bennett <rb2745@att.com>2017-10-20 05:08:11 -0400
committerRich Bennett <rb2745@att.com>2017-10-20 05:11:56 -0400
commit1bf0d36bcb82b159fdc8087c51d3454832051f46 (patch)
treedd8075c525229b889befbf69e2e3eb913c57b5ce /docs
parentae746f40cfc0fa9b382ba0df42cb502242ef2b86 (diff)
Connect Guides and Release Notes to Project info
Change-Id: I48abd7f73dabba20f70b79d23a5dbe51362a406a Issue-ID: DOC-109 Signed-off-by: Rich Bennett <rb2745@att.com>
Diffstat (limited to 'docs')
-rw-r--r--docs/guides/onap-developer/architecture/index.rst36
-rw-r--r--docs/guides/onap-developer/developing/index.rst13
-rw-r--r--docs/release/index.rst7
-rw-r--r--docs/release/releaserepos.rst5
-rw-r--r--docs/release/repolist.rst80
-rw-r--r--docs/templates/collections/sdk.rst2
6 files changed, 75 insertions, 68 deletions
diff --git a/docs/guides/onap-developer/architecture/index.rst b/docs/guides/onap-developer/architecture/index.rst
index 84c93c051..5133e97c6 100644
--- a/docs/guides/onap-developer/architecture/index.rst
+++ b/docs/guides/onap-developer/architecture/index.rst
@@ -1,12 +1,16 @@
.. 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.
+
Architecture
============
.. note::
- Some high level groupings are introduced below with references to project/repo/docs/architecture.rst or similar architecture references.
- As more information is provided by each project in a docs/architecture.rst file, it will appear here. Show source to see the references
- in each grouping.
+ Some high level groupings are introduced below with references to
+ project/repo/docs/architecture.rst or similar architecture references.
+ As more information is provided by each project in a docs/architecture.rst
+ file, it will appear here. Show source to see the references in each grouping.
Models
------
@@ -46,16 +50,16 @@ Platform Components
../../../submodules/appc/deployment.git/docs/architecture.rst
../../../submodules/appc.git/docs/architecture.rst
- ../../../submodules/dcaegen2.git/docs/architecture.rst
+ DCAE - Data Collection Analytics and Events <../../../submodules/dcaegen2.git/docs/sections/architecture.rst>
../../../submodules/holmes/engine-management.git/docs/architecture.rst
- ../../../submodules/holmes/rule-management.git/docs/architecture.rst
+ Holmes <../../../submodules/holmes/rule-management.git/docs/platform/architecture.rst>
../../../submodules/policy/engine.git/docs/architecture.rst
../../../submodules/sdnc/adaptors.git/docs/architecture.rst
../../../submodules/sdnc/architecture.git/docs/architecture.rst
../../../submodules/sdnc/core.git/docs/architecture.rst
../../../submodules/sdnc/features.git/docs/architecture.rst
- ../../../submodules/sdnc/northbound.git/docs/architecture.rst
- ../../../submodules/sdnc/oam.git/docs/architecture.rst
+ SDN Northbound <../../../submodules/sdnc/northbound.git/docs/architecture.rst
+ SDN Controller OAM <../../../submodules/sdnc/oam.git/docs/architecture.rst>
../../../submodules/sdnc/parent.git/docs/architecture.rst
../../../submodules/sdnc/plugins.git/docs/architecture.rst
../../../submodules/so/libs.git/docs/architecture.rst
@@ -63,8 +67,8 @@ Platform Components
../../../submodules/vfc/lcm.git/docs/architecture.rst
../../../submodules/vfc/nfvo/lcm.git/docs/architecture.rst
-Platform Common Services
-------------------------
+Common Services
+---------------
.. toctree::
:maxdepth: 1
@@ -73,8 +77,8 @@ Platform Common Services
../../../submodules/aaf/authz.git/docs/architecture.rst
../../../submodules/aai/aai-common.git/docs/architecture.rst
../../../submodules/aai/data-router.git/docs/architecture.rst
- ../../../submodules/aai/esr-gui.git/docs/architecture.rst
- ../../../submodules/aai/esr-server.git/docs/architecture.rst
+ AAI ESR UI <../../../submodules/aai/esr-gui.git/docs/platform/architecture.rst>
+ AAI ESR Server <../../../submodules/aai/esr-server.git/docs/platform/architecture.rst>
../../../submodules/aai/resources.git/docs/architecture.rst
../../../submodules/aai/search-data-service.git/docs/architecture.rst
../../../submodules/aai/sparky-be.git/docs/architecture.rst
@@ -101,14 +105,14 @@ SDKs
../../../submodules/ccsdk/platform/blueprints.git/docs/architecture.rst
../../../submodules/ccsdk/platform/nbapi.git/docs/architecture.rst
../../../submodules/ccsdk/platform/plugins.git/docs/architecture.rst
- ../../../submodules/ccsdk/sli/adaptors.git/docs/architecture.rst
- ../../../submodules/ccsdk/sli/core.git/docs/architecture.rst
- ../../../submodules/ccsdk/sli/northbound.git/docs/architecture.rst
- ../../../submodules/ccsdk/sli/plugins.git/docs/architecture.rst
+ CCSDK SLI Adaptors <../../../submodules/ccsdk/sli/adaptors.git/docs/architecture.rst>
+ CCSDK SLI Service Logic Intrepreter <../../../submodules/ccsdk/sli/core.git/docs/architecture.rst>
+ CCSDK SLI Northbound Interface <../../../submodules/ccsdk/sli/northbound.git/docs/architecture.rst>
+ CCSDK SLI Plugins <../../../submodules/ccsdk/sli/plugins.git/docs/architecture.rst>
../../../submodules/ccsdk/storage/esaas.git/docs/architecture.rst
../../../submodules/ccsdk/storage/pgaas.git/docs/architecture.rst
../../../submodules/ccsdk/utils.git/docs/architecture.rst
- ../../../submodules/portal.git/docs/architecture.rst
+ ../../../submodules/portal.git/docs/portal-sdk/architecture.rst
../../../submodules/vnfsdk/model.git/docs/architecture.rst
Other
diff --git a/docs/guides/onap-developer/developing/index.rst b/docs/guides/onap-developer/developing/index.rst
index 1006b2b69..a45b3dc06 100644
--- a/docs/guides/onap-developer/developing/index.rst
+++ b/docs/guides/onap-developer/developing/index.rst
@@ -1,11 +1,14 @@
.. 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.
+
+.. _doc_onap-developer_guide_projects:
Developing ONAP
===============
+Additional developer level detail is provided for each project and component below.
-Platform Component References
------------------------------
-
-Test & Validation Requirements
-------------------------------
+.. toctree::
+ :maxdepth: 2
+ ../../../../../release/repolist.rst
diff --git a/docs/release/index.rst b/docs/release/index.rst
index 5a7671a38..aad7d757e 100644
--- a/docs/release/index.rst
+++ b/docs/release/index.rst
@@ -26,8 +26,7 @@ the Amsterdam Release and provide detailed release notes at the links below.
.. include:: releaserepos.rst
-Projects Providing Documentation
---------------------------------
+==========================
-.. include:: repolist.rst
-
+The complete list of projects providing documentation for current and future releases
+has been moved to the onap-developer guide :ref:`doc_onap-developer_guide_projects`.
diff --git a/docs/release/releaserepos.rst b/docs/release/releaserepos.rst
index de1c65c53..a4f0436ae 100644
--- a/docs/release/releaserepos.rst
+++ b/docs/release/releaserepos.rst
@@ -1,4 +1,7 @@
.. 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.
+
Project Specific Release Notes
------------------------------
@@ -34,7 +37,7 @@ Project Specific Release Notes
Release Notes for ccsdk/utils<../submodules/ccsdk/utils.git/docs/release-notes.rst>
Release Notes for clamp<../submodules/clamp.git/docs/release-notes.rst>
Release Notes for cli<../submodules/cli.git/docs/release-notes.rst>
- Release Notes for dcaegen2<../submodules/dcaegen2.git/docs/release-notes.rst>
+ Release Notes for dcaegen2<../submodules/dcaegen2.git/docs/sections/release-notes.rst>
Release Notes for dmaap/messagerouter/messageservice<../submodules/dmaap/messagerouter/messageservice.git/docs/release-notes.rst>
Release Notes for holmes/engine-management<../submodules/holmes/engine-management.git/docs/release-notes.rst>
Release Notes for holmes/rule-management<../submodules/holmes/rule-management.git/docs/release-notes.rst>
diff --git a/docs/release/repolist.rst b/docs/release/repolist.rst
index 158e12444..e285824fd 100644
--- a/docs/release/repolist.rst
+++ b/docs/release/repolist.rst
@@ -1,68 +1,67 @@
.. 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.
-Documentation organized by the project delivering them.
-.. note::
- The list below is the initial reference to project information created
- when integrating as a submodule. For the release notes document,
- these references will be changed to release notes and artifacts
- Other project information will referenced in developer and user guides.
+Project/Components
+------------------
+
.. toctree::
:maxdepth: 1
:titlesonly:
aaf/authz <../submodules/aaf/authz.git/docs/index>
- aai/aai-common <../submodules/aai/aai-common.git/docs/index>
+ AAI - Active & Available Inventory <../submodules/aai/aai-common.git/docs/index>
aai/data-router <../submodules/aai/data-router.git/docs/index>
- aai/esr-gui <../submodules/aai/esr-gui.git/docs/index>
- aai/esr-server <../submodules/aai/esr-server.git/docs/index>
+ AAI External System Registration UI <../submodules/aai/esr-gui.git/docs/index>
+ AAI External System Registration Server <../submodules/aai/esr-server.git/docs/index>
aai/resources <../submodules/aai/resources.git/docs/index>
aai/search-data-service <../submodules/aai/search-data-service.git/docs/index>
- aai/sparky-be <../submodules/aai/sparky-be.git/docs/index>
- aai/sparky-fe <../submodules/aai/sparky-fe.git/docs/index>
+ AAI Sparky Inventory UI <../submodules/aai/sparky-be.git/docs/index>
+ AAI Sparky Inventory Service <../submodules/aai/sparky-fe.git/docs/index>
aai/traversal <../submodules/aai/traversal.git/docs/index>
- appc/deployment <../submodules/appc/deployment.git/docs/index>
- appc <../submodules/appc.git/docs/index>
- ccsdk/dashboard <../submodules/ccsdk/dashboard.git/docs/index>
+ APPC - Application Controller Deployment <../submodules/appc/deployment.git/docs/index>
+ APPC API Guides <../submodules/appc.git/docs/index>
+ CCSDK Dashboard <../submodules/ccsdk/dashboard.git/docs/index>
ccsdk/distribution <../submodules/ccsdk/distribution.git/docs/index>
ccsdk/parent <../submodules/ccsdk/parent.git/docs/index>
ccsdk/platform/blueprints <../submodules/ccsdk/platform/blueprints.git/docs/index>
ccsdk/platform/nbapi <../submodules/ccsdk/platform/nbapi.git/docs/index>
- ccsdk/platform/plugins <../submodules/ccsdk/platform/plugins.git/docs/index>
- ccsdk/sli/adaptors <../submodules/ccsdk/sli/adaptors.git/docs/index>
- ccsdk/sli/core <../submodules/ccsdk/sli/core.git/docs/index>
- ccsdk/sli/northbound <../submodules/ccsdk/sli/northbound.git/docs/index>
- ccsdk/sli/plugins <../submodules/ccsdk/sli/plugins.git/docs/index>
+ CCSDK Orchestrator Plugins <../submodules/ccsdk/platform/plugins.git/docs/index>
+ ../submodules/ccsdk/sli/adaptors.git/docs/index
+ ../submodules/ccsdk/sli/core.git/docs/index
+ ../submodules/ccsdk/sli/northbound.git/docs/index
+ ../submodules/ccsdk/sli/plugins.git/docs/index
ccsdk/storage/esaas <../submodules/ccsdk/storage/esaas.git/docs/index>
ccsdk/storage/pgaas <../submodules/ccsdk/storage/pgaas.git/docs/index>
ccsdk/utils <../submodules/ccsdk/utils.git/docs/index>
- clamp <../submodules/clamp.git/docs/index>
- cli <../submodules/cli.git/docs/index>
- dcaegen2 <../submodules/dcaegen2.git/docs/index>
- dmaap/messagerouter/messageservice <../submodules/dmaap/messagerouter/messageservice.git/docs/index>
- holmes/engine-management <../submodules/holmes/engine-management.git/docs/index>
- holmes/rule-management <../submodules/holmes/rule-management.git/docs/index>
+ ../submodules/clamp.git/docs/index
+ ../submodules/cli.git/docs/index
+ ../submodules/dcaegen2.git/docs/index
+ ../submodules/dmaap/messagerouter/messageservice.git/docs/index
+ HOLMES - Alarm Correlation and Analysis <../submodules/holmes/engine-management.git/docs/index>
+ HOLMES - Architecuture and APIs <../submodules/holmes/rule-management.git/docs/index>
integration <../submodules/integration.git/docs/index>
logging-analytics <../submodules/logging-analytics.git/docs/index>
- modeling/modelspec <../submodules/modeling/modelspec.git/docs/index>
- msb/apigateway <../submodules/msb/apigateway.git/docs/index>
+ ../submodules/modeling/modelspec.git/docs/index
+ MSB - Microservice Bus <../submodules/msb/apigateway.git/docs/index>
msb/discovery <../submodules/msb/discovery.git/docs/index>
msb/java-sdk <../submodules/msb/java-sdk.git/docs/index>
msb/swagger-sdk <../submodules/msb/swagger-sdk.git/docs/index>
- multicloud/framework <../submodules/multicloud/framework.git/docs/index>
- oom <../submodules/oom.git/docs/index>
- optf/has <../submodules/optf/has.git/docs/index>
- policy/engine <../submodules/policy/engine.git/docs/index>
- portal <../submodules/portal.git/docs/index>
+ MultiCloud Framework <../submodules/multicloud/framework.git/docs/index>
+ ONAP Operations Manager <../submodules/oom.git/docs/index>
+ ../submodules/optf/has.git/docs/index
+ ../submodules/policy/engine.git/docs/index
+ ../submodules/portal.git/docs/index
sdc/jtosca <../submodules/sdc/jtosca.git/docs/index>
sdc/sdc-distribution-client <../submodules/sdc/sdc-distribution-client.git/docs/index>
sdc/sdc-docker-base <../submodules/sdc/sdc-docker-base.git/docs/index>
sdc/sdc-titan-cassandra <../submodules/sdc/sdc-titan-cassandra.git/docs/index>
sdc/sdc-tosca <../submodules/sdc/sdc-tosca.git/docs/index>
sdc/sdc-workflow-designer <../submodules/sdc/sdc-workflow-designer.git/docs/index>
- sdc <../submodules/sdc.git/docs/index>
+ Service Design and Creation <../submodules/sdc.git/docs/index>
sdnc/adaptors <../submodules/sdnc/adaptors.git/docs/index>
sdnc/architecture <../submodules/sdnc/architecture.git/docs/index>
sdnc/core <../submodules/sdnc/core.git/docs/index>
@@ -72,12 +71,11 @@ Documentation organized by the project delivering them.
sdnc/parent <../submodules/sdnc/parent.git/docs/index>
sdnc/plugins <../submodules/sdnc/plugins.git/docs/index>
so/libs <../submodules/so/libs.git/docs/index>
- so <../submodules/so.git/docs/index>
- usecase-ui <../submodules/usecase-ui.git/docs/index>
- vfc/nfvo/lcm <../submodules/vfc/lcm.git/docs/index>
- vfc/nfvo/lcm <../submodules/vfc/nfvo/lcm.git/docs/index>
+ Service Orchestrator <../submodules/so.git/docs/index>
+ Use Case User Interface <../submodules/usecase-ui.git/docs/index>
+ VFC - Virtual Function Controller <../submodules/vfc/nfvo/lcm.git/docs/index>
vid/asdcclient <../submodules/vid/asdcclient.git/docs/index>
- vid <../submodules/vid.git/docs/index>
- vnfrqts/guidelines <../submodules/vnfrqts/guidelines.git/docs/index>
- vnfrqts/requirements <../submodules/vnfrqts/requirements.git/docs/index>
- vnfsdk/model <../submodules/vnfsdk/model.git/docs/index>
+ VID - Virtual Infrastructure Deployment <../submodules/vid.git/docs/index>
+ VNF Guidelines <../submodules/vnfrqts/guidelines.git/docs/index>
+ VNF Requirements <../submodules/vnfrqts/requirements.git/docs/index>
+ VNF Software Development Kit <../submodules/vnfsdk/model.git/docs/index>
diff --git a/docs/templates/collections/sdk.rst b/docs/templates/collections/sdk.rst
index 7fb01eb6b..83fbbe2ee 100644
--- a/docs/templates/collections/sdk.rst
+++ b/docs/templates/collections/sdk.rst
@@ -11,7 +11,7 @@ SDK
../sections/architecture.rst
../sections/offeredapis.rst
- ../sections/deliveries
+ ../sections/delivery.rst
../sections/logging.rst
../sections/build.rst
../sections/release-notes.rst