From 8c401479a78c4cc7a54962db1de08ab03ec4947a Mon Sep 17 00:00:00 2001 From: Rich Bennett Date: Sat, 18 Nov 2017 10:14:21 -0500 Subject: [PATCH] Add Tutorial Links & Getting Started Add tutorial DW links to onap-developer/tutorials Changed Release title to "Getting Started With Amsterdam" Removed references to repos where Change Platform Adminstrator to User Portal information is aggregated at higher level Update DOC release notes Change-Id: I1b5f04ec0e2e4aae7e75013790f823c7b272b6ba Issue-ID: DOC-190 Signed-off-by: Rich Bennett --- docs/guides/onap-developer/tutorials/index.rst | 17 ++++++++++++++--- docs/guides/onap-user/platformadmin.rst | 6 +++--- docs/release-notes.rst | 9 +++------ docs/release/index.rst | 6 +++--- docs/release/releaserepos.rst | 20 +------------------- docs/release/repolist.rst | 12 ------------ 6 files changed, 24 insertions(+), 46 deletions(-) diff --git a/docs/guides/onap-developer/tutorials/index.rst b/docs/guides/onap-developer/tutorials/index.rst index a4bcbaef2..2365efd10 100644 --- a/docs/guides/onap-developer/tutorials/index.rst +++ b/docs/guides/onap-developer/tutorials/index.rst @@ -3,7 +3,18 @@ Tutorials ========= -.. toctree:: - :maxdepth: 1 - :titlesonly: +.. note:: + Until this section is migrated to gerrit/readthedocs, use the links below. + +.. caution:: + The tutorials may refer to earlier versions of software + and have not been certified on the latest Amsterdam Release. + +* `Automatically Creating a Netconf Mount in APPC from SDNC `_ + +* `Clearwater vIMS Onboarding and Instantiation `_ + +* `How to use SLI-API for SDNC Model, Directed Graph and Adapter prototyping `_ + +* `Setting up a Nexus Proxy `_ diff --git a/docs/guides/onap-user/platformadmin.rst b/docs/guides/onap-user/platformadmin.rst index 4ebc72ba7..8c1fb2e6b 100644 --- a/docs/guides/onap-user/platformadmin.rst +++ b/docs/guides/onap-user/platformadmin.rst @@ -2,10 +2,10 @@ .. http://creativecommons.org/licenses/by/4.0 .. Copyright 2017 AT&T Intellectual Property. All rights reserved. -Platform Administrator -====================== +User Portal +=========== .. note:: Until this section is migrated to gerrit/readthedocs, use the link below. -* `ONAP Portal `_ +* `User Portal `_ diff --git a/docs/release-notes.rst b/docs/release-notes.rst index 8c8b5e133..00e9a11db 100644 --- a/docs/release-notes.rst +++ b/docs/release-notes.rst @@ -9,11 +9,11 @@ Release Notes ============= -Version: x.y.z +Version: 1.0.0 -------------- -:Release Date: 2017-11-20 +:Release Date: 2017-11-16 @@ -22,14 +22,11 @@ Version: x.y.z Project release controlled documentation is now managed in gerrit and published on readthedocs. -**Bug Fixes** - - **Other** The developer wiki still contains some pages that are referenced from the readthedocs documentation. The pages and links that remain to be migrated -are listed in Jira Issue DOC-179 and labeled on the wiki with "move-to-rtd". +are listed in Jira Issue DOC-179. =========== diff --git a/docs/release/index.rst b/docs/release/index.rst index 8606de3e9..dea4fed1c 100644 --- a/docs/release/index.rst +++ b/docs/release/index.rst @@ -13,8 +13,8 @@ Amsterdam and subsequent major release will be named using city names. * Release Date: November 16, 2017 -Amsterdam Release ------------------ +Getting Started With Amsterdam +------------------------------ Summary +++++++ @@ -174,7 +174,7 @@ There are 2 ways to report a bug in ONAP. * In case you are familiar within ONAP, you can directly report a bug by creating a Jira issue at `ONAP Jira `_. * If you don't know you are facing a bug or have a question, post your question into the `Ask question `_. -You will need a Linux Foundation ID to login and post your question. Get a Linux Foundation Identity using this `quick procedure `_. + You will need a Linux Foundation ID to login and post your question. Get a Linux Foundation Identity using this `quick procedure `_. You may consider these `recommendations `_ to elaborate the issue you are facing and this `guideline `_ to register into the ONAP Discuss mailing list. diff --git a/docs/release/releaserepos.rst b/docs/release/releaserepos.rst index 2f736f978..41d9124d8 100644 --- a/docs/release/releaserepos.rst +++ b/docs/release/releaserepos.rst @@ -17,9 +17,6 @@ Active and Available Inventory :titlesonly: aai/aai-common<../submodules/aai/aai-common.git/docs/release-notes.rst> - aai/esr-gui<../submodules/aai/esr-gui.git/docs/release-notes.rst> - aai/esr-server<../submodules/aai/esr-server.git/docs/release-notes.rst> - aai/sparky-be<../submodules/aai/sparky-be.git/docs/release-notes.rst> Application Controller ---------------------- @@ -28,7 +25,6 @@ Application Controller :maxdepth: 1 :titlesonly: - appc/deployment<../submodules/appc/deployment.git/docs/release-notes.rst> appc<../submodules/appc.git/docs/release-notes.rst> Common Controller Software Development Kit @@ -39,8 +35,6 @@ Common Controller Software Development Kit :titlesonly: ccsdk/distribution<../submodules/ccsdk/distribution.git/docs/release-notes.rst> - ccsdk/dashboard<../submodules/ccsdk/dashboard.git/docs/release-notes.rst> - ccsdk/platform/blueprints<../submodules/ccsdk/platform/blueprints.git/docs/release-notes.rst> Closed Loop Automation Platform ------------------------------- @@ -94,7 +88,6 @@ Holmes :maxdepth: 1 :titlesonly: - holmes/engine-management<../submodules/holmes/engine-management.git/docs/release-notes.rst> holmes/rule-management<../submodules/holmes/rule-management.git/docs/release-notes.rst> Integration @@ -114,7 +107,7 @@ Logging Enhancements Project :maxdepth: 1 :titlesonly: - logging-analytics<../submodules/logging-analytics.git/docs/release-notes.rst + logging-analytics<../submodules/logging-analytics.git/docs/release-notes.rst> Modeling -------- @@ -134,9 +127,6 @@ Micro Services Bus :titlesonly: msb/apigateway<../submodules/msb/apigateway.git/docs/release-notes.rst> - msb/discovery<../submodules/msb/discovery.git/docs/release-notes.rst> - msb/java-sdk<../submodules/msb/java-sdk.git/docs/release-notes.rst> - msb/swagger-sdk<../submodules/msb/swagger-sdk.git/docs/release-notes.rst> MultiVIM Cloud -------------- @@ -182,11 +172,6 @@ Service Design & Creation :titlesonly: sdc<../submodules/sdc.git/docs/release-notes.rst> - sdc/jtosca<../submodules/sdc/jtosca.git/docs/release-notes.rst> - sdc/sdc-distribution-client<../submodules/sdc/sdc-distribution-client.git/docs/release-notes.rst> - sdc/sdc-docker-base<../submodules/sdc/sdc-docker-base.git/docs/release-notes.rst> - sdc/sdc-titan-cassandra<../submodules/sdc/sdc-titan-cassandra.git/docs/release-notes.rst> - sdc/sdc-tosca<../submodules/sdc/sdc-tosca.git/docs/release-notes.rst> sdc/sdc-workflow-designer<../submodules/sdc/sdc-workflow-designer.git/docs/release-notes.rst> Software Defined Network Controller @@ -224,7 +209,6 @@ Virtual Function Controller :maxdepth: 1 :titlesonly: - vfc/lcm<../submodules/vfc/lcm.git/docs/release-notes.rst> vfc/nfvo/lcm<../submodules/vfc/nfvo/lcm.git/docs/release-notes.rst> Virtual Infrastructure Deployment @@ -234,7 +218,6 @@ Virtual Infrastructure Deployment :maxdepth: 1 :titlesonly: - vid/asdcclient<../submodules/vid/asdcclient.git/docs/release-notes.rst> vid<../submodules/vid.git/docs/release-notes.rst> VNF Requirements @@ -244,7 +227,6 @@ VNF Requirements :maxdepth: 1 :titlesonly: - vnfrqts/guidelines<../submodules/vnfrqts/guidelines.git/docs/release-notes.rst> vnfrqts/requirements<../submodules/vnfrqts/requirements.git/docs/release-notes.rst> VNF Software Development Kit diff --git a/docs/release/repolist.rst b/docs/release/repolist.rst index ae8adcdec..d241e62a0 100644 --- a/docs/release/repolist.rst +++ b/docs/release/repolist.rst @@ -27,10 +27,6 @@ Project/Components ccsdk/platform/blueprints <../submodules/ccsdk/platform/blueprints.git/docs/index> ccsdk/platform/nbapi <../submodules/ccsdk/platform/nbapi.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> @@ -60,14 +56,7 @@ Project/Components 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> - sdnc/adaptors <../submodules/sdnc/adaptors.git/docs/index> - sdnc/architecture <../submodules/sdnc/architecture.git/docs/index> - sdnc/core <../submodules/sdnc/core.git/docs/index> - sdnc/features <../submodules/sdnc/features.git/docs/index> - sdnc/northbound <../submodules/sdnc/northbound.git/docs/index> sdnc/oam <../submodules/sdnc/oam.git/docs/index> - sdnc/parent <../submodules/sdnc/parent.git/docs/index> - sdnc/plugins <../submodules/sdnc/plugins.git/docs/index> Service Orchestrator <../submodules/so.git/docs/index> so/libs <../submodules/so/libs.git/docs/index> Use Case User Interface <../submodules/usecase-ui.git/docs/index> @@ -77,4 +66,3 @@ Project/Components ../submodules/vnfrqts/guidelines.git/docs/index ../submodules/vnfrqts/requirements.git/docs/index VNF Software Development Kit <../submodules/vnfsdk/model.git/docs/index> - VVP Documentation <../submodules/vvp/documentation.git/docs/index> -- 2.16.6