From 056e82aa242f7df59c72dc967f38d479c51f7509 Mon Sep 17 00:00:00 2001 From: "Timoney, Dan (dt5972)" Date: Wed, 13 Jun 2018 11:11:29 -0400 Subject: Restructure CCSDK documentation Remove empty repo-specific documents in favor of meaningful project-level documentation. Change-Id: I18f2db7f68895df2d71450eee7e56723d74f7f5a Issue-ID: CCSDK-300 Signed-off-by: Timoney, Dan (dt5972) --- docs/sli/adaptors/architecture.rst | 27 ---------------------- docs/sli/adaptors/build.rst | 18 --------------- docs/sli/adaptors/index.rst | 12 ---------- docs/sli/adaptors/logging.rst | 14 ----------- docs/sli/adaptors/offeredapis.rst | 6 ----- docs/sli/adaptors/release-notes.rst | 46 ------------------------------------- 6 files changed, 123 deletions(-) delete mode 100644 docs/sli/adaptors/architecture.rst delete mode 100644 docs/sli/adaptors/build.rst delete mode 100644 docs/sli/adaptors/index.rst delete mode 100644 docs/sli/adaptors/logging.rst delete mode 100644 docs/sli/adaptors/offeredapis.rst delete mode 100644 docs/sli/adaptors/release-notes.rst (limited to 'docs/sli/adaptors') diff --git a/docs/sli/adaptors/architecture.rst b/docs/sli/adaptors/architecture.rst deleted file mode 100644 index 8daa0d3b..00000000 --- a/docs/sli/adaptors/architecture.rst +++ /dev/null @@ -1,27 +0,0 @@ -.. This work is licensed under a Creative Commons Attribution 4.0 International License. -.. http://creativecommons.org/licenses/by/4.0 - -Architecture -============ - -.. note:: - * This section is used to describe a software component from a high level - view of capability, common usage scenarios, and interactions with other - components required in the usage scenarios. - - * The architecture section is typically: provided in a platform-component - and sdk collections; and referenced from developer and user guides. - - * This note must be removed after content has been added. - - -Capabilities ------------- - - -Usage Scenarios ---------------- - - -Interactions ------------- diff --git a/docs/sli/adaptors/build.rst b/docs/sli/adaptors/build.rst deleted file mode 100644 index 0a4c308e..00000000 --- a/docs/sli/adaptors/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/sli/adaptors/index.rst b/docs/sli/adaptors/index.rst deleted file mode 100644 index 3156c8ab..00000000 --- a/docs/sli/adaptors/index.rst +++ /dev/null @@ -1,12 +0,0 @@ -.. This work is licensed under a Creative Commons Attribution 4.0 International License. - -CCSDK Service Logic Interpretor Adaptors ----------------------------------------- -.. toctree:: - :maxdepth: 1 - - architecture.rst - offeredapis.rst - logging.rst - build.rst - release-notes.rst diff --git a/docs/sli/adaptors/logging.rst b/docs/sli/adaptors/logging.rst deleted file mode 100644 index 187eb03b..00000000 --- a/docs/sli/adaptors/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/sli/adaptors/offeredapis.rst b/docs/sli/adaptors/offeredapis.rst deleted file mode 100644 index e20c786c..00000000 --- a/docs/sli/adaptors/offeredapis.rst +++ /dev/null @@ -1,6 +0,0 @@ -.. This work is licensed under a Creative Commons Attribution 4.0 International License. -.. http://creativecommons.org/licenses/by/4.0 - -Offered APIs -============ - diff --git a/docs/sli/adaptors/release-notes.rst b/docs/sli/adaptors/release-notes.rst deleted file mode 100644 index b4516570..00000000 --- a/docs/sli/adaptors/release-notes.rst +++ /dev/null @@ -1,46 +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** - -=========== \ No newline at end of file -- cgit 1.2.3-korg