Update Copyright and Licensing markings 93/19593/1
authorRich Bennett <rb2745@att.com>
Wed, 18 Oct 2017 19:27:52 +0000 (15:27 -0400)
committerRich Bennett <rb2745@att.com>
Wed, 18 Oct 2017 19:36:43 +0000 (15:36 -0400)
Add footer reference to CC4 and make Copyright 2017 ONAP
Modify how to create documentation guide to describe appending copyrights on update contributions.
Update Collections Titles
Exclude aaf until source rst files are corrected for the next release.

Change-Id: I3ed26910b2bbb7a15c7c2865e40ff1e5545a00ff
Issue-ID: DOC-102
Signed-off-by: Rich Bennett <rb2745@att.com>
docs/conf.py
docs/guides/onap-developer/architecture/index.rst
docs/guides/onap-developer/how-to-use-docs/documentation-guide.rst
docs/release/index.rst
docs/release/repolist.rst
docs/submodules/so/libs.git
docs/templates/collections/platform-component.rst
docs/templates/collections/sdk.rst

index 4fb3f41..f4fc0e0 100644 (file)
@@ -65,7 +65,9 @@ master_doc = 'index'
 
 # General information about the project.
 project = u''
-copyright = u'2017, ONAP. Licensed under CC BY 4.0'
+copyright = u'2017 ONAP. Licensed under Creative Commons Attribution 4.0 International License'
+
+
 author = u'Open Network Automation Platform'
 
 # The version info for the project you're documenting, acts as replacement for
@@ -93,7 +95,8 @@ language = None
 # List of patterns, relative to source directory, that match files and
 # directories to ignore when looking for source files.
 exclude_patterns = [
-       '_build'
+       '_build',
+       'submodules/aaf'
        ]
 
 # The reST default role (used for this markup: `text`) to use for all
index f7cae38..84c93c0 100644 (file)
@@ -4,9 +4,9 @@ Architecture
 ============
 
 .. note::
-   Some high level groupings are introduced below with references to project/repo index.
-   As more information is provided by each project these references will shift lower to
-   to include only certain sections from each project. For example, the project architecture section.
+   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
 ------
@@ -15,7 +15,7 @@ Models
    :maxdepth: 1
    :titlesonly:
 
-   ../../../submodules/modeling/modelspec.git/docs/index
+   Model Specifications <../../../submodules/modeling/modelspec.git/docs/ONAP release 1 spec/index>
 
 User Interfaces
 ---------------
@@ -24,18 +24,18 @@ User Interfaces
    :maxdepth: 1
    :titlesonly:
 
-   ../../../submodules/clamp.git/docs/index
-   ../../../submodules/cli.git/docs/index
-   ../../../submodules/sdc/jtosca.git/docs/index
-   ../../../submodules/sdc/sdc-distribution-client.git/docs/index
-   ../../../submodules/sdc/sdc-docker-base.git/docs/index
-   ../../../submodules/sdc/sdc-titan-cassandra.git/docs/index
-   ../../../submodules/sdc/sdc-tosca.git/docs/index
-   ../../../submodules/sdc/sdc-workflow-designer.git/docs/index
-   ../../../submodules/sdc.git/docs/index
-   ../../../submodules/usecase-ui.git/docs/index
-   ../../../submodules/vid/asdcclient.git/docs/index
-   ../../../submodules/vid.git/docs/index
+   CLAMP - Closed Loop Automation Platform <../../../submodules/clamp.git/docs/index>
+   CLI - Command Line Interface <../../../submodules/cli.git/docs/architecture.rst>
+   SDC - Service Design and Creation <../../../submodules/sdc.git/docs/architecture.rst>
+   ../../../submodules/sdc/jtosca.git/docs/architecture.rst
+   ../../../submodules/sdc/sdc-distribution-client.git/docs/architecture.rst
+   ../../../submodules/sdc/sdc-docker-base.git/docs/architecture.rst
+   ../../../submodules/sdc/sdc-titan-cassandra.git/docs/architecture.rst
+   ../../../submodules/sdc/sdc-tosca.git/docs/architecture.rst
+   ../../../submodules/sdc/sdc-workflow-designer.git/docs/architecture.rst
+   ../../../submodules/usecase-ui.git/docs/architecture.rst
+   ../../../submodules/vid/asdcclient.git/docs/architecture.rst
+   VID - Virtual Infrastructure Deployment <../../../submodules/vid.git/docs/intro/index>
 
 Platform Components
 -------------------
@@ -44,24 +44,24 @@ Platform Components
    :maxdepth: 1
    :titlesonly:
 
