From 6dd9b673e71a47ce43acfa8303e7b1156613021e Mon Sep 17 00:00:00 2001 From: Rich Bennett Date: Fri, 3 Nov 2017 15:27:24 -0400 Subject: Multiple editorial improvements Release notes expanded outline and content Release notes for doc projet Remove aai/sparky-fe submodule combined with spark-be Remove Module & Renamed Index and Search Change-Id: I4eeabee3604f1ffc4bb02dd4125a1770a77812d1 Issue-ID: DOC-147 Signed-off-by: Rich Bennett --- docs/guides/onap-developer/apiref/index.rst | 9 +++ docs/guides/onap-developer/architecture/index.rst | 11 +-- docs/guides/onap-developer/index.rst | 1 + docs/guides/onap-developer/tutorials/index.rst | 6 +- .../onap-developer/tutorials/platform/index.rst | 8 ++ docs/guides/onap-user/vnfprovider.rst | 4 +- docs/index.rst | 5 +- docs/release-notes.rst | 36 +++++++++ docs/release/index.rst | 88 ++++++++++++++++------ docs/release/release-manifest.rst | 27 +++++++ docs/release/releaserepos.rst | 4 +- docs/release/repolist.rst | 12 +-- docs/submodules/aai/sparky-fe.git | 1 - 13 files changed, 172 insertions(+), 40 deletions(-) create mode 100644 docs/guides/onap-developer/apiref/index.rst create mode 100644 docs/guides/onap-developer/tutorials/platform/index.rst create mode 100644 docs/release-notes.rst create mode 100644 docs/release/release-manifest.rst delete mode 160000 docs/submodules/aai/sparky-fe.git (limited to 'docs') diff --git a/docs/guides/onap-developer/apiref/index.rst b/docs/guides/onap-developer/apiref/index.rst new file mode 100644 index 000000000..bad279375 --- /dev/null +++ b/docs/guides/onap-developer/apiref/index.rst @@ -0,0 +1,9 @@ +.. 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-apiref: + +API Reference +============= + diff --git a/docs/guides/onap-developer/architecture/index.rst b/docs/guides/onap-developer/architecture/index.rst index 8e9fadfac..1bb57cfaf 100644 --- a/docs/guides/onap-developer/architecture/index.rst +++ b/docs/guides/onap-developer/architecture/index.rst @@ -1,7 +1,9 @@ -.. 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. +.. 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-architecture: Architecture ============ @@ -79,7 +81,6 @@ Common Services 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/sparky-be.git/docs/architecture.rst - ../../../submodules/aai/sparky-fe.git/docs/architecture.rst ../../../submodules/dmaap/messagerouter/messageservice.git/docs/architecture.rst MSB - Microservices Bus <../../../submodules/msb/apigateway.git/docs/platform/architecture.rst> ../../../submodules/msb/discovery.git/docs/architecture.rst @@ -108,7 +109,7 @@ SDKs ../../../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/portal-sdk/architecture.rst + Portal <../../../submodules/portal.git/docs/tutorials/portal-sdk/architecture.rst> ../../../submodules/vnfsdk/model.git/docs/architecture.rst Other diff --git a/docs/guides/onap-developer/index.rst b/docs/guides/onap-developer/index.rst index 4787f52ec..13c7372cb 100644 --- a/docs/guides/onap-developer/index.rst +++ b/docs/guides/onap-developer/index.rst @@ -14,4 +14,5 @@ Describe the kinds of references, tutorials, specifications provided for develop settingup/index developing/index how-to-use-docs/index + apiref/index diff --git a/docs/guides/onap-developer/tutorials/index.rst b/docs/guides/onap-developer/tutorials/index.rst index 5864e4d8c..4519eaebc 100644 --- a/docs/guides/onap-developer/tutorials/index.rst +++ b/docs/guides/onap-developer/tutorials/index.rst @@ -3,5 +3,9 @@ Tutorials ========= +.. toctree:: + :maxdepth: 1 + :titlesonly: - + + platform/index.rst diff --git a/docs/guides/onap-developer/tutorials/platform/index.rst b/docs/guides/onap-developer/tutorials/platform/index.rst new file mode 100644 index 000000000..75cbadfa0 --- /dev/null +++ b/docs/guides/onap-developer/tutorials/platform/index.rst @@ -0,0 +1,8 @@ +.. 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. + +.. _demo-installing-running-onap: + +Installing & Running ONAP +========================= diff --git a/docs/guides/onap-user/vnfprovider.rst b/docs/guides/onap-user/vnfprovider.rst index d64367770..6d6fd2f05 100644 --- a/docs/guides/onap-user/vnfprovider.rst +++ b/docs/guides/onap-user/vnfprovider.rst @@ -1,8 +1,8 @@ .. This work is licensed under a Creative Commons Attribution 4.0 International License. -VNF Provider Guide -================== +VNF Provider Guidelines and Requirements +======================================== .. toctree:: :maxdepth: 2 diff --git a/docs/index.rst b/docs/index.rst index e1e2ab28f..32d9b93f6 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -14,9 +14,8 @@ ONAP Documentation -Indices and tables -================== +Index and Search +================ * :ref:`genindex` -* :ref:`modindex` * :ref:`search` diff --git a/docs/release-notes.rst b/docs/release-notes.rst new file mode 100644 index 000000000..716baa9ea --- /dev/null +++ b/docs/release-notes.rst @@ -0,0 +1,36 @@ + +.. 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-release-notes: + +Release Notes +============= + + +Version: x.y.z +-------------- + + +:Release Date: yyyy-mm-dd + + + +**New Features** + +Release controlled documentation moved to / now managed in gerrit and published +on readthedocs. + +**Bug Fixes** + + +**Other** + +The developer wiki still contains pages that are release dependent, should be +under change control in gerrit, and are being referenced from some gerrit change controlled documentation. The pages and links that remain to be migrated +are listed in and by TBD tag or other indicator on the wiki. + +=========== + +End of Release Notes diff --git a/docs/release/index.rst b/docs/release/index.rst index aad7d757e..c7dd5bb0c 100644 --- a/docs/release/index.rst +++ b/docs/release/index.rst @@ -1,32 +1,78 @@ -.. 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 Releases ======== -ONAP is developed and released around 6 month cycles. After an initial major release, additional -stable point releases may be created. +ONAP is developed and released around 6 month cycles. After an initial +major release, additional stable point releases may be created. The first +release is Amsterdam and subsequent major release will be named using city +names. + + +Amsterdam Release +----------------- + +Summary ++++++++ + +Functionality ++++++++++++++ + + +Project Specific Release Notes +++++++++++++++++++++++++++++++ +Major and stable point releases are specified by a list of project artifact +versions in a :ref:`manifest here`. +Each project provides detailed :ref:`release notes here ` +and prepends to these if/when any updated versions, the project team believes +are compatible with major release, are made available. + + +Supported Platforms ++++++++++++++++++++ + + +Documentation ++++++++++++++ +Release controlled documentation is available :ref:`here `. +For Amsterdam this includes: + +* A high level architecture view of how components delivered by all projects + relate to each other are :ref:`available here `. + +* A collection of documentation provided by each project and for some projects + several components / repositories within the project + are :ref:`available here `. + +* Application Programming Interface Reference :ref:`available here ` + +* The `developer wiki `_ remains a good source of + information on meeting plans and notes from committees, project teams, + community events and general, release independent information about + ONAP. Release dependent information is being migrated from the wiki to + gerrit source control. See the doc + project :ref:`release notes ` for current status. + + +Known Issues and Limitations +++++++++++++++++++++++++++++ +TBP overall / general statement +See :ref:`release notes ` for each project. + +License ++++++++ -Named Releases --------------- -.. csv-table:: - :align: left - :header-rows: 0 - :header: "Release", "Status", "Initial Release Date", "Next Phase", "EOL Date" - :widths: 15, 10, 10, 15, 10 +How to Report a Bug ++++++++++++++++++++ - "Amsterdam", "Under Development", "TBD", "", "" - "OpenECOMP R1.0.0 Seed Code", "EOL", "2017-04-XX", "", "" -Amsterdam Projects ------------------- -The following projects repositories have been approved by the TSC to be part of -the Amsterdam Release and provide detailed release notes at the links below. +Download and Use +++++++++++++++++ -.. include:: releaserepos.rst +* Source Code in Gerrit https://gerrit.onap.org +* Artifacts in Nexus / Docker Hub -========================== +* Platform :ref:`Demo `. -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/release-manifest.rst b/docs/release/release-manifest.rst new file mode 100644 index 000000000..a74fc721d --- /dev/null +++ b/docs/release/release-manifest.rst @@ -0,0 +1,27 @@ +.. 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-release-manifest: + +Release Manifest +---------------- + + +Nexus Artifacts nexus.onap.org +++++++++++++++++++++++++++++++ + + +.. csv-table:: + :align: left + :header-rows: 1 + :file: ../submodules/integration.git/version-manifest/src/main/resources/java-manifest.csv + + +Docker Images nexus3.onap.org +++++++++++++++++++++++++++++++ + +.. csv-table:: + :align: left + :header-rows: 1 + :file: ../submodules/integration.git/version-manifest/src/main/resources/docker-manifest.csv diff --git a/docs/release/releaserepos.rst b/docs/release/releaserepos.rst index 9669f960e..b717a890d 100644 --- a/docs/release/releaserepos.rst +++ b/docs/release/releaserepos.rst @@ -3,6 +3,8 @@ .. Copyright 2017 AT&T Intellectual Property. All rights reserved. +.. _doc-releaserepos: + Project Specific Release Notes ------------------------------ @@ -15,7 +17,6 @@ Project Specific Release Notes Release Notes for aai/esr-gui<../submodules/aai/esr-gui.git/docs/release-notes.rst> Release Notes for aai/esr-server<../submodules/aai/esr-server.git/docs/release-notes.rst> Release Notes for aai/sparky-be<../submodules/aai/sparky-be.git/docs/release-notes.rst> - Release Notes for aai/sparky-fe<../submodules/aai/sparky-fe.git/docs/release-notes.rst> Release Notes for appc/deployment<../submodules/appc/deployment.git/docs/release-notes.rst> Release Notes for appc<../submodules/appc.git/docs/release-notes.rst> Release Notes for ccsdk/dashboard<../submodules/ccsdk/dashboard.git/docs/release-notes.rst> @@ -34,6 +35,7 @@ Project Specific Release Notes 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/sections/release-notes.rst> + Release Notes for doc <../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 6a37e2f0f..a4fdebc59 100644 --- a/docs/release/repolist.rst +++ b/docs/release/repolist.rst @@ -1,9 +1,9 @@ -.. 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. - +.. 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-repolist: Project/Components ------------------ @@ -73,6 +73,6 @@ Project/Components VFC - Virtual Function Controller <../submodules/vfc/nfvo/lcm.git/docs/index> VID - Virtual Infrastructure Deployment <../submodules/vid.git/docs/index> vid/asdcclient <../submodules/vid/asdcclient.git/docs/index> - VNF Guidelines <../submodules/vnfrqts/guidelines.git/docs/index> - VNF Requirements <../submodules/vnfrqts/requirements.git/docs/index> + ../submodules/vnfrqts/guidelines.git/docs/index + ../submodules/vnfrqts/requirements.git/docs/index VNF Software Development Kit <../submodules/vnfsdk/model.git/docs/index> diff --git a/docs/submodules/aai/sparky-fe.git b/docs/submodules/aai/sparky-fe.git deleted file mode 160000 index b17197cd7..000000000 --- a/docs/submodules/aai/sparky-fe.git +++ /dev/null @@ -1 +0,0 @@ -Subproject commit b17197cd75aaddbb1b37c49846842fbee0f7c2aa -- cgit 1.2.3-korg