From 4a858d878b4aaa746a27d1d7568922f853dc0d2d Mon Sep 17 00:00:00 2001 From: Rich Bennett Date: Wed, 15 Nov 2017 08:19:14 -0500 Subject: [PATCH] Rm docs in repo consolidated w/ sdnc/oam Change-Id: I3e6d9b04c3ce814597d1d3992f947b87d1757f61 Issue-ID: DOC-124 Signed-off-by: Rich Bennett --- docs/apis/genericresource.rst | 4 ---- docs/apis/vnfapi.rst | 4 ---- docs/architecture.rst | 11 ----------- docs/build.rst | 18 ----------------- docs/index.rst | 13 ------------- docs/logging.rst | 14 -------------- docs/offeredapis.rst | 10 ---------- docs/release-notes.rst | 45 ------------------------------------------- 8 files changed, 119 deletions(-) delete mode 100644 docs/apis/genericresource.rst delete mode 100644 docs/apis/vnfapi.rst delete mode 100644 docs/architecture.rst delete mode 100644 docs/build.rst delete mode 100644 docs/index.rst delete mode 100644 docs/logging.rst delete mode 100644 docs/offeredapis.rst delete mode 100644 docs/release-notes.rst diff --git a/docs/apis/genericresource.rst b/docs/apis/genericresource.rst deleted file mode 100644 index 11a165f1..00000000 --- a/docs/apis/genericresource.rst +++ /dev/null @@ -1,4 +0,0 @@ -GENERIC-RESOURCE-API(2016-11-11) -================================ - -.. swaggerv2doc:: https://gerrit.onap.org/r/gitweb?p=sdnc/northbound.git;a=blob_plain;f=generic-resource-api/model/src/main/resources/generic-resource-api.20161111.json diff --git a/docs/apis/vnfapi.rst b/docs/apis/vnfapi.rst deleted file mode 100644 index 2595a09c..00000000 --- a/docs/apis/vnfapi.rst +++ /dev/null @@ -1,4 +0,0 @@ -VNF-API(2015-07-20) -=================== - -.. swaggerv2doc:: https://gerrit.onap.org/r/gitweb?p=sdnc/northbound.git;a=blob_plain;f=vnfapi/model/src/main/resources/vnf-api.20150720.json \ No newline at end of file diff --git a/docs/architecture.rst b/docs/architecture.rst deleted file mode 100644 index 34022e5b..00000000 --- a/docs/architecture.rst +++ /dev/null @@ -1,11 +0,0 @@ -.. This work is licensed under a Creative Commons Attribution 4.0 International License. -.. http://creativecommons.org/licenses/by/4.0 - -Architecture -============ - - -Capabilities ------------- -This repository contains the source code and Yang models for the SDNC northbound REST interfaces -(GENERIC-RESOURCE-API and VNF-API) diff --git a/docs/build.rst b/docs/build.rst deleted file mode 100644 index 0a4c308e..00000000 --- a/docs/build.rst +++ /dev/null @@ -1,18 +0,0 @@ -.. This work is licensed under a Creative Commons Attribution 4.0 International License. -.. http://creativecommons.org/licenses/by/4.0 - -Build -===== - - -Environment ------------ -Requires maven release 3.3 or greater - -Steps ------ -To compile this code: - -1. Make sure your local Maven settings file ($HOME/.m2/settings.xml) contains references to the ONAP repositories and OpenDaylight repositories. - -2. To compile, run "mvn clean install". \ No newline at end of file diff --git a/docs/index.rst b/docs/index.rst deleted file mode 100644 index 2055f178..00000000 --- a/docs/index.rst +++ /dev/null @@ -1,13 +0,0 @@ -.. This work is licensed under a Creative Commons Attribution 4.0 International License. - -CCSDK Service Logic Interpreter -------------------------------- -.. toctree:: - :maxdepth: 1 - - architecture.rst - offeredapis.rst - logging.rst - build.rst - release-notes.rst - diff --git a/docs/logging.rst b/docs/logging.rst deleted file mode 100644 index 187eb03b..00000000 --- a/docs/logging.rst +++ /dev/null @@ -1,14 +0,0 @@ -.. This work is licensed under a Creative Commons Attribution 4.0 International License. -.. http://creativecommons.org/licenses/by/4.0 - -Logging -======= -CCSDK uses slf4j to log messages to the standard OpenDaylight karaf.log -log file. - -Where to Access Information ---------------------------- -Logs are found within the SDNC docker container, in the directory -/opt/opendaylight/current/data/logs. - - diff --git a/docs/offeredapis.rst b/docs/offeredapis.rst deleted file mode 100644 index c79cb977..00000000 --- a/docs/offeredapis.rst +++ /dev/null @@ -1,10 +0,0 @@ -.. This work is licensed under a Creative Commons Attribution 4.0 International License. - - -Offered APIs -============ -.. toctree:: - :maxdepth: 1 - - apis/genericresource.rst - apis/vnfapi.rst diff --git a/docs/release-notes.rst b/docs/release-notes.rst deleted file mode 100644 index 21ff338c..00000000 --- a/docs/release-notes.rst +++ /dev/null @@ -1,45 +0,0 @@ -.. This work is licensed under a Creative Commons Attribution 4.0 International License. - -Release Notes -============= - -.. note:: - * This Release Notes must be updated each time the team decides to Release new artifacts. - * The scope of this Release Notes is for this particular component. In other words, each ONAP component has its Release Notes. - * This Release Notes is cumulative, the most recently Released artifact is made visible in the top of this Release Notes. - * Except the date and the version number, all the other sections are optional but there must be at least one section describing the purpose of this new release. - * This note must be removed after content has been added. - - -Version: x.y.z --------------- - - -:Release Date: yyyy-mm-dd - - - -**New Features** - -One or two sentences explaining the purpose of this Release. - -**Bug Fixes** - - `CIMAN-65 `_ and a sentence explaining what this defect is addressing. -**Known Issues** - - `CIMAN-65 `_ and two, three sentences. - One sentences explaining what is the issue. - - Another sentence explaining the impact of the issue. - - And an optional sentence providing a workaround. - -**Security Issues** - You may want to include a reference to CVE (Common Vulnerabilities and Exposures) `CVE `_ - - -**Upgrade Notes** - -**Deprecation Notes** - -**Other** - -- 2.16.6