-   ../../../submodules/appc/deployment.git/docs/index
-   ../../../submodules/appc.git/docs/index
-   ../../../submodules/dcaegen2.git/docs/index
-   ../../../submodules/holmes/engine-management.git/docs/index
-   ../../../submodules/holmes/rule-management.git/docs/index
-   ../../../submodules/policy/engine.git/docs/index
-   ../../../submodules/sdnc/adaptors.git/docs/index
-   ../../../submodules/sdnc/architecture.git/docs/index
-   ../../../submodules/sdnc/core.git/docs/index
-   ../../../submodules/sdnc/features.git/docs/index
-   ../../../submodules/sdnc/northbound.git/docs/index
-   ../../../submodules/sdnc/oam.git/docs/index
-   ../../../submodules/sdnc/parent.git/docs/index
-   ../../../submodules/sdnc/plugins.git/docs/index
-   ../../../submodules/so/libs.git/docs/index
-   ../../../submodules/so.git/docs/index
-   ../../../submodules/vfc/lcm.git/docs/index
-   ../../../submodules/vfc/nfvo/lcm.git/docs/index
+   ../../../submodules/appc/deployment.git/docs/architecture.rst
+   ../../../submodules/appc.git/docs/architecture.rst
+   ../../../submodules/dcaegen2.git/docs/architecture.rst
+   ../../../submodules/holmes/engine-management.git/docs/architecture.rst
+   ../../../submodules/holmes/rule-management.git/docs/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
+   ../../../submodules/sdnc/parent.git/docs/architecture.rst
+   ../../../submodules/sdnc/plugins.git/docs/architecture.rst
+   ../../../submodules/so/libs.git/docs/architecture.rst
+   ../../../submodules/so.git/docs/architecture.rst
+   ../../../submodules/vfc/lcm.git/docs/architecture.rst
+   ../../../submodules/vfc/nfvo/lcm.git/docs/architecture.rst
 
 Platform Common Services
 ------------------------
@@ -70,23 +70,23 @@ Platform Common Services
    :maxdepth: 1
    :titlesonly:
 
-   ../../../submodules/aaf/authz.git/docs/index
-   ../../../submodules/aai/aai-common.git/docs/index
-   ../../../submodules/aai/data-router.git/docs/index
-   ../../../submodules/aai/esr-gui.git/docs/index
-   ../../../submodules/aai/esr-server.git/docs/index
-   ../../../submodules/aai/resources.git/docs/index
-   ../../../submodules/aai/search-data-service.git/docs/index
-   ../../../submodules/aai/sparky-be.git/docs/index
-   ../../../submodules/aai/sparky-fe.git/docs/index
-   ../../../submodules/aai/traversal.git/docs/index
-   ../../../submodules/dmaap/messagerouter/messageservice.git/docs/index
-   ../../../submodules/msb/apigateway.git/docs/index
-   ../../../submodules/msb/discovery.git/docs/index
-   ../../../submodules/msb/java-sdk.git/docs/index
-   ../../../submodules/msb/swagger-sdk.git/docs/index
-   ../../../submodules/multicloud/framework.git/docs/index
-   ../../../submodules/oom.git/docs/index
+   ../../../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
+   ../../../submodules/aai/resources.git/docs/architecture.rst
+   ../../../submodules/aai/search-data-service.git/docs/architecture.rst
+   ../../../submodules/aai/sparky-be.git/docs/architecture.rst
+   ../../../submodules/aai/sparky-fe.git/docs/architecture.rst
+   ../../../submodules/aai/traversal.git/docs/architecture.rst
+   ../../../submodules/dmaap/messagerouter/messageservice.git/docs/architecture.rst
+   ../../../submodules/msb/apigateway.git/docs/architecture.rst
+   ../../../submodules/msb/discovery.git/docs/architecture.rst
+   ../../../submodules/msb/java-sdk.git/docs/architecture.rst
+   ../../../submodules/msb/swagger-sdk.git/docs/architecture.rst
+   ../../../submodules/multicloud/framework.git/docs/architecture.rst
+   ../../../submodules/oom.git/docs/architecture.rst
 
 SDKs
 ----
@@ -95,21 +95,21 @@ SDKs
    :maxdepth: 1
    :titlesonly:
 
-   ../../../submodules/ccsdk/dashboard.git/docs/index
-   ../../../submodules/ccsdk/distribution.git/docs/index
-   ../../../submodules/ccsdk/parent.git/docs/index
-   ../../../submodules/ccsdk/platform/blueprints.git/docs/index
-   ../../../submodules/ccsdk/platform/nbapi.git/docs/index
-   ../../../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
-   ../../../submodules/ccsdk/storage/esaas.git/docs/index
-   ../../../submodules/ccsdk/storage/pgaas.git/docs/index
-   ../../../submodules/ccsdk/utils.git/docs/index
-   ../../../submodules/portal.git/docs/index
-   ../../../submodules/vnfsdk/model.git/docs/index
+   ../../../submodules/ccsdk/dashboard.git/docs/architecture.rst
+   ../../../submodules/ccsdk/distribution.git/docs/architecture.rst
+   ../../../submodules/ccsdk/parent.git/docs/architecture.rst
+   ../../../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
+   ../../../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/vnfsdk/model.git/docs/architecture.rst
 
 Other
 -----
@@ -118,7 +118,7 @@ Other
    :maxdepth: 1
    :titlesonly:
 
-   ../../../submodules/integration.git/docs/index
-   ../../../submodules/optf/has.git/docs/index
-   ../../../submodules/vnfrqts/guidelines.git/docs/index
-   ../../../submodules/vnfrqts/requirements.git/docs/index
+   ../../../submodules/integration.git/docs/architecture.rst
+   ../../../submodules/optf/has.git/docs/architecture.rst
+   ../../../submodules/vnfrqts/guidelines.git/docs/architecture.rst
+   ../../../submodules/vnfrqts/requirements.git/docs/architecture.rst
index 9586b4b..8fd9a73 100644 (file)
@@ -147,7 +147,11 @@ files:
 .. code-block:: bash
 
  .. This work is licensed under a Creative Commons Attribution 4.0 International License.
- .. (c) <optionally add copyrights company name>
+ .. http://creativecommons.org/licenses/by/4.0
+ .. Copyright YEAR ONAP or COMPANY or INDIVIDUAL
 
  These lines will not be rendered in the html and pdf files.
 
+When there are subsequent, significant contributions to a source file from a different contributor,
+a new copyright line may be appended after the last existing copyright line.
+
index 9ff201d..5a7671a 100644 (file)
@@ -26,6 +26,8 @@ the Amsterdam Release and provide detailed release notes at the links below.
 .. include:: releaserepos.rst
 
 
+Projects Providing Documentation
+--------------------------------
 
 .. include:: repolist.rst
-
+   
index db831b5..158e124 100644 (file)
@@ -1,8 +1,5 @@
 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
 
-Projects Providing Documentation
---------------------------------
-
 Documentation organized by the project delivering them.
 
 .. note::
@@ -48,6 +45,7 @@ Documentation organized by the project delivering them.
    holmes/engine-management <../submodules/holmes/engine-management.git/docs/index>
    holmes/rule-management <../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>
    msb/discovery <../submodules/msb/discovery.git/docs/index>
@@ -55,7 +53,7 @@ Documentation organized by the project delivering them.
    msb/swagger-sdk <../submodules/msb/swagger-sdk.git/docs/index>
    multicloud/framework <../submodules/multicloud/framework.git/docs/index>
    oom <../submodules/oom.git/docs/index>
-   Optimization Framework: Homing and Allocation <../submodules/optf/has.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>
    sdc/jtosca <../submodules/sdc/jtosca.git/docs/index>
@@ -73,8 +71,9 @@ Documentation organized by the project delivering them.
    sdnc/oam <../submodules/sdnc/oam.git/docs/index>
    sdnc/parent <../submodules/sdnc/parent.git/docs/index>
    sdnc/plugins <../submodules/sdnc/plugins.git/docs/index>
-   so <../submodules/so.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>
    vid/asdcclient <../submodules/vid/asdcclient.git/docs/index>
@@ -82,5 +81,3 @@ Documentation organized by the project delivering them.
    vnfrqts/guidelines <../submodules/vnfrqts/guidelines.git/docs/index>
    vnfrqts/requirements <../submodules/vnfrqts/requirements.git/docs/index>
    vnfsdk/model <../submodules/vnfsdk/model.git/docs/index>
-   usecase-ui <../submodules/usecase-ui.git/docs/index>
-   logging-analytics <../submodules/logging-analytics.git/docs/index>
index 4ee9b22..f475936 160000 (submodule)
@@ -1 +1 @@
-Subproject commit 4ee9b223bc85bfaae4e1911b439d94d4cf424cdf
+Subproject commit f47593695b68356803d45475b85a0e12388426cc
index 7e7849a..98119ac 100644 (file)
@@ -2,8 +2,8 @@
 .. http://creativecommons.org/licenses/by/4.0
 
 
-Platform Component Name
-=======================
+Platform Component
+==================
 
 .. Add or remove sections below as appropriate for the platform component.
 
index f86c33f..7fb01eb 100644 (file)
@@ -1,8 +1,8 @@
 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
 .. http://creativecommons.org/licenses/by/4.0
 
-SDK Name
-========
+SDK
+===
 
 .. Add or remove sections below as appropriate for the SDK